5.5.1.3. eqcorrscan.utils.correlate.multichannel_normxcorr

eqcorrscan.utils.correlate.multichannel_normxcorr(templates, stream, cores=1, time_domain=False, openmp=False, numpy=False)[source]

Cross-correlate multiple channels either in parallel or not

Parameters:
  • templates (list) A list of templates, where each one should be an obspy.Stream object containing multiple traces of seismic data and the relevant header information.
  • stream (obspy.core.stream.Stream) A single Stream object to be correlated with the templates.
  • cores (int) Number of processes to use, if set to None, no Python multiprocessing will be done.
  • cores Number of cores to loop over
  • time_domain (bool) Whether to compute in the time-domain using the compiled openMP parallel cross-correlation routine.
  • openmp (bool) Whether to use the openmp, compiled threaded loop or not.
  • scipy (bool) Whether to use the numpy routine or not.
Returns:

New list of numpy.ndarray objects. These will contain the correlation sums for each template for this day of data.
Return type:

list
Returns:

list of ints as number of channels used for each cross-correlation.
Return type:

list
Returns:

list of list of tuples of station, channel for all cross-correlations.
Return type:

list

Note

Each template must contain the same channels as every other template, the stream must also contain the same channels (note that if there are duplicate channels in the template you do not need duplicate channels in the stream).