xrheed.plugins

Plugin system for RHEED data loading.

Design principles: - Plugins describe how to load: pixels, optional metadata. - A single canonical constructor creates valid RHEED DataArrays. - File provenance is always attached automatically.

Functions

register_plugin(name)

Decorator to register a new plugin.

Classes

LoadRheedBase()

Base class for RHEED plugins.

class LoadRheedBase

Bases: ABC

Base class for RHEED plugins.

ATTRS = {}

TOLERATED_EXTENSIONS = {}

dataarray_from_image(image_np, *, file_path=None, attrs_override=None, flip=True)

Construct a canonical RHEED DataArray from an image.

Responsibilities: - merge default attrs with overrides - resolve geometry (including screen center) - construct sx / sy coordinates - attach file provenance automatically

is_file_accepted(file_path)

abstractmethod load_single_image(file_path, **kwargs)

Load a single image and return a canonical RHEED DataArray.

Implementations MUST call self.dataarray_from_image(…) exactly once and return its result.

register_plugin(name)

Decorator to register a new plugin.

Modules

dsnp_arpes_bmp
dsnp_arpes_raw
example_plugin_bmp