pylbo.visualisation.spectra.spectrum_comparison

Classes

SpectrumComparisonPlot

Subclass to compare two spectra.

Module Contents

class pylbo.visualisation.spectra.spectrum_comparison.SpectrumComparisonPlot(ds1, ds2, figsize, custom_figure, lock_zoom, use_residuals, **kwargs)

Bases: pylbo.visualisation.spectra.spectrum_figure.SpectrumFigure

Subclass to compare two spectra.

Parameters:
  • ds1 (LegolasDataSet) – First dataset, will be placed on the left side.

  • ds2 (LegolasDataSet) – Second dataset for comparison, will be placed on the right side.

  • figsize (tuple) – Figure size used when creating a window, analogous to matplotlib.

  • custom_figure (tuple) – The custom figure to use in the form (fig, axes).

  • lock_zoom (bool) – If True, locks the zoom for both spectrum plots.

  • use_residuals (bool) – If True, colors the spectrum points based on the residuals.

ax2

The (top)right axes object.

Type:

Axes

panel1

The spectrum instance associated with the left side.

Type:

SingleSpectrumPlot

panel2

The spectrum instance associated with the right side.

Type:

SingleSpectrumPlot

ax2
panel1
panel2
set_x_scaling(x_scaling)

Overloads parent method, calls x scaling setter for each panel.

Parameters:

x_scaling (int, float, complex, numpy.ndarray) – The scaling to apply to the x-axis

set_y_scaling(y_scaling)

Overloads parent method, calls y scaling setter for each panel.

Parameters:

y_scaling (int, float, complex, numpy.ndarray) – The scaling to apply to the y-axis

_use_custom_axes()

Splits the original 1x2 plot into a 2x2 plot.

add_spectrum() None

Adds the spectra for both datasets

add_eigenfunctions()

Adds the eigenfunctions for both datasets and merges the mpl callbacks.

add_continua(interactive=True)

Adds the continua for both datasets and merges the mpl callbacks.