prepare_experimental#

NormalizedCrossCorrelationMetric.prepare_experimental(patterns: ndarray | Array) → ndarray | Array[source]#

Prepare experimental patterns before matching to dictionary patterns in match().

Patterns are prepared by:

  1. Setting the data type to dtype.

  2. Excluding the experimental patterns where navigation_mask is False if the mask is set.

  3. Reshaping to shape (n_experimental_patterns, -1)

  4. Applying a signal mask if signal_mask is set.

  5. Rechunking if rechunk is True.

  6. Normalizing to a mean of 0 and a standard deviation of 1.

Parameters:
patterns

Experimental patterns.

Returns:
prepared_patterns

Prepared experimental patterns.