filterpicker package

Subpackages

Submodules

filterpicker.filterpicker module

class filterpicker.filterpicker.FilterPicker(dt, data, filter_window=3.0, longterm_window=5.0, t_up=0.2, threshold_1=10, threshold_2=10, base=2)[source]

Bases: object

Main Class for the FilterPicker algorithm

Implementation of A.Lomax FilterPicker in Python language. Support available for Python >= 3.5

At the moment the picker works on the entire trace, not suitable for online picking. Support will be given soon …

Parameters

  • dt (int, float) – is the sampling time-delta for the given array in seconds.

  • data (list, tuple, np.array) – is the actual time-series array. It must contain only numbers.

  • filter_window (int, float) – picker’s parameter

  • longterm_window (int, float) – picker’s parameter

  • t_up (int, float) – picker’s parameter

  • threshold_1 (int, float) – picker’s parameter

  • threshold_2 (int, float) – picker’s parameter

  • base (int) – picker’s parameter

For an exhaustive description of the picker’s parameters the reader is referred to the reference paper

References

Lomax, A., C. Satriano and M. Vassallo (2012), Automatic picker

developments and optimization: FilterPicker - a robust, broadband picker for real-time seismic monitoring and earthquake early-warning, Seism. Res. Lett. , 83, 531-540, doi: [10.1785/gssrl.83.3.531](10.1785/gssrl.83.3.531)

get_bands()[source]

Returns the carachteristic function of each band

get_evaluation_function()[source]

Returns the carachteristic functions where picks are triggered.

plot(show=True, fp_param_title=True, fig_title=None)[source]

Main picker’s plot routine. Create a comprehensive figure of the different CFs and picks. If show=True the fgire is displayed realtime.

Optionals:

show (bool): if True, the figure will be displayed at run time fp_param_title (bool): if True, the figure’s title will be composed with the picking parameters value adopted fig_title (str): default to None. If a string is given, that will be the figure’s title.

Returns

fig (plt.figure): figure’s handle axLst (list): list of plot axis handles

run()[source]

Main method for picking

Orchestrator of the picker, calls in sequence the needed functions.

Returns

the time-series indexes of picks pickUNC (list): the time-series indexes of picks pickFRQ (list): the frequency band where it was triggered

Return type

pickIDX (list)

Module contents