ADCS.estimators.estimator_helpers.estimator_helpers module

class ADCS.estimators.estimator_helpers.estimator_helpers.EstimatedOrbital_State(os, P=<factory>, Q=<factory>)[source]

Bases: object

A container for an Orbital State and its associated estimation uncertainty.

This class wraps the physical Orbital_State with estimation statistics, specifically the state covariance \(P\) and process noise \(Q\).

Parameters:

  • os (Orbital_State) – The estimated physical state (Position \(\mathbf{r}\) and Velocity \(\mathbf{v}\)).

  • P (np.ndarray) – The \(6 \times 6\) state covariance matrix. .. math:: P = E[(hat{x} - x)(hat{x} - x)^T]

  • Q (np.ndarray) – The \(6 \times 6\) process noise covariance matrix.

copy()[source]

Creates a deep copy of the EstimatedOrbital_State.

Returns:

A new instance with deep-copied state and matrices.

Return type:

EstimatedOrbital_State

pull_indices(inds_mask, cov_missing_inds=None)[source]

Extracts a partial state estimate based on indices mapping to [R, V].

The mapping is linear: indices 0-2 correspond to Position (R), and 3-5 to Velocity (V).

Parameters:

  • inds_mask (list or np.ndarray) – The indices of the 6-element state vector to extract.

  • cov_missing_inds (list or np.ndarray, optional) – Indices to exclude from covariance slicing (optional).

Returns:

A new EstimatedOrbital_State containing the subset of state and covariance. Note: The underlying Orbital_State will have 0.0 in unselected components.

Return type:

EstimatedOrbital_State

set_indices(inds_mask, val, P, Q, cov_missing_inds=None)[source]

Inserts values and covariance blocks back into the full 6-state estimate.

Parameters:

  • inds_mask (list or np.ndarray) – Indices in the full 6-element vector where data should be inserted.

  • val (np.ndarray) – The values to insert into Position/Velocity.

  • P (np.ndarray) – The covariance block \(P_{sub}\) to insert.

  • Q (np.ndarray) – The process noise block \(Q_{sub}\) to insert.

  • cov_missing_inds (list or np.ndarray, optional) – Indices to exclude from covariance insertion (optional).

P: ndarray
Q: ndarray
os: Orbital_State