feature_calculators.FeatureParams
feature_calculators.FeatureParams(lf=None, csd=None, waveforms=None)Typed per-feature parameters forwarded to compute_features_from_raw.
The engine reads these attributes duck-typed (via getattr) so that feature_computation never imports this package (avoids a circular import). A sub-config left as None falls back to the engine’s default behavior for that family, so the default FeatureParams() reproduces today’s output.
Attributes: lf (LfParams | None): LF feature-family parameters. csd (CsdParams | None): CSD feature-family parameters. waveforms (WaveformParams | None): Waveforms/spike feature-family parameters (e.g. dartsort n_jobs).
Methods
| Name | Description |
|---|---|
| from_dict | Build FeatureParams from a nested dict, e.g. {"csd": {"scale": False}}. |
from_dict
feature_calculators.FeatureParams.from_dict(data)Build FeatureParams from a nested dict, e.g. {"csd": {"scale": False}}.
Each family value may be a params dict or an already-built LfParams/CsdParams. Unknown family names or sub-parameters raise, so a typo fails loudly instead of being silently ignored.
Args: data (Mapping): Mapping of feature family -> params dict/object.
Returns: FeatureParams: The typed, validated equivalent.
Raises: ValueError: If a key is not a recognized feature family. TypeError: If a family dict contains an unknown sub-parameter.