xrheed

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

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

Load a RHEED image (or a stack of images) using either a plugin or manual parameters.

Parameters:

  • path (str | Path | list[str|Path]) – File path (single image) or list of files (stacked images).

  • plugin (str, optional) – Name of plugin to use. If None, manual mode is assumed.

  • screen_sample_distance (float) – Required in manual mode.

  • screen_scale (float) – Required in manual mode.

  • beam_energy (float) – Required in manual mode.

  • screen_center_sx_px (int, optional) – Optional centers in px (default: image midpoints).

  • screen_center_sy_px (int, optional) – Optional centers in px (default: image midpoints).

  • alpha (float) – Optional angles.

  • beta (float) – Optional angles.

  • stack_dim (str, optional) – New dimension name when stacking multiple files.

  • stack_coords (array-like, optional) – Coordinates for the new dimension.

Returns:

Image data with coordinates and attributes.

Return type:

xarray.DataArray

Submodules

loaders

RHEED Data Loader

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.