helper module

Define some helper functions.

explicit_column_names(columns, population=None, emission_data_type=None)

Explicit column names for the plot.

This is used to have clearer legends in the plot.

Parameters:
  • columns (Sequence[str]) – Columns of the data frame to be plotted.

  • population (Literal['SE', 'EBE', 'IBE', 'all'] | None, default: None) – Type of emitted electrons in data frame.

  • emission_data_type (Literal['Emission Yield', 'Emission Energy', 'Emission Angle'] | None, default: None) – Type of data stored in data frame.

Returns:

Mapping to easily rename the data frame.

Return type:

dict[str, str]