BandPassReconstructed#

class BandPassReconstructed(lowpass=None, highpass=None, sampling_rate=1, use_gaussian=True)[source]#

Generate Bandpass filter for reconstructions.

Examples

The following creates an instance of BandPassReconstructed

>>> from tme.filters import BandPassReconstructed
>>> bpf_instance = BandPassReconstructed(
>>>     lowpass=30,
>>>     sampling_rate=10
>>> )

We can use its call method to create filters of given shape

>>> import matplotlib.pyplot as plt
>>> ret = bpf_instance(shape=(50,50))

The data key of the returned dictionary contains the corresponding Fourier filter mask. The DC component is located at the origin.

>>> plt.imshow(ret["data"])
>>> plt.show()

Attributes

`BandPassReconstructed.highpass`	The highpass cutoff, defaults to None.
`BandPassReconstructed.lowpass`	The lowpass cutoff, defaults to None.
`BandPassReconstructed.sampling_rate`	The sampling rate, defaults to 1 Ångstrom / voxel.
`BandPassReconstructed.use_gaussian`	Whether to use Gaussian bandpass filter, defaults to True.

Methods

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