Skip to main content

Python implementation of the A.Lomax Filter Picker

Project description

Filter Picker

=========================

  • AUTHOR: Matteo Bagagli
  • VERSION: 1.0.3
  • DATE: 10/2019

FilterPicker is a general purpose, broad-band, phase detector and picker which is applicable to real-time seismic monitoring and earthquake early-warning. This module is a Python implementation of the A.Lomax Filter Picker. Inspiration has been taken from the MATLAB implementation[3] of Y.Kamer. This picker class has been rewritten using NumPy libraries.

For a full reference of usage/method the reader is referenced to the main author paper [1][2]

Installation

Recently the package has been uploaded in PyPi repository, therefore you could just type:

pip install filterpicker

and be ready to go.

If you want to install the library manually or just being updated to the latest patches, the installation is pretty easy because the package comes with an installer. All the dependencies are explained in the requirements.txt file. It's suggested to use a virtual environment (conda or pipenv)

Just open a terminal and type

$ git clone https://github.com/billy4all/filterpicker /somwhere/in/my/pc
$ cd where/you/cloned
$ # optionally activate your virtual env
$ pip install .

Tests

To run a simple test to make sure you're ready to go, just type:

$ cd where/the/package/is
$ pytest

You can also double check the performance of the software by running the scripts in the example folder (manual installation) or run the command-line exec store obspy_script (PyPI). The module is fully compatible with the famous ObsPy library: just fed the picker with the trace data (obspy.core.Trace.data numpy array).

For any issues/bug reports, please send an email to: matteo.bagagli@erdw.ethz.ch

Enjoy ^-^

References

[1] 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.

[2] Vassallo, M., C. Satriano and A. Lomax, (2012), Automatic picker developments and optimization: A strategy for improving the performances of automatic phase pickers, Seism. Res. Lett. , 83, 541-554, doi: 10.1785/gssrl.83.3.541.

[3] MATLAB packagehttps://ch.mathworks.com/matlabcentral/fileexchange/69211-filterpicker-a-robust-broadband-phase-detector-and-picker

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for filterpicker, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size filterpicker-1.0.3-py3-none-any.whl (8.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size filterpicker-1.0.3.tar.gz (15.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page