pygmi.mag.matchedfilt#

Matched filtering routine.

Classes#

MatchedFilt

Primary class for matched filtering.

Functions#

getbutter(lowcut, highcut, f[, order])

Create Butterworth bandpass filter.

Module Contents#

class pygmi.mag.matchedfilt.MatchedFilt(parent=None)#

Bases: pygmi.misc.BasicModule

Primary class for matched filtering.

Parameters:

parent (pygmi.main.MainWidget, optional) – Reference to the parent routine. The default is None.

self.mmc#

main canvas containing the image

Type:

FigureCanvas

setupui()#

Set up UI.

Return type:

None.

settings(nodialog=False)#

Entry point into item.

Parameters:

nodialog (bool, optional) – Run settings without a dialog. The default is False.

Returns:

True if successful, False otherwise.

Return type:

bool

calculate()#

Calculate matched filter.

fftprep()#

FFT preparation when choosing band.

saveproj()#

Save project data from class.

Return type:

None.

pygmi.mag.matchedfilt.getbutter(lowcut, highcut, f, order=5)#

Create Butterworth bandpass filter.

Parameters:
  • lowcut (list of floats) – Low cutoff frequencies.

  • highcut (list of floats) – High cutoff frequencies.

  • f (numpy array) – List of frequencies, ending in Nyquist frequency.

  • order (int) – Order of the filter. The default is 5.

Returns:

filt – List of 1D Butterworth filters.

Return type:

list