epymorph.parameter_fitting.filter.base_filter

This module defines the abstract base class for filters used in the application.

The BaseFilter class provides a template for creating various filter implementations with customizable parameters. Subclasses must implement the run method.

BaseFilter

BaseFilter(**kwargs: Any)

Bases: ABC

Abstract base class for filters.

Attributes:

• params (Dict[str, Any]) –

  Parameters for the filter.

Parameters:

• **kwargs (Any, default: {} ) –

  Arbitrary keyword arguments representing filter parameters.

params instance-attribute

params: Dict[str, Any] = kwargs

run abstractmethod

run(*args, **kwargs: Any) -> ParticleFilterOutput

Abstract method to run the filter. Must be implemented by subclasses.

Parameters:

• **kwargs (Any, default: {} ) –

  Arbitrary keyword arguments needed to run the filter.

Raises:

• NotImplementedError –

  If the method is not implemented by a subclass.