CrossDispersionProfile

class jdaviz.configs.specviz2d.plugins.cross_dispersion_profile.cross_dispersion_profile.CrossDispersionProfile(*args, **kwargs)

Bases: PluginTemplateMixin, PlotMixin

The Cross Dispersion Profile plugin allows for visualizaion of the cross-dispersion profile of 2d spectra, at a specified wavelength / pixel and window.

The following attributes and methods are available through the public plugin API:

• show()

• open_in_tray()

• close_in_tray()

• measure_cross_dispersion_profile()

• dataset (DatasetSelect):

  Dataset used to calculate and plot cross-dispersion profile.

• pixel

  Pixel on spectral axis used to compute and plot profile.

• y_pixel

  Center of profile on cross-dispersion axis.

• use_full_width

  If true, full cross-dispersion axis will be used to compute the profile.

• width

  If use_full_with is False, this value will set the size of the window for the profile on the cross-dispersion axis, centered at y_pixel.

• profile

  Computed profile, as a Quantity array.

Public constructor

Attributes Summary

dataset_items	An instance of a Python list.
dataset_selected	A trait for unicode strings.
flux_display_unit	A trait for unicode strings.
marks	Access the marks created by this plugin in the spectrum-2d-viewer.
marks_viewers1d
marks_viewers2d
max_pix	An int trait.
max_y_pix	An int trait.
pixel	An int trait.
plot_available	A boolean (True, False) trait.
profile
sa_display_unit	A trait for unicode strings.
setting_defaults	A boolean (True, False) trait.
template_file
update_plot
use_full_width	A boolean (True, False) trait.
user_api
uses_active_status	A boolean (True, False) trait.
wav	A float trait.
width	An int trait.
y_pixel	An int trait.

Methods Summary

measure_cross_dispersion_profile([update_plot])

Measure the cross-dispersion profile and update plugin plot.

Attributes Documentation

dataset_items

An instance of a Python list.

dataset_selected

A trait for unicode strings.

flux_display_unit

A trait for unicode strings.

marks

Access the marks created by this plugin in the spectrum-2d-viewer.

marks_viewers1d

marks_viewers2d

max_pix

An int trait.

max_y_pix

An int trait.

pixel

An int trait.

plot_available

A boolean (True, False) trait.

profile

sa_display_unit

A trait for unicode strings.

setting_defaults

A boolean (True, False) trait.

template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/3978/lib/python3.11/site-packages/jdaviz/configs/specviz2d/plugins/cross_dispersion_profile/cross_dispersion_profile.py', 'cross_dispersion_profile.vue')

update_plot

use_full_width

A boolean (True, False) trait.

user_api

uses_active_status

A boolean (True, False) trait.

wav

A float trait.

width

An int trait.

y_pixel

An int trait.

Methods Documentation

measure_cross_dispersion_profile(update_plot=True)

Measure the cross-dispersion profile and update plugin plot.

Calculates the cross-dispersion profile for the currently selected dataset at column pixel. If use_full_width is True, the profile is computed over the entire detector width, otherwise, a user-defined width and center y_pixel are used. The profile is returned and plotted in the app-wide flux display unit, as set in the Unit Conversion plugin. If update_plot is True, the plugin plot will be updated with the computed profile.

Parameters:

update_plotbool, optional

If True, update the plugin plot with the profile (default True).

Returns:

profilearray-like

The computed cross-dispersion profile.