correlate(a, v, mode='valid', propagate_mask=True)

Parameters

a, v : array_like

Input sequences.

mode : {'valid', 'same', 'full'}, optional

Refer to the :None:None:`np.convolve` docstring. Note that the default is 'valid', unlike convolve , which uses 'full'.

propagate_mask : bool

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

out : MaskedArray

Discrete cross-correlation of a and v.

Cross-correlation of two 1-dimensional sequences.

See Also

numpy.correlate

Equivalent function in the top-level NumPy module.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

GitHub : /numpy/ma/core.py#7688
type: <class 'function'>
Commit: