file_reader#

kikuchipy.io.plugins.ebsdsim_master_pattern.file_reader(filename: str | Path, hemisphere: Literal['upper', 'lower', 'both'] = 'upper', lazy: bool = False) → list[dict][source]#

Read an ebsdsim EBSD master pattern from a NumPy .npz file.

Not meant to be used directly; use load().

Parameters:

filename: Path to the .npz file written by ebsdsim.save_master_pattern().
hemisphere: Which hemisphere to return: “upper” (default), “lower”, or “both”.
lazy: Not supported; included for API compatibility. Data are always loaded eagerly.

Returns:

signal_dict_list: Data, axes, metadata, original metadata, and a phase dict.

Notes

This function carries a BSD 3-Clause license.