navlie.types.StateWithCovariance¶
- class navlie.types.StateWithCovariance(state: State, covariance: ndarray)¶
Bases:
objectA data container containing a
Stateobject and a covariance array. This class can be used as-is without inheritance.- Parameters:
state (State) – A state object, usually representing the mean of a distribution.
covariance (np.ndarray) – A square, symmetric covariance matrix associated with the state.
- Raises:
ValueError – If the covariance matrix is not square.
ValueError – If the covariance matrix does not correspond with the state degrees of freedom.
- state¶
state object
- Type:
- covariance¶
covariance associated with state
- Type:
- property stamp¶
- symmetrize()¶
Enforces symmetry of the covariance matrix.
- copy() → StateWithCovariance¶