xrheed.loaders

RHEED Data Loader

Provides a unified API to load RHEED images either via plugins or manually.

Functions

load_data(path[, plugin, ...])

Load a RHEED image (or a stack of images) using either a plugin or manual parameters.
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