Class SHMFormatReader
- java.lang.Object
-
- org.orekit.forces.gravity.potential.PotentialCoefficientsReader
-
- org.orekit.forces.gravity.potential.SHMFormatReader
-
- All Implemented Interfaces:
DataLoader
public class SHMFormatReader extends PotentialCoefficientsReader
Reader for the SHM gravity field format.This format was used to describe the gravity field of EIGEN models published by the GFZ Potsdam up to 2003. It was then replaced by
ICGEM format
. The SHM format is described in Potsdam university website.The proper way to use this class is to call the
GravityFieldFactory
which will determine which reader to use with the selected gravity field file.- Author:
- Fabien Maussion
- See Also:
GravityFields
-
-
Constructor Summary
Constructors Constructor Description SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed)
Simple constructor.SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed, TimeScale timeScale)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RawSphericalHarmonicsProvider
getProvider(boolean wantNormalized, int degree, int order)
Get a provider for read spherical harmonics coefficients.void
loadData(InputStream input, String name)
Load data from a stream.-
Methods inherited from class org.orekit.forces.gravity.potential.PotentialCoefficientsReader
buildFlatArray, buildRow, getAe, getBaseProvider, getMaxAvailableDegree, getMaxAvailableOrder, getMaxParseDegree, getMaxParseOrder, getMu, getSupportedNames, getTideSystem, missingCoefficientsAllowed, parseCoefficient, parseDouble, rescale, rescale, setAe, setMaxParseDegree, setMaxParseOrder, setMu, setRawCoefficients, setReadComplete, setTideSystem, stillAcceptsData, toDate, toDate
-
-
-
-
Constructor Detail
-
SHMFormatReader
@DefaultDataContext public SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed)
Simple constructor.This constructor uses the
default data context
.- Parameters:
supportedNames
- regular expression for supported files namesmissingCoefficientsAllowed
- if true, allows missing coefficients in the input data- See Also:
SHMFormatReader(String, boolean, TimeScale)
-
SHMFormatReader
public SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed, TimeScale timeScale)
Simple constructor.- Parameters:
supportedNames
- regular expression for supported files namesmissingCoefficientsAllowed
- if true, allows missing coefficients in the input datatimeScale
- for parsing dates.- Since:
- 10.1
-
-
Method Detail
-
loadData
public void loadData(InputStream input, String name) throws IOException, ParseException, OrekitException
Load data from a stream.- Specified by:
loadData
in interfaceDataLoader
- Specified by:
loadData
in classPotentialCoefficientsReader
- Parameters:
input
- data input streamname
- name of the file (or zip entry)- Throws:
IOException
- if data can't be readParseException
- if data can't be parsed or if some loader specific error occursOrekitException
-
getProvider
public RawSphericalHarmonicsProvider getProvider(boolean wantNormalized, int degree, int order)
Get a provider for read spherical harmonics coefficients.SHM fields do include time-dependent parts which are taken into account in the returned provider.
- Specified by:
getProvider
in classPotentialCoefficientsReader
- Parameters:
wantNormalized
- if true, the provider will provide normalized coefficients, otherwise it will provide un-normalized coefficientsdegree
- maximal degreeorder
- maximal order- Returns:
- a new provider
- Since:
- 6.0
-
-