Change default value of depth in equivalent sources #491
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change the default value of the `depth` argument in `EquivalentSources` to `"default"`. If this value is passed, then the depth of the sources is set as 4.5 times the median distance between first neighbouring sources. If a numerical value is passed, this is the one that will be used. Introduce a new `depth_` attribute where the estimated/passed numeric value is stored. If `points` is passed, the `depth_` attribute is set to None. Add a test checking that the depth value is properly set.
Merge the tests functions that checked the accuracy of equivalent sources using different dtypes.
|
I should update some of the tutorials, so they make use of the default depth strategy. We can also include some information on why setting the depth to a numerical value and its consequences. |
Add admonition explaining the default behaviour of the ``depth`` argument.
|
@indiauppal would you like to check this PR out? |
santisoler
commented
May 8, 2024
Use the mean to compute the average distance of neighboring data points.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the default value of the
depthargument inEquivalentSourcesto"default". If this value is passed, then the depth of the sources is set as 4.5 times the median distance between first neighbouring sources. If a numerical value is passed, this is the one that will be used. Introduce a newdepth_attribute where the estimated/passed numeric value is stored. Ifpointsis passed, thedepth_attribute is set to None. Add a test checking that the depth value is properly set.Merge the tests functions that checked the accuracy of equivalent sources using different dtypes.
Relevant issues/PRs:
Fixes #424