Description
The KalmanSmoother object provides smoothing capabilities to the KalmanFilterOD and UnscentedKalmanFilterOD object. The smoother techniques available are Fixed-Point and Fixed-Interval. 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->Smoother->KalmanSmoother
Parent Objects: KalmanFilterOD, UnscentedKalmanFilterOD
Available In Editions:
Engineer
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.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
Epoch
|
The epoch of the smoothed solution at the start of the buffer of observations.
|
Type: Variable
Access: Read-Only
Units: day
|
IsFixedLagBufferFull
|
In fixed-lag mode, returns true if the smoother has accumulated enough observations to fill the buffer as determined by the NumberOfPointsInInterval property. In fixed-point or fixed-lag full span mode, this always returns true.
|
Type: Variable
Access: Read-Only
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
NumberOfPointsInInterval
|
The number of points in the buffer over which the smoothing is performed. Note that for the Fixed-Lag mode this is an input; for Fixed-Point or Fixed-Lag Full Span mode this specifies the total number of points that have been accrued.
|
Type: Variable
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
|
SmootherResetGapDuration
|
Specifies the amount of time after which, if no observations are processed, the smoother is reset. Note: this only applies in fixed-point and fixed-lag mode.
|
Type: Variable
Access: Read/Write
Units: min
|
SmootherStateHasBeenUpdated
|
Specifies whether the Smoother has updated the filter states in the last operation executed in the filter. This is set to true if the last operation performed by the filter processed at least one Observation
|
Type: Variable
Access: Read-Only
|
SmootherType
|
Specifies the type of smoothing algorithm used. When using "Fixed-Lag", the smoothed state is not computed until a call to CalculateSmoothedState is made. When using "Fixed-Lag Full Span", the buffer will continue to grow (in increments of NumberOfPointsInInterval) until a call to CalculateSmoothedState is made, or the smoother is reset. Note, using Fixed-Lag full span has the potential to consume large amounts of system memory as the number of observations being processed continues to grow.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
CalculateSmoothedState
|
Forces the calculation of the smoothed state. This is applicable when the smoother is configured as a fixed-lag smoother only, when in fixed-point mode, the smoother updates the smoothed state every time the filter processes an observation.
|
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.
|
Reset
|
Resets the smoother, removing any data contained in the buffer.
|
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
|
MethodUsedForSmootherSolution
|
Property indicating what smoother algorithm was used in computing the solution. This is relevant when specifying a "fixed lag" algorithm in the SmootherType, when the interval buffer has yet to be filled, as during the period, a 'fixed point' algorithm will be used.
This property has been Deprecated. This property is no longer applicable, and simply returns the mode requested.
|
Type: Variable
Access: Read-Only
|
|
See also
Orbit Determination Guide
|
