InternationalGeomagneticReferenceFieldVectorReadTxtFile Method (TextReader) |
Reads an IGRF .txt file and creates a magnetic field vector from it.
Note that the rate coefficients for all blocks before the final block will be calculated using interpolation. Also, note that the units of the magnetic field vector are in tesla, the TargetPoint will still need to be set, and the magnetic field vector will default to being resolved in the Axes of the PrincipalFrame of Earth as obtained from the current CentralBodiesFacet unless the DefinedInFrame is set. The ReferenceDistance is set to EarthReferenceDistance, which is the official reference distance for the IGRF models.
Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntaxpublic static InternationalGeomagneticReferenceFieldVector ReadTxtFile( TextReader reader )
Parameters
- reader
- Type: System.IOTextReader
TextReader for the .txt file to read.
Return Value
Type: InternationalGeomagneticReferenceFieldVectorA magnetic field vector corresponding to the IGRF model.
Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | Thrown when reader passed in is null. |
Remarks
See IGRF website: https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html.
An updated .txt file can be downloaded by clicking the link "text file".
See Also