Description
The SpacecraftProcessNoise object allows the user to access the Process Noise rate matrix, as well as relevant configuration properties and methods. This object is always created as a child object of the SpacecraftODProperties object as seen in the example below:
Spacecraft1.OD.ProcessNoise.ReferenceFrame = "RIC";
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->SpacecraftProcessNoise
Parent Object: SpacecraftODProperties
Available In Editions:
Engineer
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
|
CoordinateSystem
|
The CoordinateSystem which defines the custom reference frame for the Process Noise Rate matrix. This property must be set using the SetProcessNoiseInFrame() method.
|
Type: CoordinateSystem
Access: Read-Only
|
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
|
Matrix
|
The Process Noise rate matrix expressed in the frame as specified by the ReferenceFrame property. The matrix is used with the Cartesian Element set and can contain Cd, Rho1, and/or Cr terms as well. To maintain symmetry, setting the i,j element will also change the j,i element.
|
Type: Matrix
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
|
ReferenceFrame
|
A string indicating the reference frame of the Process Noise rate matrix. This property must be set using the SetProcessNoiseInFrame() method.
|
Type: String
Access: Read-Only
|
|
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.
|
SetProcessNoiseInFrame
|
Sets the process noise rate matrix of the spacecraft state in the specified attitude reference frame.
|
|
| 