`idstools.view.spectrometer_visible`¶

This module provides view functions and classes for spectrometer_visible ids data

Module Contents¶

class idstools.view.spectrometer_visible.SpectrometerVisibleView(ids_obj: object)[source]¶

This class provides view functions for spectrometer_visible ids

Initialization SpectrometerVisibleView object.

Parameters:¶

view_intensity(ax: matplotlib.pyplot.axes, spectro_index, logscale=False)[source]¶

The view_intensity function plots intensity of spectrom from multiple spectrometers.

Parameters:¶

ax: matplotlib.pyplot.axes¶: The parameter ax is a list of plt.axes objects. These objects represent the axes on which the intensity spectra will be plotted. The function view_intensity takes these axes as input and plots the intensity spectra on them.
spectro_index¶: The spectroIndex parameter represents the index of the spectrometer for which the intensity spectra will be plotted. It is used to select the appropriate channels from the spectrometers.

Returns:¶

a string variable named “filename”.

view_radiance(ax: matplotlib.pyplot.axes, spectro_index, logscale=False)[source]¶

The function view_radiance plots radiance data from multiple spectrometers on separate axes.

Parameters:¶

ax: matplotlib.pyplot.axes¶: The parameter ax is a list of plt.axes objects. These objects represent the axes on which the radiance data will be plotted. The function viewRadiance takes these axes as input and plots the radiance data on each of them.
spectro_index¶: The spectro_index parameter represents the index of the spectrometer for which the intensity spectra will be plotted. It is used to select the appropriate channels from the spectrometers.

Returns:¶

the value of the variable “filename”.

idstools.view.spectrometer_visible.LABEL_INTENSITY = "'Intensity (counts)'"¶

idstools.view.spectrometer_visible.LABEL_RADIANCE = "'Spectral Radiance (ph s^-1 m^-2 sr^-1 nm^-1)'"¶