FilterSettings#

class FilterSettings(initial_covariance: CovarianceMatrix, initial_deviation: ndarray | None = None, process_noise: ProcessNoiseSettings | None = None, measurement_sigmas: Dict[str, float] | None = None, covariance_analysis: bool = False, output: OutputSettings | None = None, editing_method: str | None = None, editing_datasets: str | list | None = None, editing_kwargs: Dict | None = None)#

Bases: object

Comprehensive filter configuration for orbit determination.

Bundles the initial covariance, optional process noise model, measurement noise overrides, output configuration, and measurement editing settings into a single object passed to any FilterOD subclass.

Parameters:

  • initial_covariance (CovarianceMatrix) – Initial covariance matrix \(P_0\).

  • initial_deviation (np.ndarray, optional) – Initial state deviation \(x_0\). None means zero deviation.

  • process_noise (ProcessNoiseSettings, optional) – Process noise model configuration. None disables process noise.

  • measurement_sigmas (dict, optional) – Sigma overrides for measurement noise, keyed by dataset name.

  • covariance_analysis (bool) – If True, run in covariance-analysis mode (no measurement updates). Defaults to False.

  • output (OutputSettings, optional) – Output configuration. Defaults to all-default OutputSettings.

  • editing_method (str, optional) – Measurement editing mode: 'lasso', 'chi2', 'date_range', or 'interactive_date_range'. None disables editing.

  • editing_datasets (str or list, optional) – Which datasets to edit: None = all, a string = one by name, a list of strings = a specific subset.

  • editing_kwargs (dict, optional) – Extra keyword arguments forwarded to the editing method.

Notes

Pass a single FilterSettings instance to any FilterOD subclass constructor. When output is omitted, an all-default OutputSettings is created automatically.

See also

scarabaeus.FilterOD

Base filter class that consumes this settings object.

scarabaeus.ProcessNoiseSettings

Process noise model configuration.

scarabaeus.OutputSettings

Controls what the solution stores and writes.

Attributes:
covariance_analysis

If True, run in covariance-analysis mode (no measurement updates).

editing_datasets

Which datasets to edit: None = all, a single name string, or a list of dataset name strings.

editing_kwargs

Extra keyword arguments forwarded to the editing method.

editing_method

Measurement editing mode.

initial_covariance

Initial covariance matrix \(P_0\).

initial_deviation

Initial state deviation \(x_0\).

measurement_sigmas

Measurement noise sigma overrides by dataset name.

output

Output configuration (OutputSettings).

process_noise

Process noise model configuration (ProcessNoiseSettings).

property covariance_analysis: bool#

If True, run in covariance-analysis mode (no measurement updates).

property editing_datasets: str | list | None#

None = all, a single name string, or a list of dataset name strings.

Type:

Which datasets to edit

property editing_kwargs: Dict | None#

Extra keyword arguments forwarded to the editing method. E.g. {"sigma_scale": 4.0} for 'chi2', or {"t_start": ..., "t_end": ..., "action": "flag"} for 'date_range'.

property editing_method: str | None#

Measurement editing mode. One of 'lasso', 'chi2', 'date_range', 'interactive_date_range', or None.

property initial_covariance: CovarianceMatrix#

Initial covariance matrix \(P_0\).

property initial_deviation: ndarray | None#

Initial state deviation \(x_0\). None means zero deviation.

property measurement_sigmas: Dict[str, float] | None#

Measurement noise sigma overrides by dataset name.

property output: OutputSettings#

Output configuration (OutputSettings). Always non-None after construction — defaults to an all-default OutputSettings.

property process_noise: ProcessNoiseSettings | None#

Process noise model configuration (ProcessNoiseSettings).