SP3 (ORbit Extrapolation KIT 11.1 API)

java.lang.Object
- org.orekit.files.sp3.SP3

All Implemented Interfaces:

EphemerisFile<SP3.SP3Coordinate,SP3.SP3Ephemeris>
```
public class SP3
extends Object
implements EphemerisFile<SP3.SP3Coordinate,SP3.SP3Ephemeris>
```
Represents a parsed SP3 orbit file.

Author:

Thomas Neidhart, Evan Ward

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SP3.SP3Coordinate` A single record of position clock and possibly derivatives in an SP3 file.
`class`	`SP3.SP3Ephemeris` An ephemeris for a single satellite in a SP3 file.
`static class`	`SP3.SP3FileType` File type indicator.
`static class`	`SP3.SP3OrbitType` Orbit type indicator.

Nested classes/interfaces inherited from interface org.orekit.files.general.EphemerisFile
EphemerisFile.EphemerisSegment<C extends TimeStampedPVCoordinates>, EphemerisFile.SatelliteEphemeris<C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>>

Field Summary

Fields
Modifier and Type Field and Description

static String SP3_FRAME_CENTER_STRING
String representation of the center of ephemeris coordinate system.

Fields
Modifier and Type	Field and Description
`static String`	`SP3_FRAME_CENTER_STRING` String representation of the center of ephemeris coordinate system.

Constructor Summary

Constructors
Constructor and Description

SP3(double mu, int interpolationSamples, Function<? super String,? extends Frame> frameBuilder)
Create a new SP3 file object.

Constructors
Constructor and Description
`SP3(double mu, int interpolationSamples, Function<? super String,? extends Frame> frameBuilder)` Create a new SP3 file object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSatellite(String satId)` Add a new satellite with a given identifier to the list of stored satellites.
`void`	`addSatelliteCoordinate(String satId, SP3.SP3Coordinate coord)` Adds a new P/V coordinate for a given satellite.
`boolean`	`containsSatellite(String satId)` Tests whether a satellite with the given id is contained in this orbit file.
`double`	`getAccuracy(int index)` Get the formal accuracy for a satellite.
`String`	`getAgency()` Returns the agency that prepared this SP3 file.
`String`	`getCoordinateSystem()` Returns the coordinate system of the entries in this orbit file.
`String`	`getDataUsed()` Returns the data used indicator from the SP3 file.
`double`	`getDayFraction()` Returns the day fraction for this SP3 file.
`AbsoluteDate`	`getEpoch()` Returns the start epoch of the orbit file.
`double`	`getEpochInterval()` Returns the time interval between epochs (in seconds).
`int`	`getGpsWeek()` Returns the GPS week as contained in the SP3 file.
`int`	`getJulianDay()` Returns the julian day for this SP3 file.
`int`	`getNumberOfEpochs()` Returns the number of epochs contained in this orbit file.
`SP3.SP3OrbitType`	`getOrbitType()` Returns the `SP3.SP3OrbitType` for this SP3 file.
`String`	`getOrbitTypeKey()` Returns the orbit type key for this SP3 file.
`int`	`getSatelliteCount()` Get the number of satellites contained in this orbit file.
`Map<String,SP3.SP3Ephemeris>`	`getSatellites()` Get the loaded ephemeris for each satellite in the file.
`double`	`getSecondsOfWeek()` Returns the seconds of the GPS week as contained in the SP3 file.
`TimeSystem`	`getTimeSystem()` Returns the `TimeSystem` used to time-stamp position entries.
`SP3.SP3FileType`	`getType()` Returns the `SP3.SP3FileType` associated with this SP3 file.
`void`	`setAccuracy(int index, double accuracy)` Set the formal accuracy for a satellite.
`void`	`setAgency(String agencyStr)` Set the agency string for this SP3 file.
`void`	`setCoordinateSystem(String system)` Set the coordinate system used for the orbit entries.
`void`	`setDataUsed(String data)` Set the data used indicator for this SP3 file.
`void`	`setDayFraction(double fraction)` Set the day fraction for this SP3 file.
`void`	`setEpoch(AbsoluteDate time)` Set the epoch of the SP3 file.
`void`	`setEpochInterval(double interval)` Set the epoch interval for this SP3 file.
`void`	`setFilter(CartesianDerivativesFilter filter)` Set the derivatives filter.
`void`	`setGpsWeek(int week)` Set the GPS week of the SP3 file.
`void`	`setJulianDay(int day)` Set the julian day for this SP3 file.
`void`	`setNumberOfEpochs(int epochCount)` Set the number of epochs as contained in the SP3 file.
`void`	`setOrbitTypeKey(String oTypeKey)` Set the orbit type key for this SP3 file.
`void`	`setSecondsOfWeek(double seconds)` Set the seconds of the GPS week for this SP3 file.
`void`	`setTimeSystem(TimeSystem system)` Set the time system used in this SP3 file.
`void`	`setType(SP3.SP3FileType fileType)` Set the file type for this SP3 file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SP3_FRAME_CENTER_STRING
```
public static final String SP3_FRAME_CENTER_STRING
```
    String representation of the center of ephemeris coordinate system.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SP3
```
public SP3(double mu,
           int interpolationSamples,
           Function<? super String,? extends Frame> frameBuilder)
```
    Create a new SP3 file object.
    
    Parameters:
    
    mu - is the standard gravitational parameter in m^3 / s^2.
    
    interpolationSamples - number of samples to use in interpolation.
    
    frameBuilder - for constructing a reference frame from the identifier
- Method Detail
  - setFilter
```
public void setFilter(CartesianDerivativesFilter filter)
```
    Set the derivatives filter.
    
    Parameters:
    
    filter - that indicates which derivatives of position are available.
  - getType
```
public SP3.SP3FileType getType()
```
    Returns the SP3.SP3FileType associated with this SP3 file.
    
    Returns:
    
    the file type for this SP3 file
  - setType
```
public void setType(SP3.SP3FileType fileType)
```
    Set the file type for this SP3 file.
    
    Parameters:
    
    fileType - the file type to be set
  - getTimeSystem
```
public TimeSystem getTimeSystem()
```
    Returns the TimeSystem used to time-stamp position entries.
    
    Returns:
    
    the TimeSystem of the orbit file
  - setTimeSystem
```
public void setTimeSystem(TimeSystem system)
```
    Set the time system used in this SP3 file.
    
    Parameters:
    
    system - the time system to be set
  - getDataUsed
```
public String getDataUsed()
```
    Returns the data used indicator from the SP3 file.
    
    Returns:
    
    the data used indicator (unparsed)
  - setDataUsed
```
public void setDataUsed(String data)
```
    Set the data used indicator for this SP3 file.
    
    Parameters:
    
    data - the data used indicator to be set
  - getEpoch
```
public AbsoluteDate getEpoch()
```
    Returns the start epoch of the orbit file.
    
    Returns:
    
    the start epoch
  - setEpoch
```
public void setEpoch(AbsoluteDate time)
```
    Set the epoch of the SP3 file.
    
    Parameters:
    
    time - the epoch to be set
  - getGpsWeek
```
public int getGpsWeek()
```
    Returns the GPS week as contained in the SP3 file.
    
    Returns:
    
    the GPS week of the SP3 file
  - setGpsWeek
```
public void setGpsWeek(int week)
```
    Set the GPS week of the SP3 file.
    
    Parameters:
    
    week - the GPS week to be set
  - getSecondsOfWeek
```
public double getSecondsOfWeek()
```
    Returns the seconds of the GPS week as contained in the SP3 file.
    
    Returns:
    
    the seconds of the GPS week
  - setSecondsOfWeek
```
public void setSecondsOfWeek(double seconds)
```
    Set the seconds of the GPS week for this SP3 file.
    
    Parameters:
    
    seconds - the seconds to be set
  - getJulianDay
```
public int getJulianDay()
```
    Returns the julian day for this SP3 file.
    
    Returns:
    
    the julian day
  - setJulianDay
```
public void setJulianDay(int day)
```
    Set the julian day for this SP3 file.
    
    Parameters:
    
    day - the julian day to be set
  - getDayFraction
```
public double getDayFraction()
```
    Returns the day fraction for this SP3 file.
    
    Returns:
    
    the day fraction
  - setDayFraction
```
public void setDayFraction(double fraction)
```
    Set the day fraction for this SP3 file.
    
    Parameters:
    
    fraction - the day fraction to be set
  - getEpochInterval
```
public double getEpochInterval()
```
    Returns the time interval between epochs (in seconds).
    
    Returns:
    
    the time interval between epochs
  - setEpochInterval
```
public void setEpochInterval(double interval)
```
    Set the epoch interval for this SP3 file.
    
    Parameters:
    
    interval - the interval between orbit entries
  - getNumberOfEpochs
