prepare_dictionary#

NormalizedCrossCorrelationMetric.prepare_dictionary(patterns: Union[ndarray, Array]) → Union[ndarray, Array][source]#

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

Patterns are prepared by:

  1. Setting the data type to dtype.

  2. Applying a signal mask if signal_mask is set.

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

Parameters:
patterns

Dictionary patterns.

Returns:
prepared_patterns

Prepared dictionary patterns.