helper module

Define some helper functions.

explicit_column_names(columns: Sequence[str], population: Literal['SE', 'EBE', 'IBE', 'all'] | None = None, emission_data_type: Literal['Emission Yield', 'Emission Energy', 'Emission Angle'] | None = None) → dict[str, str]

Explicit column names for the plot.

This is used to have clearer legends in the plot.

Parameters:

• columns – Columns of the data frame to be plotted.

• population – Type of emitted electrons in data frame.

• emission_data_type – Type of data stored in data frame.

Returns:

Mapping to easily rename the data frame.

Return type:

dict[str, str]