match_template_to_layer¶
- sunpy.image.coalignment.match_template_to_layer(layer, template)[source]¶
Deprecated since version 4.0: The match_template_to_layer function is deprecated and may be removed in version 4.1. Use
sunkit_image.coalignment.match_template_to_layer
instead.Calculate the correlation array that describes how well the template matches the layer. All inputs are assumed to be numpy arrays.
- Parameters
layer (
numpy.ndarray
) – A numpy array of size(ny, nx)
.template (
numpy.ndarray
) – A numpy array of size(N, M)
whereN < ny
andM < nx
.
- Returns
numpy.ndarray
– A correlation array between the layer and the template. The values in the array range between 0 and 1.