xrheed.loaders

RHEED data loading API.

This module provides a unified entry point for loading RHEED data.

Two loading modes are supported:

  1. Plugin-based loading (recommended) - supports single images and stacks - uses registered plugins - reproducible and metadata-driven

  2. Manual loading (beginner-friendly) - supports ONLY single-image loading - user provides geometry explicitly - still produces a canonical DataArray

Functions

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

Load RHEED image data.
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