6.1.2. match_filter¶

Classes and functions for matched-filtering.

This is designed for large-scale, multi-paralleled detection, with moderate to large numbers (hundreds to a few thousands) of templates.

6.1.2.1. Object-oriented API¶

EQcorrscan’s matched-filter object oriented API is split into two halves, input (Template and Tribe objects) and output (Detection, Family and Party objects).

A Tribe is a collection of Templates.
A Family is a collection of Detections for a single Template.
A Party is a collection of Families for a collection of Templates (a Tribe).

These objects retain useful meta-data including the obspy Event associated with the Template, and how the Template was processed. A core aim of the object-oriented API is reproducibility, and we encourage first-time users to adopt this from the off.

The methods of Template and Tribe objects mirror each other and in general you are best-off working with Tribes . Both the Template and Tribe objects have detect methods, which allow you to conduct matched-filtering.

The Detection, Family and Party objects contain all the metadata needed to re-create your detections. Furthermore, the Family and Party objects have a lag_calc method for conducting cross-correlation phase-picking based on correlation with the Template.

Object	Purpose
Template	To contain the template waveform and meta-data used to create the template.
Tribe	A collection of multiple Templates. Use the detect method to run matched-filter detections!
Detection	Root of the detection object tree - contains information relevant to a single detection from a single template.
Family	Collection of detections for a single Template.
Party	Collection of Family objects.

6.1.2.2. Function-based API¶

6.1.2.2.1. core.match_filter.matched_filter¶

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)

6.1.2.2.1.1. Functions¶

match_filter Main matched-filter detection function.

6.1.2.2.2. core.match_filter.helpers¶

Helper functions for network matched-filter detection of seismic data.

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

6.1.2.2.2.1. Functions¶

`extract_from_stream`	Extract waveforms for a list of detections from a stream.
`normxcorr2`	Thin wrapper to eqcorrscan.utils.correlate functions.
`temporary_directory`	make a temporary directory, yeild its name, cleanup on exit