file_reader#

kikuchipy.io.plugins.nordif.file_reader(filename: Union[str, Path], mmap_mode: Optional[str] = None, scan_size: Union[None, int, Tuple[int, ...]] = None, pattern_size: Optional[Tuple[int, ...]] = None, setting_file: Optional[str] = None, lazy: bool = False) → List[Dict][source]#

Read electron backscatter patterns from a NORDIF data file.

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

Parameters:

filename: File path to NORDIF data file.
mmap_mode: Memory map mode. If not given, "r" is used unless lazy=True, in which case "c" is used.
scan_size: Scan size in number of patterns in width and height.
pattern_size: Pattern size in detector pixels in width and height.
setting_file: File path to NORDIF setting file (default is Setting.txt in same directory as filename).
lazy: Open the data lazily without actually reading the data from disk until required. Allows opening arbitrary sized datasets. Default is False.

Returns: