InternationalGeomagneticReferenceFieldVectorReadCofFile Method (String)

Reads an IGRF .COF 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)

Syntax

C++

Copy

public static InternationalGeomagneticReferenceFieldVector ReadCofFile(
	string filePath
)

Public Shared Function ReadCofFile ( 
	filePath As String
) As InternationalGeomagneticReferenceFieldVector

public:
static InternationalGeomagneticReferenceFieldVector^ ReadCofFile(
	String^ filePath
)

static member ReadCofFile : 
        filePath : string -> InternationalGeomagneticReferenceFieldVector

Parameters

filePath: Type: SystemString
String file path for IGRF .COF file.

Return Value

Type: InternationalGeomagneticReferenceFieldVector
A magnetic field vector corresponding to the IGRF model.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when filePath passed in is .

Remarks

See IGRF website: https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html. An updated .COF file can be found inside the Geomag 7.0 software download.

Reference

InternationalGeomagneticReferenceFieldVector Class

ReadCofFile Overload

AGI.Foundation.Celestial Namespace

InternationalGeomagneticReferenceFieldVectorAddLanguageSpecificTextSet("LST206E05E4_0?cpp=::|nu=.");ReadCofFile Method (String)

Parameters

Return Value

Reference

InternationalGeomagneticReferenceFieldVectorReadCofFile Method (String)