file_reader#

kikuchipy.io.plugins.oxford_binary.file_reader(filename: str | Path, lazy: bool = False) → List[dict][source]#

Read EBSD patterns from an Oxford Instruments’ binary .ebsp file.

Only uncompressed patterns can be read. If only non-indexed patterns are stored in the file, the navigation shape will be 1D.

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

Parameters:
filename

File path to .ebsp file.

lazy

Read the data lazily without actually reading the data from disk until required. Default is False.

Returns:
scan

Data, axes, metadata and original metadata.

Notes

Information about the .ebsp file format was generously provided by Oxford Instruments.