xrheed

xRHEED: An xarray-based toolkit for RHEED image analysis.

load_data(path, plugin=None, *, stack_dim=None, stack_coords=None, screen_scale=None, screen_center_sy_px=None, screen_center_sx_px=None, screen_sample_distance=None, beam_energy=None, alpha=None, beta=None, **kwargs)[source]

Load RHEED image data.

Parameters:

path – Path or paths to image files.
plugin – Name of a registered plugin (recommended). If None, manual loading is used.
stack_dim – Dimension name for stacking multiple images (plugin mode only).
stack_coords – Optional coordinate values for the stack dimension.

Returns:

Canonical RHEED DataArray.

Return type:

xr.DataArray

Submodules

`loaders`	RHEED data loading API.
`plugins`	Plugin system for RHEED data loading.
`preparation`	Submodule preparation provides functions for preprocessing RHEED images, including filters, normalization, and background subtraction.
`conversion`	Submodule conversion handles coordinate and unit conversions for RHEED images, e.g., transforming between pixel space and kx-ky space.
`kinematics`	Submodule kinematics provides tools for constructing 2D lattices and performing Ewald constructions.
`plotting`	Submodule plotting provides functions to visualize RHEED images and intensity profiles.
`xarray_accessors`	Xarray accessors for RHEED (Reflection High-Energy Electron Diffraction) data.