cupyx.scipy.signal.correlation_lags#

cupyx.scipy.signal.correlation_lags(in1_len, in2_len, mode='full')[source]#

Calculates the lag / displacement indices array for 1D cross-correlation.

Parameters:

  • in1_len (int) – First input size.

  • in2_len (int) – Second input size.

  • mode (str {'full', 'valid', 'same'}, optional) – A string indicating the size of the output. See the documentation correlate for more information.

Returns:

lags – Returns an array containing cross-correlation lag/displacement indices. Indices can be indexed with the np.argmax of the correlation to return the lag/displacement.

Return type:

array

See also

correlate

Compute the N-dimensional cross-correlation.

scipy.signal.correlation_lags