Class OceanLoadingCoefficients
- java.lang.Object
-
- org.orekit.models.earth.displacement.OceanLoadingCoefficients
-
public class OceanLoadingCoefficients extends Object
Site specific coefficients for ocean loading.Instances of this class are typically created by
OceanLoadingCoefficientsBLQFactory
that parses files from Onsala Space Observatory files in BLQ format found in the Orekit data configuration.Instances of this class are guaranteed to be immutable
- Since:
- 9.1
- Author:
- Luc Maisonobe
- See Also:
GroundStation
,OceanLoadingCoefficientsBLQFactory
,OceanLoading
-
-
Constructor Summary
Constructors Constructor Description OceanLoadingCoefficients(String siteName, GeodeticPoint siteLocation, Tide[][] tides, double[][] zAmplitude, double[][] zPhase, double[][] wAmplitude, double[][] wPhase, double[][] sAmplitude, double[][] sPhase)
Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getNbSpecies()
Get the number of species.int
getNbTides(int species)
Get the number of tides for one species.GeodeticPoint
getSiteLocation()
Get the site location.String
getSiteName()
Get the site name.double
getSouthAmplitude(int i, int j)
Get the amplitude along South axis.double
getSouthPhase(int i, int j)
Get the phase along South axis.Tide
getTide(int i, int j)
Get the tide.double
getWestAmplitude(int i, int j)
Get the amplitude along west axis.double
getWestPhase(int i, int j)
Get the phase along West axis.double
getZenithAmplitude(int i, int j)
Get the amplitude along zenith axis.double
getZenithPhase(int i, int j)
Get the phase along zenith axis.
-
-
-
Constructor Detail
-
OceanLoadingCoefficients
public OceanLoadingCoefficients(String siteName, GeodeticPoint siteLocation, Tide[][] tides, double[][] zAmplitude, double[][] zPhase, double[][] wAmplitude, double[][] wPhase, double[][] sAmplitude, double[][] sPhase)
Simple constructor.Arrays must be organized by species and sorted in increasing rate order.
- Parameters:
siteName
- site namesiteLocation
- site locationtides
- main tides, by species and increasing ratezAmplitude
- amplitude along zenith axiszPhase
- phase along zenith axiswAmplitude
- amplitude along WestwPhase
- phase along West axissAmplitude
- amplitude along SouthsPhase
- phase along South axis
-
-
Method Detail
-
getSiteName
public String getSiteName()
Get the site name.- Returns:
- site name
-
getSiteLocation
public GeodeticPoint getSiteLocation()
Get the site location.- Returns:
- site location
-
getTide
public Tide getTide(int i, int j)
Get the tide.- Parameters:
i
- speciesj
- tide in the species- Returns:
- tide
-
getZenithAmplitude
public double getZenithAmplitude(int i, int j)
Get the amplitude along zenith axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- amplitude along zenith axis
-
getZenithPhase
public double getZenithPhase(int i, int j)
Get the phase along zenith axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- phase along zenith axis
-
getWestAmplitude
public double getWestAmplitude(int i, int j)
Get the amplitude along west axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- amplitude along west axis
-
getWestPhase
public double getWestPhase(int i, int j)
Get the phase along West axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- phase along West axis
-
getSouthAmplitude
public double getSouthAmplitude(int i, int j)
Get the amplitude along South axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- amplitude along South axis
-
getSouthPhase
public double getSouthPhase(int i, int j)
Get the phase along South axis.- Parameters:
i
- speciesj
- tide in the species- Returns:
- phase along South axis
-
getNbSpecies
public int getNbSpecies()
Get the number of species.- Returns:
- number of species
-
getNbTides
public int getNbTides(int species)
Get the number of tides for one species.- Parameters:
species
- species index- Returns:
- number of tides for one species
-
-