GXIGRF class¶

class geosoft.gx.GXIGRF¶

International Geomagnetic Reference Field
Methods to work with IGRF objects. The IGRF object
contains data for the IGRF model of the geomagnetic
reference field.

calc((float)arg1, (float)arg2, (float)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:¶

Calculate IGRF data for a given IGRF model.

Parameters:	arg1 (float) – Elevation (metres) arg2 (float) – Longitude (-180 to 180) arg3 (float) – Latitude (-90 to 90) Returns arg4 (`geosoft.gx.float_ref`) – Field strength arg5 (`geosoft.gx.float_ref`) – Field inclination arg6 (`geosoft.gx.float_ref`) – Field declination
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

Calculate IGRF data (total field, inclination, and declination)
for a given IGRF model. The model used will be the same as that
obtained with geosoft.gx.GXIGRF.create().

calc_vv((GXVV)arg1, (GXVV)arg2, (GXVV)arg3, (GXVV)arg4, (GXVV)arg5, (GXVV)arg6) → None:¶

Calculate IGRF data VV's for a given IGRF model.

Parameters:	arg1 (`geosoft.gx.GXVV`) – Input elevation data (metres) arg2 (`geosoft.gx.GXVV`) – Input longitude data (-180 to 180) arg3 (`geosoft.gx.GXVV`) – Input latitude data (-90 to 90) arg4 (`geosoft.gx.GXVV`) – Output total field arg5 (`geosoft.gx.GXVV`) – Output inclination arg6 (`geosoft.gx.GXVV`) – Output declination
Returns:	Nothing
Return type:	None

New in version 5.0.0.

Note:

Calculate IGRF data (total field, inclination, and declination)
for a given IGRF model. The model used will be the same as that
obtained with geosoft.gx.GXIGRF.create().
All of the VV's should be the same length. The function
will abort if they are not.

No assumption is made on what data types are contained by
any of the VV's. However, all total field, inclination, and
declination values are internally calculated as real data.
These values will be converted to the types contained in the
output VV's.

static create((GXContext)ctx, (float)arg1, (int)arg2, (str)arg3) → GXIGRF:¶

Create an IGRF.

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (float) – Date required arg2 (int) – Year of the IGRF model to use arg3 (str) – Name of the IGRF reference data file
Returns:	IGRF Object
Return type:	`geosoft.gx.GXIGRF`

New in version 5.0.0.

Note:

If the year of the IGRF model is dummy, then
the IGRF year nearest to the line's date will
be used. Otherwise, the specified year is used.

static date_range((GXContext)ctx, (str)arg1, (float_ref)arg2, (float_ref)arg3) → None:¶

Determine the range of years covered by an IGRF or DGRF file

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – Model data file name arg2 (`geosoft.gx.float_ref`) – Minimum year (rMAX if none found) arg3 (`geosoft.gx.float_ref`) – Maximum year (rMIN if none found)
Returns:	Nothing
Return type:	None

New in version 6.1.0.

Note:

This is useful when using a DGRF file, because the system is set
up only to calculate for years within the date range, and will
return an error otherwise.

is_null() → bool¶

Check if the instance of geosoft.gx.GXIGRF is null (undefined)

Returns:	True if this is a null instance of `geosoft.gx.GXIGRF`, False otherwise.
Return type:	bool`

static null() → GXIGRF¶

A null (undefined) instance of geosoft.gx.GXIGRF

Returns:	A null `geosoft.gx.GXIGRF`
Return type:	`geosoft.gx.GXIGRF`