BatchLeastSquaresOD Object

Description

The BatchLeastSquaresOD object provides algorithms for performing Orbit Determination and State Estimation using a weighted-least squares technique, processing an entire "batch" of observations all at one time. All observations are processed to perform one State Update at the user-specified Solution Epoch. See the Orbit Determination Guide for more information.

Inheritance Hierarchy: Object->ODEstimationProcess->BatchLeastSquaresOD

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.

Name	Description	Attributes
AprioriCovarianceOption	The options for how the a priori covariance is handled through the iteration process.	Type: Variable Access: Read/Write
ConstrainDataSpan	Flag indicating whether or not to constrain the data span based on the values of SpanStartEpoch and SpanEndEpoch.	Type: Variable Access: Read/Write
Covariance	The Covariance associated with the ODEstimationProcess.	Type: EstimatorCovariance Access: Read-Only
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
InformationMatrix	The information matrix in the ICRF associated with all properties to be estimated. This is a read-only property representing the information matrix after the accumulation of all the observations. This strictly represents the inverse of the post update covariance. A priori values of the information matrix should be set through the apriori covariance of the state elements.	Type: Matrix Access: Read-Only
InformationMatrixInversionMethod	The method used to invert the information matrix. By default, the matrix is inverting using a full-pivot approach, but if the information matrix is not well-conditioned, then either a scaled full-pivot inversion will occur, if possible, or as a last resort, a Moore-Penrose pseudo-inverse will be used.	Type: Variable Access: Read-Only
IterationCount	The number of iterations that have been processed.	Type: Variable Access: Read-Only
MaxAllowableSigma	The sigma tolerance to be applied when editing observation data.	Type: Variable Access: Read/Write
MeasurementEditingOption	The options for how measurement data will be evaluated for inclusion in processing.	Type: Variable Access: Read/Write
MinimumNumberOfMeasurementsForSigmaEditing	The minimum number of measurements required for a measurement type to be sigma edited. This property is only applied when the Measurement Editing Option is set to 'Use the Standard Deviation'	Type: Variable Access: Read/Write
Name	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
ObjectsToProcess	Array of objects that have been included in the Orbit Determination process.	Type: Array of Object Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Observations	An array of Observations that have been processed by the BatchLeastSquaresOD object.	Type: Array of Observation Access: Read-Only
PredictedRMS	The predicted Root-Mean-Square (RMS) of the measurement residuals for the next iteration.	Type: Variable Access: Read-Only
RegisteredTrackingDataFiles	Array of TrackingDataFile objects used to provided observations for the ODEstimationProcess.	Type: Array of TrackingDataFile Access: Read-Only
RMS	The Root-Mean-Square (RMS) of the measurement residuals for the current iteration.	Type: Variable Access: Read-Only
SolutionDampingAlpha	The computed Alpha value from the Quadratic Solution Damping algorithm. This term is used to scale the state update for a given iteration and adjust the Damping Factor on the subsequent iteration when the computed Rho is greater than the specified tolerance.	Type: Variable Access: Read-Only
SolutionDampingFactor	The damping factor for the Levenberg-Marquardt algorithm. This value is updated based on the results of each iteration of processing.	Type: Variable Access: Read/Write
SolutionDampingFactorDecrease	The magnitude of decrease in the damping factor for the Levenberg-Marquardt algorithm. If the iteration improves the residuals, the DampingFactor is decreased as: DampingFactor = DampingFactor/DampingFactorDecrease. This property is only used if the SolutionDampingOption is set to 'Use Levenberg-Marquardt'.	Type: Variable Access: Read/Write
SolutionDampingFactorIncrease	The magnitude of increase in the damping factor for the Levenberg-Marquardt algorithm. If the iteration does not improve the residuals, the DampingFactor is increased as: DampingFactor = DampingFactor*DampingFactorIncrease. This property is only used if the SolutionDampingOption is set to 'Use Levenberg-Marquardt'.	Type: Variable Access: Read/Write
SolutionDampingOption	The options for damping the convergence of the solution.	Type: Variable Access: Read/Write
SolutionDampingRho	The computed Rho value from the Solution Damping algorithm. This computed value is compared against the tolerance and used to determine if a state update for a given iteration improves the state estimate. If the state estimate is improved, the Damping Factor is decreased on the subsequent iteration; if it did not improve, the Damping Factor is increased.	Type: Variable Access: Read-Only
SolutionDampingRhoTolerance	The Rho value threshold for the Solution Damping algorithm. If the computed Rho value is greater than this threshold, then the Damping Factor is decreased on the next iteration, and for the Quadratic Damping algorithm, state update is scaled based on the computed Alpha value.	Type: Variable Access: Read/Write
SolutionEpoch	The epoch at which the State Update will be calculated and applied. If the SolutionEpochOption property is not set to "User Specified Epoch" then setting this has no affect, but reading will reflect the appropriate value in the data span.	Type: Variable Access: Read/Write Units: day
SolutionEpochOption	The options for the Solution Epoch.	Type: Variable Access: Read/Write
SpanEndEpoch	The epoch at the end of the span of the data to be processed. By default this epoch is taken from the last observation that is included in the buffer to be processed. If the user sets this property to a value less than the epoch of the last observation, it will constrain the data span, ignoring observations with an epoch after this value.	Type: Variable Access: Read/Write Units: day
SpanStartEpoch	The epoch at the start of the span of the data to be processed. By default this epoch is taken from the first observation that is included in the buffer to be processed. If the user sets this property to a value greater than the epoch of the first observation, it will constrain the data span, ignoring observations with an epoch prior to this value.	Type: Variable Access: Read/Write Units: day
StepSize	The maximum step size used when propagating the Covariance.	Type: Variable Access: Read/Write Units: s
ThrustEventsToModel	Array of Maneuver objects to be modeled as part of the propagation for the orbit determination process.	Type: Array of ODThrustEventModelingData Access: Read-Only
WeightedRMS	The weighted Root-Mean-Square (RMS) of the measurement residuals for the current iteration.	Type: Variable Access: Read-Only

