6.1.2.2.2.1.2. eqcorrscan.core.match_filter.helpers.normxcorr2

eqcorrscan.core.match_filter.helpers.normxcorr2(template, image)

Thin wrapper to eqcorrscan.utils.correlate functions.

Parameters:

• template (numpy.ndarray) – Template array

• image (numpy.ndarray) – Image to scan the template through. The order of these matters, if you put the template after the image you will get a reversed correlation matrix

Returns:

New numpy.ndarray of the correlation values for the correlation of the image with the template.

Return type:

numpy.ndarray

Note

If your data contain gaps these must be padded with zeros before using this function. The eqcorrscan.utils.pre_processing functions will provide gap-filled data in the appropriate format. Note that if you pad your data with zeros before filtering or resampling the gaps will not be all zeros after filtering. This will result in the calculation of spurious correlations in the gaps.