```
public int getNumberOfEpochs()
```
    Returns the number of epochs contained in this orbit file.
    
    Returns:
    
    the number of epochs
  - setNumberOfEpochs
```
public void setNumberOfEpochs(int epochCount)
```
    Set the number of epochs as contained in the SP3 file.
    
    Parameters:
    
    epochCount - the number of epochs to be set
  - getCoordinateSystem
```
public String getCoordinateSystem()
```
    Returns the coordinate system of the entries in this orbit file.
    
    Returns:
    
    the coordinate system
  - setCoordinateSystem
```
public void setCoordinateSystem(String system)
```
    Set the coordinate system used for the orbit entries.
    
    Parameters:
    
    system - the coordinate system to be set
  - getOrbitType
```
public SP3.SP3OrbitType getOrbitType()
```
    Returns the SP3.SP3OrbitType for this SP3 file.
    
    Returns:
    
    the orbit type
  - getOrbitTypeKey
```
public String getOrbitTypeKey()
```
    Returns the orbit type key for this SP3 file.
    
    Returns:
    
    the orbit type key
    
    Since:
    
    9.3
  - setOrbitTypeKey
```
public void setOrbitTypeKey(String oTypeKey)
```
    Set the orbit type key for this SP3 file.
    
    Parameters:
    
    oTypeKey - the orbit type key to be set
    
    Since:
    
    9.3
  - getAgency
```
public String getAgency()
```
    Returns the agency that prepared this SP3 file.
    
    Returns:
    
    the agency
  - setAgency
```
public void setAgency(String agencyStr)
```
    Set the agency string for this SP3 file.
    
    Parameters:
    
    agencyStr - the agency string to be set
  - addSatellite
```
public void addSatellite(String satId)
```
    Add a new satellite with a given identifier to the list of stored satellites.
    
    Parameters:
    
    satId - the satellite identifier
  - getSatellites
```
public Map<String,SP3.SP3Ephemeris> getSatellites()
```
    Description copied from interface: EphemerisFile
    
    Get the loaded ephemeris for each satellite in the file.
    
    Specified by:
    
    getSatellites in interface EphemerisFile<SP3.SP3Coordinate,SP3.SP3Ephemeris>
    
    Returns:
    
    a map from the satellite's ID to the information about that satellite contained in the file.
  - getSatelliteCount
```
public int getSatelliteCount()
```
    Get the number of satellites contained in this orbit file.
    
    Returns:
    
    the number of satellites
  - setAccuracy
```
public void setAccuracy(int index,
                        double accuracy)
```
    Set the formal accuracy for a satellite.
    
    Parameters:
    
    index - is the index of the satellite.
    
    accuracy - of the satellite, in m.
  - getAccuracy
```
public double getAccuracy(int index)
```
    Get the formal accuracy for a satellite.
    
    Parameters:
    
    index - is the index of the satellite.
    
    Returns:
    
    accuracy of the satellite, in m.
  - containsSatellite
```
public boolean containsSatellite(String satId)
```
    Tests whether a satellite with the given id is contained in this orbit file.
    
    Parameters:
    
    satId - the satellite id
    
    Returns:
    
    true if the satellite is contained in the file, false otherwise
  - addSatelliteCoordinate
```
public void addSatelliteCoordinate(String satId,
                                   SP3.SP3Coordinate coord)
```
    Adds a new P/V coordinate for a given satellite.
    
    Parameters:
    
    satId - the satellite identifier
    
    coord - the P/V coordinate of the satellite

Class SP3

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.files.general.EphemerisFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SP3_FRAME_CENTER_STRING

Constructor Detail

SP3

Method Detail

setFilter

getType

setType

getTimeSystem

setTimeSystem

getDataUsed

setDataUsed

getEpoch

setEpoch

getGpsWeek

setGpsWeek

getSecondsOfWeek

setSecondsOfWeek

getJulianDay

setJulianDay

getDayFraction

setDayFraction

getEpochInterval

setEpochInterval

getNumberOfEpochs

setNumberOfEpochs

getCoordinateSystem

setCoordinateSystem

getOrbitType

getOrbitTypeKey

setOrbitTypeKey

getAgency

setAgency

addSatellite

getSatellites

getSatelliteCount

setAccuracy

getAccuracy

containsSatellite

addSatelliteCoordinate