5.2.4.1.6. eqcorrscan.utils.clustering.cross_chan_correlation

eqcorrscan.utils.clustering.cross_chan_correlation(st1, streams, shift_len=0.0, allow_individual_trace_shifts=True, xcorr_func='fftw', concurrency='concurrent', cores=1, **kwargs)[source]

Calculate cross-channel correlation.

Determine the cross-channel correlation between two streams of multichannel seismic data.

Parameters:

  • st1 (obspy.core.stream.Stream) – Stream one

  • streams (list) – Streams to compare to.

  • shift_len (float) – How many seconds for templates to shift

  • allow_individual_trace_shifts (bool) – Controls whether templates are shifted by shift_len in relation to the picks as a whole, or whether each trace can be shifted individually. Defaults to True.

  • xcorr_func (str, callable) – The method for performing correlations. Accepts either a string or callable. See eqcorrscan.utils.correlate.register_array_xcorr() for more details

  • concurrency (str) – Concurrency for xcorr-func.

  • cores (int) – Number of threads to parallel over

Returns:

cross channel correlation, float - normalized by number of channels. locations of maximums

Return type:

numpy.ndarray, numpy.ndarray

Note

If no matching channels were found then the coherance and index for that stream will be nan.