giant.image_processing.correlators.CORRLATOR_SIGNATURE

giant.image_processing.correlators.CORRLATOR_SIGNATURE

The call signature for a correlator function.

The inputs are image, template as NDArrays, and then should return a float64 double precision array with the correlation surface. The correlation surface should be returnd as the same size as the provided image such that the peak of the surface corresponds to aligning the middle of the temlate with that pixel.

alias of Callable[[ndarray[tuple[Any, …], dtype[_ScalarT]], ndarray[tuple[Any, …], dtype[_ScalarT]]], ndarray[tuple[Any, …], dtype[float64]]]