Description
The CovarianceUtilities Object allows a user to calculate a covariance based on a set of states, and calculate random states generated based on a covariance. See the Orbit Determination Guide for more information.
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àCovarianceUtilities
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
DeclaredName
|
The name of the object as declared.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
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.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
Name
|
Description
|
CalculateCovariance
|
Calculates and returns the covariance of a distribution of states.
|
CalculateMahalanobisDistance
|
Calculates the Mahalanobis distance of the state relative to the mean state given the specified covariance.
|
CalculateMeanAndCovariance
|
Calculates and returns the covariance of a distribution of states. Also, populates the meanState argument with the computed mean state.
|
GetRandomState
|
Returns a random state from a zero-mean Gaussian distribution described by the provided covariance matrix.
|
GetRandomStates
|
Returns multiple randoms state from a zero-mean Gaussian distribution described by the provided covariance matrix. The resulting random states are returned in a column matrix.
|
|
| 