fr.cnes.sirius.patrius.models.earth

Class GeoMagneticFieldFactory

java.lang.Object

fr.cnes.sirius.patrius.models.earth.GeoMagneticFieldFactory

public final class GeoMagneticFieldFactory
extends Object

Factory for different GeoMagneticField models.

Loading of geomagnetic field data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided GeoMagneticModelReader.

User can provide its own implementation of these loaders and provide them using addGeoMagneticModelReader(FieldModel, GeoMagneticModelReader).

By default some loaders are added (see below). Loaders are used in the defined order below. These loaders will use data provided by DataProvidersManager.

List of loaders can be cleared and reordered using clearGeoMagneticModelReaders().

By default, some loaders are added in the following order:

• COFFileFormatReader: COF file format. See COF file format for more information.

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used for geomagnetic field computation (IGRF and WMM) available through various getters.

Author:

Thomas Neidhart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoMagneticFieldFactory.FieldModel The currently supported geomagnetic field models.

Method Summary

Modifier and Type	Method and Description
static void	addDefaultGeoMagneticModelReader(GeoMagneticFieldFactory.FieldModel type) Add a default reader for geomagnetic models.
static void	addGeoMagneticModelReader(GeoMagneticFieldFactory.FieldModel type, GeoMagneticModelReader reader) Add a reader for geomagnetic models.
static void	clearGeoMagneticModelReaders() Clear geomagnetic models readers.
static void	clearModels() Method to reset igrf and wmm models to null.
static GeoMagneticField	getField(GeoMagneticFieldFactory.FieldModel type, AbsoluteDate year) Get the GeoMagneticField for the given model type and year.
static GeoMagneticField	getField(GeoMagneticFieldFactory.FieldModel type, double year) Get the GeoMagneticField for the given model type and year.
static GeoMagneticField	getIGRF(AbsoluteDate year) Get the IGRF model for the given year.
static GeoMagneticField	getIGRF(double year) Get the IGRF model for the given year.
static GeoMagneticField	getWMM(AbsoluteDate year) Get the WMM model for the given year.
static GeoMagneticField	getWMM(double year) Get the WMM model for the given year.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addGeoMagneticModelReader

public static void addGeoMagneticModelReader(GeoMagneticFieldFactory.FieldModel type,
                                             GeoMagneticModelReader reader)
                                      throws PatriusException

Add a reader for geomagnetic models.

Parameters:

type - the field model type

reader - custom reader to add for the geomagnetic models

Throws:

PatriusException - when the input field model type does not exist

addDefaultGeoMagneticModelReader

public static void addDefaultGeoMagneticModelReader(GeoMagneticFieldFactory.FieldModel type)
                                             throws PatriusException

Add a default reader for geomagnetic models.

Parameters:

type - the field model type

Throws:

PatriusException - when the input field model type does not exist

clearGeoMagneticModelReaders

public static void clearGeoMagneticModelReaders()

Clear geomagnetic models readers.

See Also:

addGeoMagneticModelReader(FieldModel, GeoMagneticModelReader), addDefaultGeoMagneticModelReader(FieldModel)

clearModels

public static void clearModels()

Method to reset igrf and wmm models to null.

getField

public static GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type,
                                        AbsoluteDate year)
                                 throws PatriusException

Get the GeoMagneticField for the given model type and year.

Parameters:

type - the field model type

year - the year in AbsoluteDate format

Returns:

a GeoMagneticField for the given year and model

Throws:

PatriusException - if the models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(AbsoluteDate)

getField

public static GeoMagneticField getField(GeoMagneticFieldFactory.FieldModel type,
                                        double year)
                                 throws PatriusException

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

Throws:

PatriusException - if the models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getIGRF

public static GeoMagneticField getIGRF(AbsoluteDate year)
                                throws PatriusException

Get the IGRF model for the given year.

Parameters:

year - the year in AbsoluteDate format

Returns:

a GeoMagneticField for the given year

Throws:

PatriusException - if the IGRF models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(AbsoluteDate)

getIGRF

public static GeoMagneticField getIGRF(double year)
                                throws PatriusException

Get the IGRF model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

Throws:

PatriusException - if the IGRF models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)

getWMM

public static GeoMagneticField getWMM(AbsoluteDate year)
                               throws PatriusException

Get the WMM model for the given year.

Parameters:

year - the year in AbsoluteDate format

Returns:

a GeoMagneticField for the given year

Throws:

PatriusException - if the WMM models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(AbsoluteDate)

getWMM

public static GeoMagneticField getWMM(double year)
                               throws PatriusException

Get the WMM model for the given year.

Parameters:

year - the decimal year

Returns:

a GeoMagneticField for the given year

Throws:

PatriusException - if the WMM models could not be loaded

See Also:

GeoMagneticField.getDecimalYear(int, int, int)