loader module

Define the ABC for the Loader.

class Loader

Bases: ABC

Define the base class for loading various electron emission files.

Instantiate the object.

sep: str

Column separator. Not mandatory, but must be called sep in order to be recognized by the Parameters in the GUI.

comment: str

Comment character. Not mandatory, but must be called comment in order to be recognized by the Parameters in the GUI.

abstractmethod load_emission_yield(filepath, *args, **kwargs)

Load the given electron emission yield file.

Return type:

DataFrame

abstractmethod load_emission_energy_distribution(filepath, *args, **kwargs)

Load the given electron emission energy distribution file.

Should also try to load the energy of primary electrons from file metadata. If not possible, EmissionEnergyDistribution will try to infer it from the position of the EBEs peak.

Return type:

tuple[DataFrame, float | None]

abstractmethod load_emission_angle_distribution(filepath, *args, **kwargs)

Load the given electron emission angle distribution file.

Return type:

DataFrame