eegdash.features.inspect

Feature Bank Inspection and Discovery.

This module provides utilities for introspecting the feature extraction registry. It allows users and system components to discover available features, identify their kinds, and traverse the preprocessing dependency graph.

The module provides the following utilities:

• get_all_features() — Lists all final feature functions.

• get_all_feature_preprocessors() — Lists all available preprocessing steps.

• get_feature_kind() — Identifies the dimensionality of a feature.

• get_feature_predecessors() — Traces the dependency lineage of a feature.

• get_all_feature_kinds() — Lists all valid feature categories.

Functions

get_all_feature_preprocessors()	Get a list of all available preprocessor functions.
get_all_feature_kinds()	Get a list of all available feature 'kind' classes.
get_all_features()	Get a list of all available feature functions.
get_all_preprocessor_output_types()	Get a list of all available preprocessor output type classes.
get_feature_kind(feature)	Get the 'kind' of a feature function.
get_feature_predecessors(feature_or_extractor)	Get the dependency hierarchy for a feature or feature extractor.

eegdash.features.inspect.get_all_feature_preprocessors() → list[tuple[str, Callable]]

Get a list of all available preprocessor functions.

Scans the feature_bank module for all functions that participate in the dependency graph but do not produce final features (e.g., lack a feature_kind).

Returns:

A list of (name, function) tuples for all discovered feature preprocessors.

Return type:

list of tuple

eegdash.features.inspect.get_all_feature_kinds() → list[tuple[str, type[TypeAliasForwardRef('eegdash.features.extractors.MultivariateFeature')]]]

Get a list of all available feature ‘kind’ classes.

Scans the kinds module for all classes that subclass MultivariateFeature.

Returns:

A list of (name, class) tuples for all discovered feature kinds.

Return type:

list of tuple

eegdash.features.inspect.get_all_features() → list[tuple[str, Callable]]

Get a list of all available feature functions.

Scans the feature_bank module for functions that have been decorated with a feature_kind.

Returns:

A list of (name, function) tuples for all discovered feature functions.

Return type:

list of tuple

eegdash.features.inspect.get_all_preprocessor_output_types() → list[tuple[str, type[BasePreprocessorOutputType]]]

Get a list of all available preprocessor output type classes.

Scans the feature_bank module for all classes that subclass BasePreprocessorOutputType.

Returns:

A list of (name, class) tuples for all discovered preprocessor output types.

Return type:

list of tuple

eegdash.features.inspect.get_feature_kind(feature: Callable) → eegdash.features.extractors.MultivariateFeature

Get the ‘kind’ of a feature function.

Identifies whether a feature is univariate, bivariate, or multivariate using decorators.

Parameters:

feature (callable) – The feature function to inspect.

Returns:

An instance of the feature kind.

Return type:

MultivariateFeature

eegdash.features.inspect.get_feature_predecessors(feature_or_extractor: Callable | None) → list

Get the dependency hierarchy for a feature or feature extractor.

This function recursively traverses the parent_extractor_type attribute of a feature or extractor to build a list representing its dependency lineage.

Parameters:

feature_or_extractor (callable) – The feature function or FeatureExtractor instance to inspect.

Returns:

A nested list representing the dependency tree. For a simple linear chain, this will be a flat list from the specific feature up to the base signal input. For multiple dependencies, it contains tuples of sub-dependencies.

Return type:

list

Notes

The traversal stops when it reaches a predecessor of None, which typically represents the raw signal.

Examples

>>> # Example: Linear dependency with a branching dependency
>>> print(get_feature_predecessors(feature_bank.spectral_entropy))
    [<function spectral_entropy at 0x...>,
    <function spectral_normalized_preprocessor at 0x...>,
    <function spectral_preprocessor at 0x...>,
    (None, [<function signal_hilbert_preprocessor at 0x...>, None])]