emission_data module

Define the base object that will store emission data.

Todo

Add an interpolate or resample method. Would be used to have more points, in particular when there is few points.

class EmissionData(population: Literal['SE', 'EBE', 'IBE', 'all'], data: DataFrame)

Bases: ABC

A yield, energy distribution or angular distribution.

__init__(population: Literal['SE', 'EBE', 'IBE', 'all'], data: DataFrame) → None

Instantiate the data.

Parameters:

  • population – The concerned population of electrons.

  • data – Structure holding the data. Column headers as well as units must follow specications (see subclasses documentation).

abstractmethod classmethod from_filepath(population: Literal['SE', 'EBE', 'IBE', 'all'], loader: Loader, *filepath: str | Path) → Self

Instantiate the data from files.

Parameters:

  • loader – The object that will load the data.

  • population – The concerned population of electrons.

  • *filepath – Path(s) to file holding data under study.

abstract property label: str

Print markdown info.

abstractmethod plot(plotter: Plotter, *args, axes: T | None = None, **kwargs) → T

Plot the contained data using plotter.

_abc_impl = <_abc._abc_data object>