CustomObservation Object

 Top  Previous  Next

Description

The CustomObservation object holds Measurements associated with user defined unique measurement models. All estimators support the processing of custom observations. To run orbit determination using custom observations, two separate parts of the measurement model must be computed by the user:

 

•Both the pre- and post-update computed values

•The measurement partial derivatives (not required for the unscented kalman filter)

 

Inheritance Hierarchy: Object->Observation->CustomObservation

 

Available In Editions:

Mission

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

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

 

Constructors

 

Signatures

Description

CustomObservation()

Create a CustomObservation object without associating it with any other objects.

 

 

 

Properties

 

Name

Description

Attributes

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Measurements

The measurements associated with the custom observation.

Type:   Array of Measurement

Access: Read/Write

Name

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

Type:   String

Access: Read/Write

ObjectBeingObserved

This property is not used for CustomObservation types.

Type:   Object

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

ObservationType

A string for the user to indicate a label for this observation type.

Type:   String

Access: Read/Write

ObservedEpoch

The epoch of the Observation in TAI.

Type:   Variable

Access: Read/Write

Units:   day

Observer

This property is not used for CustomObservation types.

Type:   Object

Access: Read-Only

UseMeasurement

An array of flags indicating whether or not each measurement will be used.

Type:   Array

Access: Read/Write

WasUnderweightingUsed

A flag indicating whether or not measurement underweighting was used as part of the filter state and covariance update for this observation.

Type:   Variable

Access: Read-Only

 
 

 

Methods

 

Name

Description

AddMeasurement

Adds a Custom Measurement to the Measurements array. Returns the index of the new measurement.

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.

RemoveMeasurement

Removes the Custom Measurement specfied by the measurement label.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

SetComputedValue

Sets the Pre-Update or Post-Update ComputedValue for the Custom Measurement with the specified label.

SetObjectBeingObserved

Set the given object as the Object Being Observed for this Observation.

SetObserver

Set the given object as the Observing Object for this Observation.

SetPartialDerivatives

Sets the Partial Derivatives matrix for the Custom Measurement with the specified label.

SetSigmaPointComputedValues

Sets the Pre-Update or Post-Update Sigma Point Computed Values of the Custom Measurement with the specified label. The Sigma Point Computed values are used for Unscented Kalman Filter processing.