FilterSettings#
- class FilterSettings(initial_covariance: CovarianceMatrix, initial_deviation: ndarray | None = None, process_noise: ProcessNoiseSettings | List[ProcessNoiseSettings] | None = None, measurement_sigmas: Dict[str, ArrayWUnits | 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:
objectComprehensive 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
FilterODsubclass.- Parameters:
- initial_covarianceCovarianceMatrix
Initial covariance matrix \(P_0\).
- initial_deviationnp.ndarray, optional
Initial state deviation \(x_0\).
Nonemeans zero deviation.- process_noiseProcessNoiseSettings or list of ProcessNoiseSettings, optional
Process noise model configuration, one per noised body (see
body).Nonedisables process noise.- measurement_sigmasdict, optional
Measurement sigmas keyed by dataset name, as
ArrayWUnits(converted to the dataset’s units) or bare floats (taken to be in them already). The filter sets them once, at construction, on the model that builds each dataset, so they win over the sigma the model was built with andmodel.sigmareports them; a sigma set on the model later wins over them. Changing this dict after construction does nothing: useFilterOD.set_measurement_sigmas(). See that method for the rules on models that build several datasets.- covariance_analysisbool
If
True, run in covariance-analysis mode (no measurement updates). Defaults toFalse.- outputOutputSettings, optional
Output configuration. Defaults to all-default
OutputSettings.- editing_methodstr, optional
Measurement editing mode:
'lasso','lasso_all','chi2','chi2_all','kurtosis','kurtosis_all','date_range', or'interactive_date_range'.Nonedisables editing.'lasso','chi2'and'kurtosis'open one figure per dataset in sequence; the'_all'variants open them all at once, which is the usable option on remote/browser backends.- editing_datasetsstr or list, optional
Which datasets to edit:
None= all, a string = one by name, a list of strings = a specific subset.- editing_kwargsdict, optional
Extra keyword arguments forwarded to the editing method.
- Attributes:
covariance_analysisIf
True, run in covariance-analysis mode (no measurement updates).editing_datasetsWhich datasets to edit:
None= all, a single name string, or a list of dataset name strings.editing_kwargsExtra keyword arguments forwarded to the editing method.
editing_methodMeasurement editing mode.
initial_covarianceInitial covariance matrix \(P_0\).
initial_deviationInitial state deviation \(x_0\).
measurement_sigmasMeasurement sigmas by dataset name, set on the models at filter construction.
outputOutput configuration (
OutputSettings).process_noiseProcess noise model configuration (
ProcessNoiseSettings), or a list of them, one per noised body.
See also
scarabaeus.FilterODBase filter class that consumes this settings object.
scarabaeus.ProcessNoiseSettingsProcess noise model configuration.
scarabaeus.OutputSettingsControls what the solution stores and writes.
Notes
Pass a single
FilterSettingsinstance to anyFilterODsubclass constructor. Whenoutputis omitted, an all-defaultOutputSettingsis created automatically.- property covariance_analysis: bool#
If
True, run in covariance-analysis mode (no measurement updates).
- property editing_datasets: str | list | None#
Which datasets to edit:
None= all, a single name string, or a list of dataset name strings.
- 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', orNone.
- property initial_covariance: CovarianceMatrix#
Initial covariance matrix \(P_0\).
- property initial_deviation: ndarray | None#
Initial state deviation \(x_0\).
Nonemeans zero deviation.
- property measurement_sigmas: Dict[str, ArrayWUnits | float] | None#
Measurement sigmas by dataset name, set on the models at filter construction.
- property output: OutputSettings#
Output configuration (
OutputSettings). Always non-Noneafter construction — defaults to an all-defaultOutputSettings.
- property process_noise: ProcessNoiseSettings | List[ProcessNoiseSettings] | None#
Process noise model configuration (
ProcessNoiseSettings), or a list of them, one per noised body.