Description
The SpacecraftODProperties object allows the user to access the list of EstimableProperties that are associated with a Spacecraft, and defines other properties which dictate how the Spacecraft Covariance is handled. This object is not creatable in script, but is always created as a child object of the Spacecraft object as seen in the example below:
Spacecraft1.OD.Cartesian.X.Sigma = 0.05;
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->ODProperties->SpacecraftODProperties
Available In Editions:
Engineer
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
|
AGOM
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.SGP4.AGOM property.
|
Type: EstimableAGOM
Access: Read-Only
|
BStar
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.SGP4.BStar property.
|
Type: EstimableBStar
Access: Read-Only
|
Cartesian
|
The container of all the OD properties relating to the Cartesian orbit element set.
|
Type: CartesianOrbitStateEstimablePropertyContainer
Access: Read-Only
|
Cd
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.Cd property.
|
Type: EstimableCoefficient
Access: Read-Only
|
Covariance
|
The Covariance associated with this Spacecraft, expressed in the MJ2000 reference frame.
|
Type: SpacecraftCovariance
Access: Read-Only
|
CovariancePropagationModel
|
A flag indicating the method to be used to propagate the Covariance. Specifies the model to use in propagating the spacecraft's covariance. This property is used when propagating the Spacecraft covariance outside of filtering process. When using the KalmanFilterOD object, covariance propagation is always done using the full covariance matrix. When using the SquareRootInformationFilterOD object, square root of the information matrix is used.
|
Type: Variable
Access: Read/Write
|
Cr
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.Cr property.
|
Type: EstimableCoefficient
Access: Read-Only
|
CustomObservations
|
The array of OD properties that contains all of the measurement and bias properties associated with any user-defined Custom Observations.
|
Type: Array of CustomObservationMeasurements
Access: Read-Only
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DragEstimateOption
|
A flag indicating whether Cd or Rho1 should be the method for estimating the drag on the Spacecraft.
|
Type: Variable
Access: Read/Write
|
ElementSetToProcess
|
A flag indicating the element set to use when estimating the orbit state.
|
Type: String
Access: Read-Only
|
Equinoctial
|
The container of all the OD properties relating to the Equinoctial orbit element set.
|
Type: EquinoctialOrbitStateEstimablePropertyContainer
Access: Read-Only
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
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
|
OtherAccelerationsX
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Ux property of the Force Model for this Spacecraft.
|
Type: EstimableAcceleration
Access: Read-Only
|
OtherAccelerationsY
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Uy property of the Force Model for this Spacecraft.
|
Type: EstimableAcceleration
Access: Read-Only
|
OtherAccelerationsZ
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Uz property of the Force Model for this Spacecraft.
|
Type: EstimableAcceleration
Access: Read-Only
|
PropagateCovariance
|
A flag indicating whether or not to propagate the Spacecraft covariance with each Step command separate from any Orbit Determination process. As a note, if the Spacecraft has been added to any Orbit Determination process, the Orbit Determination process will take precedence and this flag will be ignored. The StepOD() method associated with all the Sequential Filters also performs covariance propagation within an Orbit Determination process.
|
Type: Variable
Access: Read/Write
|
Properties
|
Array of all EstimableProperty objects included in the SpacecraftODProperties object.
|
Type: Array of EstimableProperty
Access: Read-Only
|
Rho1
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Rho1 property of the Force Model for this Spacecraft.
|
Type: EstimableCoefficient
Access: Read-Only
|
SGP4
|
The container of all the OD properties relating to the SGP4 orbit element set.
|
Type: Sgp4OrbitStateEstimablePropertyContainer
Access: Read-Only
|
SGP4STMPerturbationPct
|
Size of the perturbation to apply in computing the state transition matrix for SGP4 state estimation as a percentage of the a priori state property value.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
AddCustomObservation
|
Add the specified Custom Observation to be included for Orbit Determination processing.
|
ClearSavedStates
|
Clears previous saved states for this object.
|
DisassociateEphemerisForSmoother
|
Removes an association between the smoother and an Ephemeris set through the SetEphemerisForSmoother method.
|
GetEstimableProperty
|
Gets the EstimableProperty object for the specified property name.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
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.
|
RemoveCustomObservation
|
Remove the specified Custom Observation from the CustomObservation array.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
SetElementSetToProcess
|
Sets the orbit state element set to use in the estimation process, and optionally converts the covariance from the active set.
|
SetEphemerisForSmoother
|
Sets an ephemeris object into the SpacecraftODProperties object to hold the full smoother trajectory. The Ephemeris object will be populated on the call to CalculateSmoothedState.
|
|
Name
|
Description
|
Attributes
|
CovariancePropagationMethod
|
A flag indicating the method to be used to calculate the State Transition Matrix to propagate the Covariance.
This property has been Deprecated. Please use (Spacecraft.Propagator AsType Integrator).STMCalculationMethod instead.
|
Type: Variable
Access: Read/Write
|
Norad
|
The container of all the OD properties relating to the Norad orbit element set.
This property has been Deprecated. Please use OD.SGP4 instead.
|
Type: NoradOrbitStateEstimablePropertyContainer
Access: Read-Only
|
NoradSTMPerturbationPct
|
Size of the perturbation to apply in computing the state transition matrix for norad state estimation as a percentage of the a priori state property value.
This property has been Deprecated. Please use OD.Cartesian.Velocity instead.
|
Type: Variable
Access: Read/Write
|
Position
|
Array of the X, Y, and Z (positional) EstimableProperty objects.
This property has been Deprecated. Please use OD.Cartesian.Position instead.
|
Type: Array of EstimablePosition
Access: Read-Only
|
PositionProcessAction
|
This flag is a shortcut to set all of the position (X,Y,Z) Process Action flags.
This property has been Deprecated. Please use OD.Cartesian.PositionProcessAction instead.
|
Type: Variable
Access: Read/Write
|
StateTransitionMatrix
|
Returns the elements of the State Transition Matrix, in a row-major orientation. The Dimension of this array is the square of the total number of properties being Estimated or Considered for the Spacecraft.
This property has been Deprecated. Please use (Spacecraft.Propagator AsType Integrator).STM instead, using indices to access elements of the matrix.
|
Type: Array
Access: Read-Only
|
STM
|
Returns the State Transition Matrix. The matrix is always a square where the length of each side is determined by the total number of properties being estimated or considered.
This property has been Deprecated. Please use (Spacecraft.Propagator AsType Integrator).STM instead.
|
Type: Matrix
Access: Read-Only
|
Velocity
|
Array of the VX, VY, and VZ (velocity) EstimableProperty objects.
This property has been Deprecated. Please use OD.Cartesian.Velocity instead.
|
Type: Array of EstimableVelocity
Access: Read-Only
|
VelocityProcessAction
|
This flag is a shortcut to set all of the velocity (VX,VY,VZ) Process Action flags.
This property has been Deprecated. Please use OD.Cartesian.VelocityProcessAction instead.
|
Type: Variable
Access: Read/Write
|
VX
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.VX property.
This property has been Deprecated. Please use OD.Cartesian.VX instead.
|
Type: EstimableVelocity
Access: Read-Only
|
VY
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.VY property.
This property has been Deprecated. Please use OD.Cartesian.VY instead.
|
Type: EstimableVelocity
Access: Read-Only
|
VZ
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.VZ property.
This property has been Deprecated. Please use OD.Cartesian.VZ instead.
|
Type: EstimableVelocity
Access: Read-Only
|
X
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.X property.
This property has been Deprecated. Please use OD.Cartesian.X instead.
|
Type: EstimablePosition
Access: Read-Only
|
Y
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.Y property.
This property has been Deprecated. Please use OD.Cartesian.Y instead.
|
Type: EstimablePosition
Access: Read-Only
|
Z
|
The OD property that contains all of the OD statistics (Sigma, Process Noise, State Update, etc) associated with the Spacecraft.Z property.
This property has been Deprecated. Please use OD.Cartesian.Z instead.
|
Type: EstimablePosition
Access: Read-Only
|
|
See also
Orbit Determination Guide
|
