org.orekit.models.earth

Interface GeoMagneticFields

All Known Implementing Classes:

LazyLoadedGeoMagneticFields

public interface GeoMagneticFields

Methods for obtaining geomagnetic fields.

Since:

10.1

Author:

Evan Ward, Thomas Neidhart

See Also:

GeoMagneticFieldFactory, LazyLoadedGeoMagneticFields

Method Summary

Modifier and Type	Method and Description
GeoMagneticField	getField(GeoMagneticFieldFactory.FieldModel type, double year) Get the GeoMagneticField for the given model type and year.
GeoMagneticField	getIGRF(double year) Get the IGRF model for the given year.
GeoMagneticField	getWMM(double year) Get the WMM model for the given year.

Method Detail

getField

GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type,
                          double year)

Get the GeoMagneticField for the given model type and year.

Parameters:

type - the field model type

year - the decimal year

Returns:

a GeoMagneticField for the given year and model

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getIGRF

GeoMagneticField getIGRF(double year)

Get the IGRF model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getWMM

GeoMagneticField getWMM(double year)

Get the WMM model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

See Also:

GeoMagneticField.getDecimalYear(int, int, int)