EstimatorCovariance Object

 Top  Previous  Next

Description

The EstimatorCovariance object represents the total covariance associated with an Orbit Determination / State Estimation process.  The size of the covariance matrix itself is determined by the total number of items being estimated or considered in the process.

 

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->EstimatorCovariance

 

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.

 

Properties

 

Name

Description

Attributes

CorrelationMatrix

The correlation matrix. Derived from the covariance matrix.

Type:   Matrix

Access: Read-Only

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Diagonal

An array containing the elements of the diagonal (e.g. the Variances) of the Covariance matrix. The dimension of the array will equal the Number of Rows for the Covariance.

Type:   Array

Access: Read-Only

Matrix

The covariance matrix in the MJ2000 equatorial frame associated with all properties to be estimated. Symmetry of the covariance matrix is enforced when setting elements of this matrix.

Type:   Matrix

Access: Read-Only

Name

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

NumberOfRows

The number of rows in the Covariance matrix.

Type:   Variable

Access: Read-Only

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

SmoothedDiagonal

An array containing the elements of the diagonal (e.g. the Variances) of the Smoothed Covariance matrix. The dimension of the array will equal the Number of Rows for the Covariance.

Type:   Array

Access: Read-Only

SmoothedMatrix

The smoothed covariance matrix.

Type:   Matrix

Access: Read-Only

SquareRootInformationMatrix

The cholesky decomposition of the inverse of the covariance matrix.

Type:   Matrix

Access: Read-Only

 
 

 

Methods

 

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.

 
 

 

Deprecated Properties

 

Name

Description

Attributes

Elements

A one-dimensional array containing all the elements of the Covariance matrix.

 

This property has been Deprecated. Please use Covariance.Matrix instead, using indices to access elements of the matrix.

Type:   Array

Access: Read-Only

SmoothedElements

A one-dimensional array containing all the elements of the Smoothed Covariance matrix.

 

This property has been Deprecated. Please use Covariance.SmoothedMatrix instead, using indices to access elements of the matrix.

Type:   Array

Access: Read-Only

 
 

 

Deprecated Methods

 

Name

Description

GetElement

Returns the value of the specified Covariance matrix element.

 

This method has been Deprecated. Please use Covariance.Matrix() instead, using indices to access elements of the matrix.

GetSmoothedElement

Returns the Smoothed value of the specified Covariance matrix element.

 

This method has been Deprecated. Please use Covariance.SmoothedMatrix() instead, using indices to access elements of the matrix.

 
 

 

 

See also

Orbit Determination Guide