tardis.visualization.tools.lineid_plotter module

tardis.visualization.tools.lineid_plotter.lineid_plotter(ax, line_wavelengths, line_labels, spectrum_wavelengths, spectrum_data, style='top', plotter_kwargs=None, lineid_kwargs=None)[source]

Use the lineid_plot package to plot user specified lines on a plotter’s spectrum.

Parameters:
axmatplotlib.axes._subplots.AxesSubplot

Axes for which the spectral lines will be plotted.

line_wavelengthslist of float

Wavelength values of the lines to be plotted

line_labelslist of str

Labels to be used for the lines at the wavelength positions

spectrum_wavelengthsastropy.units.Quantity

Wavelengths of the spectrum where the lines will be plotted.

spectrum_dataastropy.units.Quantity

Fluxes or luminosity of the spectrum where the lines will be plotted.

style{‘top’, ‘inside’, ‘along’}, optional

Preset styles for the lines markers. (default: ‘top’) If ‘top’, the lines will be plotted above the top axes. If ‘inside’, the lines will be plotted inside the axes. If ‘along’, the lines will be plotted along the spectrum.

lineid_kwargsdict, optional

kwargs passed to the lineid_plot.plot_line_ids method, by default None

Returns:
ax: matplotlib.axes._subplots.AxesSubplot

the original ax with the line markers plotted