org.orekit.files.sinex

Class SinexLoader

java.lang.Object

org.orekit.files.sinex.SinexLoader

All Implemented Interfaces:

EopHistoryLoader

public class SinexLoader
extends Object
implements EopHistoryLoader

Loader for Solution INdependent EXchange (SINEX) files.

The loader can be used to load several data types contained in Sinex files. The current supported data are: station coordinates, site eccentricities, EOP, and Difference Code Bias (DCB). Several instances of Sinex loader must be created in order to parse different data types.

The parsing of EOP parameters for multiple files in different SinexLoader object, fed into the default DataContext might pose a problem in case validity dates are overlapping. As Sinex daily solution files provide a single EOP entry, the Sinex loader will add points at the limits of data dates (startDate, endDate) of the Sinex file, which in case of overlap will lead to inconsistencies in the final EOPHistory object. Multiple files can be parsed using a single SinexLoader with a regex to overcome this issue.

Since:

10.3

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
SinexLoader(DataSource source) Simple constructor.
SinexLoader(DataSource source, TimeScales scales) Loads SINEX from the given input stream using the specified auxiliary data.
SinexLoader(String supportedNames) Simple constructor.
SinexLoader(String supportedNames, DataProvidersManager dataProvidersManager, TimeScales scales) Construct a loader by specifying the source of SINEX auxiliary data files.

Method Summary

Modifier and Type	Method and Description
void	fillHistory(IERSConventions.NutationCorrectionConverter converter, SortedSet<EOPEntry> history) Load celestial body.
AbsoluteDate	getCreationDate() Get the creation date of the parsed SINEX file.
DcbSatellite	getDcbSatellite(String prn) Get the DCB data for a given satellite identified by its PRN.
DcbStation	getDcbStation(String siteCode) Get the DCB data for a given station.
AbsoluteDate	getFileEpochEndTime() Get the file epoch end time.
AbsoluteDate	getFileEpochStartTime() Get the file epoch start time.
ITRFVersion	getITRFVersion() Get the ITRF version used for the EOP entries processing.
Map<AbsoluteDate,SinexEopEntry>	getParsedEop() Get the parsed EOP data.
Station	getStation(String siteCode) Get the station corresponding to the given site code.
Map<String,Station>	getStations() Get the parsed station data.
void	setITRFVersion(int year) Set the ITRF version used in EOP entries processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

SinexLoader

@DefaultDataContext
public SinexLoader(String supportedNames)

Simple constructor. This constructor uses the default data context.

Parameters:

supportedNames - regular expression for supported files names

See Also:

SinexLoader(String, DataProvidersManager, TimeScales)

SinexLoader

public SinexLoader(String supportedNames,
                   DataProvidersManager dataProvidersManager,
                   TimeScales scales)

Construct a loader by specifying the source of SINEX auxiliary data files.

For EOP loading, a default ITRFVersion.ITRF_2014 is used. It is possible to update the version using the setITRFVersion(int) method.

Parameters:

supportedNames - regular expression for supported files names

dataProvidersManager - provides access to auxiliary data.

scales - time scales

SinexLoader

@DefaultDataContext
public SinexLoader(DataSource source)

Simple constructor. This constructor uses the default data context.

For EOP loading, a default ITRFVersion.ITRF_2014 is used. It is possible to update the version using the setITRFVersion(int) method.

Parameters:

source - source for the RINEX data

See Also:

SinexLoader(String, DataProvidersManager, TimeScales)

SinexLoader

public SinexLoader(DataSource source,
                   TimeScales scales)

Loads SINEX from the given input stream using the specified auxiliary data.

For EOP loading, a default ITRFVersion.ITRF_2014 is used. It is possible to update the version using the setITRFVersion(int) method.

Parameters:

source - source for the RINEX data

scales - time scales

Method Detail

setITRFVersion

public void setITRFVersion(int year)

Set the ITRF version used in EOP entries processing.

Parameters:

year - Year of the ITRF Version used for parsing EOP.

Since:

11.2

getITRFVersion

public ITRFVersion getITRFVersion()

Get the ITRF version used for the EOP entries processing.

Returns:

the ITRF Version used for the EOP processing.

Since:

11.2

getCreationDate

public AbsoluteDate getCreationDate()

Get the creation date of the parsed SINEX file.

Returns:

SINEX file creation date as an AbsoluteDate

Since:

12.0

getFileEpochStartTime

public AbsoluteDate getFileEpochStartTime()

Get the file epoch start time.

Returns:

the file epoch start time

Since:

12.0

getFileEpochEndTime

public AbsoluteDate getFileEpochEndTime()

Get the file epoch end time.

Returns:

the file epoch end time

Since:

12.0

getStations

public Map<String,Station> getStations()

Get the parsed station data.

Returns:

unmodifiable view of parsed station data

getParsedEop

public Map<AbsoluteDate,SinexEopEntry> getParsedEop()

Get the parsed EOP data.

Returns:

unmodifiable view of parsed station data

Since:

11.2

getStation

public Station getStation(String siteCode)

Get the station corresponding to the given site code.

Parameters:

siteCode - site code

Returns:

the corresponding station

fillHistory

public void fillHistory(IERSConventions.NutationCorrectionConverter converter,
                        SortedSet<EOPEntry> history)

Load celestial body.

Specified by:

fillHistory in interface EopHistoryLoader

Parameters:

converter - converter to use for nutation corrections

history - history to fill up

getDcbStation

public DcbStation getDcbStation(String siteCode)

Get the DCB data for a given station.

Parameters:

siteCode - site code

Returns:

DCB data for the station

Since:

12.0

getDcbSatellite

public DcbSatellite getDcbSatellite(String prn)

Get the DCB data for a given satellite identified by its PRN.

Parameters:

prn - the satellite PRN (e.g. "G01" for GPS 01)

Returns:

the DCB data for the satellite

Since:

12.0