4.6.3. match_filter

See notes and warnings on correlations here: correlation_warnings

Functions for network matched-filter detection of seismic data.

Designed to cross-correlate templates generated by template_gen function with data and output the detections.

copyright:EQcorrscan developers.
license:GNU Lesser General Public License, Version 3 (https://www.gnu.org/copyleft/lesser.html) Functions

extract_from_stream Extract waveforms for a list of detections from a stream.
get_catalog Generate an obspy.core.event.Catalog from list of Detection’s.
match_filter Main matched-filter detection function.
normxcorr2 Thin wrapper to eqcorrscan.utils.correlate functions.
read_detections Read detections from a file to a list of Detection objects.
read_tribe Read a Tribe of templates from a tar archive.
read_party Read detections and metadata from a tar archive.
read_template Read a Template object from a tar archive.
write_catalog Write events contained within detections to a catalog file. Private Functions

_group_process Process data into chunks based on template processing length.
_group_detect Pre-process and compute detections for a group of templates.
_write_family Write a family to a csv file.
_read_family Internal function to read csv family files.
_total_microsec Calculate difference between two datetime stamps in microseconds.
_test_event_similarity Check the similarity of the components of obspy events, discounting resource IDs, which are not maintained in nordic files.