gerg_plotting.plotting_classes.histogram

Module Contents

class gerg_plotting.plotting_classes.histogram.Histogram

Bases: gerg_plotting.plotting_classes.plotter.Plotter

A class for plotting histograms from instrument data using matplotlib.

This class provides methods for creating 1D, 2D, and 3D histograms from data. Inherits from Plotter class for basic plotting functionality.

plot(var: str, fig=None, ax=None, **kwargs) → None

Plot a 1D histogram of the given variable.

Parameters

varstr

Name of the variable to plot

figmatplotlib.figure.Figure, optional

Figure object to use for plotting

axmatplotlib.axes.Axes, optional

Axes object to use for plotting

**kwargsdict

Additional keyword arguments passed to matplotlib.pyplot.hist

plot2d(x: str, y: str, fig=None, ax=None, **kwargs) → None

Plot a 2D histogram for the x and y variables.

Parameters

xstr

Name of the x-axis variable

ystr

Name of the y-axis variable

figmatplotlib.figure.Figure, optional

Figure object to use for plotting

axmatplotlib.axes.Axes, optional

Axes object to use for plotting

**kwargsdict

Additional keyword arguments passed to matplotlib.pyplot.hist2d

plot3d(x: str, y: str, fig=None, ax=None, **kwargs) → None

Plot a 3D surface plot based on a 2D histogram.

Parameters

xstr

Name of the x-axis variable

ystr

Name of the y-axis variable

figmatplotlib.figure.Figure, optional

Figure object to use for plotting

axmatplotlib.axes.Axes, optional

Axes object to use for plotting

**kwargsdict

Additional keyword arguments passed to numpy.histogram2d