RinexObsFile Object

Description

The RinexObsFile object provides functionalities for reading and writing PseudorangeObservation data (C1, C2, P1, P2) to and from a Rinex Observation file. This is an ASCII file of Pseudorange data conforming to the RINEX standard. The time system is GPS Time, and the scalar pseudorange data is given in meters and is reference frame independent.

Inheritance Hierarchy: Object->TrackingDataFile->RinexObsFile

Available In Editions:

Mission

Timing Precision Mode

This page describes functionality in millisecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Name	Description	Attributes
Agency	The name of the Agency in the Rinex Observation file header.	Type: String Access: Read/Write
AntennaBoresightXYZ	The orientation of the antenna phase center in the spacecraft BCS. Optional in Rinex v2, not present in Rinex v3.	Type: Array Access: Read/Write
AntennaNumber	The number of the Antenna in the Rinex Observation file header. Required in both Rinex v2 and v3.	Type: String Access: Read/Write
AntennaOffsetHEN	The position offset between the antenna and marker, in the East-North-Up frame. Not present in Rinex v2, optional in Rinex v3.	Type: Array Access: Read/Write
AntennaOffsetXYZ	The position offset between the antenna and marker, in the Spacecraft BCS frame. Not present in Rinex v2, optional in Rinex v3.	Type: Array Access: Read/Write
AntennaPhaseCenter	The location of the Antenna Phase center in the Spacecraft BCS frame. Not present in Rinex v2, optional in Rinex v3.	Type: Array Access: Read/Write
AntennaType	The type of the Antenna in the Rinex Observation file header. Required in both Rinex v2 and v3.	Type: String Access: Read/Write
AntennaZeroDirectionAzimuth	The direction of the zero-point of Azimuth for a ground-fixed antenna, given as degrees away from local North. Not present in Rinex v2, optional in Rinex v3.	Type: Variable Access: Read-Only Units: deg
AntennaZeroDirectionXYZ	The direction of the zero-point of Azimuth for the antenna in the Spacecraft BCS frame. This is used for application of Antenna Phase center variations as a function of Azimuth. Not present in Rinex v2, optional in Rinex v3.	Type: Array Access: Read/Write
ApproximatePosition	The approximate position of the marker. Required in both Rinex v2 and v3.	Type: Array Access: Read/Write Units: m
CenterOfMassXYZ	The location of the spacecraft center of mass in the spacecraft BCS. Not present in Rinex v2, optional in Rinex v3.	Type: Array Access: Read/Write
Comments	Comments for the header of the Rinex Observation file.	Type: StringArray Access: Read/Write
DataSpanEndEpoch	The Epoch of the last Observation in the file.	Type: Variable Access: Read-Only Units: day
DataSpanStartEpoch	The Epoch of the first Observation in the file.	Type: Variable Access: Read-Only Units: day
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Filename	The file name to load.	Type: String Access: Read/Write
FirstObservation	The first Observation in the file.	Type: Observation Access: Read-Only
Galileo	The OD property that contains all of the processing options for the measurements from the Galileo Constellation.	Type: GNSSOptions Access: Read-Only
GPS	The OD property that contains all of the processing options for the measurements from the GPS Constellation.	Type: GNSSOptions Access: Read-Only
LastObservation	The last Observation in the file.	Type: Observation Access: Read-Only
LeapSeconds	The number of Leap Seconds between GPS time and UTC.	Type: Variable Access: Read/Write
MarkerName	The name of the Marker in the Rinex Observation file header.	Type: String Access: Read/Write
MarkerNumber	The number of the Marker in the Rinex Observation file header.	Type: String Access: Read/Write
MarkerType	The type of the Marker in the Rinex Observation file header. Not present in Rinex v2, required in Rinex v3.	Type: String Access: Read/Write
MeasuringReceiver	The Measuring GNSS Receiver that is attached to the Spacecraft being Observed.	Type: GNSSReceiver Access: Read-Only
MeasuringSensor	The Sensor object attached to the measuring GNSS Receiver. The Sensor's X, Y, and Z position properties will be used to model an offset from the origin of the Spacecraft BCS when modeling measurements.	Type: Sensor Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
NavigationConstellations	An array of the observing Formation objects.	Type: Array of Formation Access: Read-Only
NumberOfComments	The number of Comments lines in the header of the Rinex Observation file.	Type: Variable Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
ObservationInterval	The time interval between successive observations.	Type: Variable Access: Read/Write Units: s
ObserverName	The name of the Observer in the Rinex Observation file header.	Type: String Access: Read/Write
ReceiverClockOffsetApplied	A flag indicating whether or not the observables have been corrected for the Receiver Clock offset provided in the Epoch records. Optional in both Rinex v2 and Rinex v3.	Type: Variable Access: Read/Write
ReceiverNumber	The number of the Receiver in the Rinex Observation file header.	Type: String Access: Read/Write
ReceiverType	The type of the Receiver in the Rinex Observation file header.	Type: String Access: Read/Write
ReceiverVersion	The version of the Receiver in the Rinex Observation file header.	Type: String Access: Read/Write
RinexVersion	The Rinex Version of the Observation file.	Type: Variable Access: Read/Write
SignalStrengthUnit	The units of the Signal Strength (also called Signal-to-Noise) observable. Not present in Rinex v2, required in Rinex v3.	Type: String Access: Read/Write

