OutputSettings#

class OutputSettings(save_prefit_residuals: bool = True, save_postfit_residuals: bool = True, save_covariance_history: bool = True, save_consider_covariance_history: bool = True, save_state_deviation_history: bool = True, save_kalman_gains: bool = False, save_innovation_covariances: bool = False, save_nis_statistics: bool = False, save_smoothed_solution: bool = True, solution_output_path: str | None = None, solution_output_name: str | None = 'solution', fdm_output_path: str | None = None, fdm_output_name: str | None = None, metadata: Dict | None = None)#

Bases: object

Configuration for SolutionOD output and storage.

Controls which quantities the filter stores after a run and where JSON and .npz output files are written. All flags default to sensible values; override only what you need.

Parameters:

  • save_prefit_residuals (bool) – Store prefit residuals in the solution. Defaults to True.

  • save_postfit_residuals (bool) – Store postfit residuals in the solution. Defaults to True.

  • save_covariance_history (bool) – Store covariance evolution across measurement epochs. Defaults to True.

  • save_consider_covariance_history (bool) – Store consider-parameter covariance evolution. Defaults to True.

  • save_state_deviation_history (bool) – Store state deviation history across measurement epochs. Defaults to True.

  • save_kalman_gains (bool) – Store Kalman gain matrices at each epoch (debugging). Defaults to False.

  • save_innovation_covariances (bool) – Store innovation covariance matrices at each epoch (debugging). Defaults to False.

  • save_nis_statistics (bool) – Store Normalized Innovation Squared (NIS) statistics. Defaults to False.

  • save_smoothed_solution (bool) – Run the RTS/Bierman smoother after the forward pass and store the smoothed solution. Defaults to True.

  • solution_output_path (str, optional) – Directory for the JSON solution file. None disables JSON output.

  • solution_output_name (str, optional) – Base filename (without extension) for the JSON solution file. Defaults to 'solution'.

  • fdm_output_path (str, optional) – Directory to write per-dataset .npz filter-data files. None disables .npz output.

  • fdm_output_name (str, optional) – Base name prefix for filter-data files.

  • metadata (dict, optional) – Arbitrary user metadata (version, producer, description, etc.).

Notes

All boolean flags default to sensible values for a standard OD run. Override only what you need; unset flags revert to their defaults when an instance is created with no arguments.

See also

scarabaeus.SolutionOD

OD result container that respects these settings.

scarabaeus.FilterSettings

Bundles this object with covariance and process noise.

Attributes:
fdm_output_name

Base name prefix for filter-data files.

fdm_output_path

Directory to write per-dataset .npz filter-data files.

metadata

Arbitrary user metadata (version, producer, description, etc.).

save_consider_covariance_history

Store consider-parameter covariance evolution.

save_covariance_history

Store covariance evolution across measurement epochs.

save_innovation_covariances

Store innovation covariance matrices at each epoch (debugging).

save_kalman_gains

Store Kalman gain matrices at each epoch (debugging).

save_nis_statistics

Store Normalized Innovation Squared (NIS) statistics.

save_postfit_residuals

Store postfit residuals in the solution.

save_prefit_residuals

Store prefit residuals in the solution.

save_smoothed_solution

If True, run the RTS/Bierman smoother after the forward pass and store the smoothed solution.

save_state_deviation_history

Store state deviation history across measurement epochs.

solution_output_name

Base filename (without extension) for the JSON solution file.

solution_output_path

Directory to save the JSON solution file.

property fdm_output_name: str | None#

Base name prefix for filter-data files. When set, files are named {fdm_output_name}_{set_name}.npz.

property fdm_output_path: str | None#

Directory to write per-dataset .npz filter-data files. None disables .npz output.

property metadata: Dict#

Arbitrary user metadata (version, producer, description, etc.).

property save_consider_covariance_history: bool#

Store consider-parameter covariance evolution. Defaults to True.

property save_covariance_history: bool#

Store covariance evolution across measurement epochs. Defaults to True.

property save_innovation_covariances: bool#

Store innovation covariance matrices at each epoch (debugging). Defaults to False.

property save_kalman_gains: bool#

Store Kalman gain matrices at each epoch (debugging). Defaults to False.

property save_nis_statistics: bool#

Store Normalized Innovation Squared (NIS) statistics. Defaults to False.

property save_postfit_residuals: bool#

Store postfit residuals in the solution. Defaults to True.

property save_prefit_residuals: bool#

Store prefit residuals in the solution. Defaults to True.

property save_smoothed_solution: bool#

If True, run the RTS/Bierman smoother after the forward pass and store the smoothed solution. Defaults to True.

property save_state_deviation_history: bool#

Store state deviation history across measurement epochs. Defaults to True.

property solution_output_name: str | None#

Base filename (without extension) for the JSON solution file.

property solution_output_path: str | None#

Directory to save the JSON solution file. None disables JSON output.