org.orekit.forces.gravity.potential

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:

GravityFieldFactory

Constructor Summary

Constructors

Constructor and Description
SHMFormatReader(String supportedNames, boolean missingCoefficientsAllowed) Simple constructor.

Method Summary

Modifier and Type	Method and 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

buildRow, buildTriangularArray, extendListOfLists, getAe, getConstantProvider, getMaxAvailableDegree, getMaxAvailableOrder, getMaxParseDegree, getMaxParseOrder, getMu, getSupportedNames, getTideSystem, missingCoefficientsAllowed, parseCoefficient, parseCoefficient, parseDouble, rescale, setAe, setMaxParseDegree, setMaxParseOrder, setMu, setRawCoefficients, setReadComplete, setTideSystem, stillAcceptsData, toArray

Methods inherited from class java.lang.Object

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

Constructor Detail

SHMFormatReader

public SHMFormatReader(String supportedNames,
                       boolean missingCoefficientsAllowed)

Simple constructor.

Parameters:

supportedNames - regular expression for supported files names

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Method Detail

loadData

public void loadData(InputStream input,
                     String name)
              throws IOException,
                     ParseException,
                     OrekitException

Load data from a stream.

Specified by:

loadData in interface DataLoader

Specified by:

loadData in class PotentialCoefficientsReader

Parameters:

input - data input stream

name - name of the file (or zip entry)

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

OrekitException - if some data is missing or if some loader specific error occurs

getProvider

public RawSphericalHarmonicsProvider getProvider(boolean wantNormalized,
                                                 int degree,
                                                 int order)
                                          throws OrekitException

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 class PotentialCoefficientsReader

Parameters:

wantNormalized - if true, the provider will provide normalized coefficients, otherwise it will provide un-normalized coefficients

degree - maximal degree

order - maximal order

Returns:

a new provider

Throws:

OrekitException - if the requested maximal degree or order exceeds the available degree or order or if no gravity field has read yet

Since:

6.0

See Also:

PotentialCoefficientsReader.getConstantProvider(boolean, int, int)