Compose.__call__#

Compose.__call__(return_real_fourier=False, **kwargs)[source]#

Apply the sequence of filters in order, chaining their outputs.

Parameters:
return_real_fourierbool, optional

Whether to crop the filter mask for compatibility with real input FFTs (i.e., numpy.fft.rfft()). When True, only the positive frequency components are returned, reducing memory usage and computation time for real-valued inputs. Default is False.

**kwargsdict

Keyword arguments passed to the first filter and propagated through the pipeline.

Returns:
Dict

Result dictionary from the final filter in the composition, containing:

  • dataBackendArray

    The final composite filter data. For multiplicative filters, this is the element-wise product of all individual filter outputs.

  • shapetuple of int

    Shape of the filter data

  • return_real_fourierbool

    Whether the output is compatible with real FFTs

  • Additional metadata from the filter pipeline