Name	Description
AddObjectToProcess	Include the object in the Estimation process. Whether the object properties are Estimated, Considered, or Ignored is determined by the object's ProcessAction flags.
AddObservation	Adds a copy of the Observation to the BatchLeastSquaresOD Observations array.
AddThrustEventToSequence	Adds a ThrustEvent to the OD Estimation sequence, and associates it with a spacecraft to which the thrust event will be applied.
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.
GetPostUpdateResidualStatistics	Computes statistics on the list of Observations which are in the Observation Buffer. Returns the number of measurement types included in the Observation buffer.
GetPreUpdateResidualStatistics	Computes statistics on the list of Observations which are in the Observation Buffer. Returns the number of measurement types included in the Observation buffer.
GetProcessingStatus	Computes the total number of measurements that were Accepted, Rejected, or Not Processed for the list of Observations which are in the Observation Buffer. Returns the number of measurement types included in the Observation buffer.
GetPropertiesInStateVector	Gets the list of properties included in the state vector for the ODEstimation object.
Iterate	Perform at least one Iteration of the BatchLeastSquaresOD process.
LoadObservationData	Initializes the BatchLeastSquaresOD object by populating the Observations array with the observation data in all registered Tracking Data Files, propagating the a priori state and covariance to the solution epoch, and determining the solution epoch. The observation data loaded is subject to the data span constraints set in the BatchLeastSquaresOD object. Execution of this method is optional; if it is not executed prior to the Iterate method being called, Iterate will perform the same initialization functions.
PerformPostUpdateCalculations	Peforms Post-Update residual calculations after the State Update was completed by calling PerformStateUpdate. If Solution Damping is enabled, the previously computed state update may be modified by this method.
PerformStateUpdate	Peforms initialization, Pre-Update calculations, computes and then applies the State Update. No Post-Update calcuations, including Solution Damping, are performed.
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.
RegisterOrbitStateObservationGenerator	Register the specified trajectory observation generator with the OD estimator process.
RegisterTrackingDataFile	Register the specified tracking data file with the OD estimator process.
Reset	Reset the estimation process, closing out all associated tracking data files, and clearing out any observation buffers.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetAprioriCovariance	Sets the apriori covariance matrix for the estimation process. This must be called prior to starting the estimation process, and must match the dimension of the state vector.
SetAprioriSquareRootInformation	Sets the apriori square root information matrix for the estimation process. This must be called prior to starting the estimation process, and must match the dimension of the state vector.