Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change default for window size in EquivalentSourcesGB #487

Merged
merged 15 commits into from
May 31, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add window_size_ to Attributes.
  • Loading branch information
indiauppal committed May 31, 2024
commit 34392e617c883b26d8381e6f5df1c66847d88290
7 changes: 6 additions & 1 deletion harmonica/_equivalent_sources/gradient_boosted.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class EquivalentSourcesGB(EquivalentSources):
If None, no block-averaging is applied.
This parameter is ignored if *points* are specified.
Default to None.
window_size : float
window_size : float or "default"
Size of overlapping windows used during the gradient-boosting
algorithm. Smaller windows reduce the memory requirements of the source
coefficients fitting process. Very small windows may impact on the
Expand All @@ -87,6 +87,11 @@ class EquivalentSourcesGB(EquivalentSources):
The boundaries (``[W, E, S, N]``) of the data used to fit the
interpolator. Used as the default region for the
:meth:`~harmonica.EquivalentSources.grid` method.
window_size_ : float or None
Size of the overlapping windows used in gradient-boosting equivalent
point sources. It will be set to None if ``window_size = "default"``
and less than 5000 data points were used to fit the sources; a single
window will be used in such case.

References
----------
Expand Down
Loading