xmap_from_hough_indexing_data#

kikuchipy.indexing.xmap_from_hough_indexing_data(data: ndarray, phase_list: PhaseList, data_index: int = -1, navigation_shape: tuple | None = None, step_sizes: tuple | None = None, scan_unit: str = 'px') → CrystalMap[source]#

Convert Hough indexing result array from pyebsdindex to a CrystalMap.

Parameters:
data

Array with the following data type field names: "quat", "phase", "fit", "cm", "pq" and "nmatch".

phase_list

List of phases. If data_index=-1, the phase IDs in the list must match the phase IDs in data[-1]["phase"]. If data_index is another ID, it must be in the phase list.

data_index

Index into data of which to return a crystal map from. Default is -1, which returns the most probable (best) solutions in each map point. Other options depend on the number of phases used in indexing, and starts with 0.

navigation_shape

Navigation shape of resulting map. If not given, a 1D crystal map is returned. Maximum of two dimensions.

step_sizes

Step sizes in each navigation direction. If not given, a step size of 1 is used in each direction.

scan_unit

Scan unit of map. If not given, it is not set.

Returns:
xmap

Crystal map.