get_rgb_navigator#

kikuchipy.draw.get_rgb_navigator(image: ndarray, dtype: str | dtype | type = 'uint16') → Signal2D[source]#

Create an RGB navigator signal which is suitable to pass to plot() as the navigator parameter.

Parameters:

image: RGB color image of shape (n rows, n columns, 3).
dtype: Which data type to cast the signal data to, either "uint16" (default) or "uint8". Must be a valid numpy.dtype identifier.

Returns:

s: Signal with an (n columns, n rows) signal shape and no navigation shape, of data type either rgb8 or rgb16.