ComposableFilter

class ComposableFilter

Bases: ABC

Base class for composable filters.

This class provides a standard interface for filters used in template matching and reconstruction. It automatically handles:

• Parameter merging between instance attributes and runtime arguments

• Fourier space shifting when needed

• Real Fourier transform cropping for efficiency

• Standardized result dictionary formatting

Subclasses need to implement ComposableFilter._evaluate() which contains the core filter computation logic.

By default, all filters are assumed to be multiplicative in Fourier space, which covers the vast majority of use cases (bandpass, CTF, wedge, whitening, etc.). Only explicitly specify non-multiplicative behavior when needed.

Methods

ComposableFilter.__call__([return_real_fourier])

This method provides the standard interface for creating of composable filter masks.