erlab.io.plugins.kriss

Data loader for KRISS.

Classes

class erlab.io.plugins.kriss.KRISSLoader[source]

Bases: DA30Loader

name: str = 'kriss'

Name of the loader. Using a unique and descriptive name is recommended. For easy access, it is recommended to use a name that passes str.isidentifier().

Notes

  • Changing the name of a loader is not recommended as it may break existing code. Pick a simple, descriptive name that is unlikely to change.

  • Loaders with the name prefixed with an underscore are not registered.

description: str = 'KRISS ARPES-MBE'

A short description of the loader shown to users.

Added in version 3.3.0.

aliases: Iterable[str] | None = ('KRISS',)

Alternative names for the loader.

Deprecated since version 3.3.0: Accessing loaders with aliases is deprecated and will be removed in a future version. Use the loader name instead.

coordinate_attrs: tuple[str, ...] = ('beta', 'chi', 'xi', 'hv')

Attribute names (after renaming) that should be treated as coordinates.

Put any attributes that should be propagated when concatenating data here.

Notes

  • If a listed attribute is not found, it is silently skipped.

  • The attributes given here, both before and after renaming, are removed from the attributes to avoid conflicting values.

  • If an existing coordinate with the same name is already present, the existing coordinate takes precedence and the attribute is silently dropped.

See also

process_keys

additional_attrs: ClassVar[dict] = {'configuration': 4}

Additional attributes to be added to the data after loading.

If a callable is provided, it will be called with the data as the only argument.

Notes

  • The attributes are added after renaming with process_keys, so keys will appear in the data as provided.

  • If an attribute with the same name is already present in the data, it is skipped unless the key is listed in overridden_attrs.

property name_map