Package org.orekit.models.earth
Class GeoMagneticFieldFactory
java.lang.Object
org.orekit.models.earth.GeoMagneticFieldFactory
Factory for different
GeoMagneticField models.
This is a utility class, so its constructor is private.
- Author:
- Thomas Neidhart, Evan Ward
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe currently supported geomagnetic field models. -
Method Summary
Modifier and TypeMethodDescriptionstatic GeoMagneticFieldgetField(GeoMagneticFieldFactory.FieldModel type, double year) Get theGeoMagneticFieldfor the given model type and year.static LazyLoadedGeoMagneticFieldsGet the instance ofGeoMagneticFieldsthat is called by methods in this class.static GeoMagneticFieldgetIGRF(double year) Get the IGRF model for the given year.static GeoMagneticFieldgetWMM(double year) Get the WMM model for the given year.
-
Method Details
-
getGeoMagneticFields
Get the instance ofGeoMagneticFieldsthat is called by methods in this class.- Returns:
- the geomagnetic fields used by this factory.
- Since:
- 10.1
-
getField
@DefaultDataContext public static GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type, double year) Get theGeoMagneticFieldfor the given model type and year.- Parameters:
type- the field model typeyear- the decimal year- Returns:
- a
GeoMagneticFieldfor the given year and model - See Also:
-
getIGRF
Get the IGRF model for the given year.- Parameters:
year- the decimal year- Returns:
- a
GeoMagneticFieldfor the given year - See Also:
-
getWMM
Get the WMM model for the given year.- Parameters:
year- the decimal year- Returns:
- a
GeoMagneticFieldfor the given year - See Also:
-