erlab.io.plugins.ssrl52

Data loader for beamline 5-2 at SSRL.

Classes

class erlab.io.plugins.ssrl52.SSRL52Loader[source]

Bases: LoaderBase

generate_summary(data_dir, exclude_zap=False)[source]
identify(num, data_dir, zap=False)[source]
load_single(file_path)[source]
load_zap(identifier, data_dir)[source]
additional_attrs: ClassVar[dict] = {'configuration': 3, 'sample_workfunction': 4.5}

Additional attributes to be added to the data after loading.

aliases: Iterable[str] | None = ('ssrl52', 'bl5-2')

List of alternative names for the loader.

always_single: bool = True

If True, this indicates that all individual scans always lead to a single data file. No concatenation of data from multiple files will be performed.

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

Names of attributes (after renaming) that should be treated as coordinates.

Note

Although the data loader tries to preserve the original attributes, the attributes given here, both before and after renaming, will be removed from attrs for consistency.

name: str = 'ssrl'

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().

name_map: ClassVar[dict] = {'alpha': 'ThetaX', 'beta': ['ThetaY', 'YDeflection', 'DeflectionY'], 'chi': ['T', 't'], 'delta': ['A', 'a'], 'eV': 'Kinetic Energy', 'hv': ['BL_energy', 'BL_photon_energy'], 'sample_workfunction': 'WorkFunction', 'temp_sample': ['TB', 'sample_stage_temperature'], 'x': 'X', 'xi': ['F', 'f'], 'y': 'Y', 'z': 'Z'}

Dictionary that maps new coordinate or attribute names to original coordinate or attribute names. If there are multiple possible names for a single attribute, the value can be passed as an iterable.

skip_validate: bool = True

If True, validation checks will be skipped.