plotter package

Define the object that will take care of plotting the data.

class PandasPlotter(*args, gui=False, **kwargs)

Bases: Plotter

A Plotter using pandas lib.

Instantiate object.

Parameters:

gui (bool, default: False) – Activates interactive plotting if using GUI.

plot_emission_angle_distribution(df, *args, axes=None, population=None, **kwargs)

Plot the given emission angles distribution, return Axes object.

Return type:

Axes

plot_emission_energy_distribution(df, *args, axes=None, population=None, **kwargs)

Plot EmissionEnergyDistribution data with pandas.DataFrame.plot() method.

Parameters:

  • df (DataFrame) – Dataframe holding data to plot.

  • *args – Additional arguments passed to the pandas.DataFrame.plot() method.

  • axes (Axes | None, default: None) – Axes to re-use if given.

  • population (Literal['SE', 'EBE', 'IBE', 'all'] | None, default: None) – Type of population currently plotted. This is used to make the plot legends more precise.

  • kwargs – Additional keyword arguments passed to the pandas.DataFrame.plot() method.

Return type:

Axes

plot_emission_yield(df, *args, axes=None, population=None, **kwargs)

Plot EmissionYield data with pandas.DataFrame.plot() method.

Parameters:

  • df (DataFrame) – Dataframe holding data to plot.

  • *args – Additional arguments passed to the pandas.DataFrame.plot() method.

  • axes (Axes | None, default: None) – Axes to re-use if given.

  • population (Literal['SE', 'EBE', 'IBE', 'all'] | None, default: None) – Type of population currently plotted. This is used to make the plot legends more precise.

  • kwargs – Additional keyword arguments passed to the pandas.DataFrame.plot() method.

Return type:

Axes

Submodules