numpy.ma.correlate

ma.correlate(a, v, mode='valid', propagate_mask=True)[source]

Cross-correlation of two 1-dimensional sequences.

Parameters:

a, varray_like

Input sequences.

mode{‘valid’, ‘same’, ‘full’}, optional

Refer to the np.convolve docstring. Note that the default is ‘valid’, unlike convolve, which uses ‘full’.

propagate_maskbool

If True, then a result element is masked if any masked element contributes towards it. If False, then a result element is only masked if no non-masked element contribute towards it

Returns:

outMaskedArray

Discrete cross-correlation of a and v.

See also

numpy.correlate

Equivalent function in the top-level NumPy module.