Add total_field_anomaly function
#510
Merged
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
Implement the total field anomaly function. Add to the api index.
VascoSch92
reviewed
Jun 16, 2024
harmonica/_utils.py
Outdated
| >>> print(tfa) | ||
| 50000.0 | ||
| """ | ||
| b_e, b_n, b_u = magnetic_field |
There was a problem hiding this comment.
You could add a small check to control that the parameter declination is indeed in degree.
There was a problem hiding this comment.
Thanks for the suggestion @VascoSch92. It's hard to implement such checks. There's no way we can identify if the user passed an angle in radians or in degrees, besides making assumptions upon its value. I think documenting the argument properly, and keeping the consistency among the package (all inclination and declination angles, along with all longitude and latitude angles in Harmonica as expected in degrees) is enough to make users aware what is expected for these arguments.
total_field_anomaly function
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.
Add new function that computes the total field anomaly from the magnetic field components and the inclination and declination of the IGRF. Include the function in the API index and add tests for it.
Relevant issues/PRs:
Fixes #506