Name	Description
AddNavigationConstellation	Adds the Navigation Constellation (e.g. GPS or Galileo) as an Observer for the tracking data in the file.
ClearSavedStates	Clears previous saved states for this object.
GetAllObservations	Retrieves all observations from the TrackingDataFile and stores them in a List<Observation>. Any current observations held by the OD Observation object will be overwritten by the GetAllObservations() method.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetIonoFreeCombinationsFromHeader	Returns the valid combinations of Rinex measurement codes for IonoFree processing for the specfied Navigation Constellation (e.g. GPS or Galileo) contained within the header of the RinexObsFile.
GetMeasurementCodesFromHeader	Returns the Rinex 3 measurement codes for the specfied Navigation Constellation (e.g. GPS or Galileo) contained within the header of the RinexObsFile. For Rinex version 2 files, this method returns the corresponding Rinex 3 equivalent.
GetNextObservation	Retrieves the next observation in file.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveNavigationConstellation	Removes the specified Navigation Constellation (e.g. GPS or Galileo) from the Navigation Constellations array.
ResetToStart	Resets the TrackingDataFile to the start of the file.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetMeasuringReceiver	Set the GNSS Receiver that is providing the observations.
WriteValidDataToFile	Write out all Observations containing valid Measurements to a file. Returns 1 if data was written to a file, 0 if no valid observation data was found, or if the method fails to write to a file.

Name

Description

Attributes

AntennaOffset

The position offset between the antenna and marker, in the East-North-Up frame.

This property has been Deprecated. Please use either the AntennaOffsetHEN or AntennaOffsetXYZ array instead.

Type: Array

Access: Read/Write

Units: m

ApplyLimitValidationChecks

Determines whether to set the Validity flag on measurements as they are loaded, based on the applicable limits for the particular measurement type.

This property has been Deprecated. Please use GroundAntenna.ApplyTrackingDataConstraintChecks instead.

Type: Variable

Access: Read/Write

DataTypes

The Data Types contained in the Rinex Observation file.

This property has been Deprecated. Please use the RinexObsFile.GetMeasurementCodes() method instead.

Type: StringArray

Access: Read-Only

NavigationConstellation

Navigation Constellation (GPS, Galileo) that is observing the GNSS Receiver.

This property has been Deprecated. Please use the RinexObsFile.AddNavigationConstellation() method to add to the NavigationConstellations array instead.

Type: Formation

Access: Read-Only

NumberOfDataTypes

The number of Data Types contained in the Rinex Observation file.

This property has been Deprecated. Please use the RinexObsFile.GetMeasurementCodes() method instead.

Type: Variable

Access: Read-Only

UseC1

A flag indicating whether or not the c1 Pseudorange measurement is to be used.

This property has been Deprecated. Please use the GPS or Galileo PseudorangeProcessingOption property instead.

Type: Variable

Access: Read/Write

UseC2

A flag indicating whether or not the c2 Pseudorange measurement is to be used.

This property has been Deprecated. Please use the GPS or Galileo PseudorangeProcessingOption property instead.

Type: Variable

Access: Read/Write

UseIonoFree

A flag indicating whether or not the iono-free derived pseudorange measurement is to be used. This is only available if c1 and c2, or p1 and p2 are available.

This property has been Deprecated. Please use the GPS or Galileo IonoFreeMeasurementCodesToUse property instead.

Type: Variable

Access: Read/Write

UseIonosphericCorrection

A flag indicating whether or not the Ionospheric correction will be used.

This property has been Deprecated. Please use the GPS or Galileo UseIonosphericCorrection property instead.

Type: Variable

Access: Read/Write

UseMeasurementWeighting

A flag indicating whether or not to perform measurement weighting using internal geometric-based expressions. Measurement weighting should be turned off if a custom Measurement Noise model is implemented at the script level.

This property has been Deprecated. Please use the GPS or Galileo UseMeasurementWeighting property instead.

Type: Variable

Access: Read/Write

UseP1

A flag indicating whether or not the p1 Pseudorange measurement is to be used.

This property has been Deprecated. Please use the GPS or Galileo PseudorangeProcessingOption property instead.

Type: Variable

Access: Read/Write

UseP2

A flag indicating whether or not the p2 Pseudorange measurement is to be used.

This property has been Deprecated. Please use the GPS or Galileo PseudorangeProcessingOption property instead.

Type: Variable

Access: Read/Write