ess.amor.figures.wavelength_theta_figure#
- ess.amor.figures.wavelength_theta_figure(da, *, wavelength_bins=None, theta_bins=None, q_edges_to_display=(), linewidth=1.0, **kwargs)[source]#
Creates a figure displaying a histogram over \(\theta\) and \(\lambda\).
The input can either be a single data array containing the data to display, or a sequence of data arrays.
The inputs must either have coordinates called “theta” and “wavelength”, or they must be histograms with dimensions “theta” and “wavelength”.
If
wavelength_bins
ortheta_bins
are provided, they are used to construct the histogram. If not provided, the function uses the bin edges that already exist on the data arrays.If
q_edges_to_display
is provided, lines will be drawn in the figure corresponding to \(Q\) equal to the values inq_edges_to_display
.- Parameters:
da (
array
orsequence
ofarrays
) – Data arrays to display.wavelength_bins (
array-like
, optional) – Bins used to histogram the data in wavelength.theta_bins (
array-like
, optional) – Bins used to histogram the data in theta.q_edges_to_display (
sequence
offloat
, optional) – Values of \(Q\) to be displayed as straight lines in the figure.linewidth (
float
, optional) – Thickness of the displayed \(Q\) lines.**kwargs (
keyword arguments
, optional) – Additional parameters passed to the histogram plot function, used to customize colors, etc.
- Returns:
A Plopp figure displaying the histogram.