Description
The CustomEstimableProperty object is a base type that provides process action, process noise rate, sigma, smoothed value, and state update properties to the objects that derive from it. 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->CustomForce->CustomEstimableProperty
Available In Editions:
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
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
|
ProcessAction
|
Indicates whether the property should be estimated, considered, or ignored in the Orbit Determination process. If this property is part of a Spacecraft, which also has a process noise matrix interface, then changing this value will reinitialize the process noise matrix to a diagonal matrix in the ICRF frame.
|
Type: Variable
Access: Read/Write
|
ProcessNoiseRate
|
The amount of process noise per second to be added to the property's covariance with each time-step. If the property is frame dependent, setting this property will set it in the ICRF frame. If the property is part of a Spacecraft, which also has a process noise matrix interface, then setting this value will reinitialize the process noise matrix to a diagonal matrix in the ICRF frame. Alternatively, you can modify the process noise rate for this property by modifying the Spacecraft.OD.ProcessNoise.Matrix property directly, which will leave all other values intact.
|
Type: Variable
Access: Read/Write
|
Sigma
|
Specifies the uncertainty (standard deviation) in the value of the property.
|
Type: Variable
Access: Read/Write
|
SmoothedValue
|
The smoothed value of the property when the property is estimated in Kalman Filter / Smoother combination.
|
Type: Variable
Access: Read-Only
|
StateUpdate
|
The value of the state update that is applied to this property when it is estimated in an Orbit Determination process.
|
Type: Variable
Access: Read-Only
|
Value
|
The current value of the property.
|
Type: Variable
Access: Read/Write
|
|
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
|
Attributes
|
ProcessNoise
|
Specifies the amount of process noise to add to the diagonal elements of the covariance matrix with each time-step for this property.
This property has been Deprecated. Please use ProcessNoiseRate instead, and be sure to convert units appropriately when updating.
|
Type: Variable
Access: Read/Write
|
|
|
