get_image_quality#
- kikuchipy.pattern.get_image_quality(pattern: ndarray, normalize: bool = True, frequency_vectors: ndarray | None = None, inertia_max: int | float | None = None) float [source]#
Return the image quality of an EBSD pattern.
The image quality is calculated based on the procedure defined by Krieger Lassen [Lassen, 1994].
- Parameters:
- pattern
EBSD pattern.
- normalize
Whether to normalize the pattern to a mean of zero and standard deviation of 1 before calculating the image quality (default is
True
).- frequency_vectors
Integer 2D array assigning each FFT spectrum frequency component a weight. If not given, these are calculated from
fft_frequency_vectors()
. This only depends on the pattern shape.- inertia_max
Maximum possible inertia of the FFT power spectrum of the image. If not given, this is calculated from the
frequency_vectors
, which in this case must be passed. This only depends on the pattern shape.
- Returns:
image_quality
Image quality of the pattern.