MomentMap#

class jdaviz.configs.cubeviz.plugins.moment_maps.moment_maps.MomentMap(*args, **kwargs)[source]#

Bases: PluginTemplateMixin, DatasetSelectMixin, SpectralSubsetSelectMixin, SpectralContinuumMixin, AddResultsMixin

See the Moment Maps Plugin Documentation for more details.

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

  • show()

  • open_in_tray()

  • close_in_tray()

  • dataset (DatasetSelect): Dataset to use for computing line statistics.

  • spectral_subset (SubsetSelect): Subset to use for the line, or Entire Spectrum.

  • continuum (SubsetSelect): Subset to use for the continuum, or None to skip continuum subtraction, or Surrounding to use a region surrounding the subset set in spectral_subset.

  • continuum_dataset (DatasetSelect): Dataset of the extracted 1D spectrum to use when visualizing the continuum. The continuum will be redetermined based on the input cube (dataset) when computing the moment map.

  • continuum_width: Width, relative to the overall line spectral region, to fit the linear continuum (excluding the region containing the line). If 1, will use endpoints within line region only.

  • n_moment

  • output_unit Choice of “Wavelength” or “Velocity”, applicable for n_moment >= 1.

  • reference_wavelength Reference wavelength for conversion of output to velocity units.

  • add_results (AddResults)

  • calculate_moment()

Public constructor

Attributes Summary

continuum_dataset_items

An instance of a Python list.

continuum_dataset_selected

A trait for unicode strings.

dataset_spectral_unit

A trait for unicode strings.

export_enabled

A boolean (True, False) trait.

filename

A trait for unicode strings.

moment_available

A boolean (True, False) trait.

moment_zero_unit

n_moment

Mixin to handle empty integer field.

output_radio_items

An instance of a Python list.

output_unit_items

An instance of a Python list.

output_unit_selected

A trait for unicode strings.

reference_wavelength

Mixin to handle empty floating point field.

slice_display_unit_name

spectral_unit_selected

template_file

user_api

uses_active_status

A boolean (True, False) trait.

Methods Summary

calculate_moment([add_data])

Calculate the moment map

vue_calculate_moment(*args)

vue_overwrite_fits(*args)

Attempt to force writing the moment map if the user confirms the desire to overwrite.

Attributes Documentation

continuum_dataset_items#

An instance of a Python list.

continuum_dataset_selected#

A trait for unicode strings.

dataset_spectral_unit#

A trait for unicode strings.

export_enabled#

A boolean (True, False) trait.

filename#

A trait for unicode strings.

moment_available#

A boolean (True, False) trait.

moment_zero_unit#
n_moment#

Mixin to handle empty integer field.

output_radio_items#

An instance of a Python list.

output_unit_items#

An instance of a Python list.

output_unit_selected#

A trait for unicode strings.

reference_wavelength#

Mixin to handle empty floating point field.

slice_display_unit_name#
spectral_unit_selected#
template_file = ('/home/docs/checkouts/readthedocs.org/user_builds/jdaviz/envs/latest/lib/python3.11/site-packages/jdaviz/configs/cubeviz/plugins/moment_maps/moment_maps.py', 'moment_maps.vue')#
user_api#
uses_active_status#

A boolean (True, False) trait.

Methods Documentation

calculate_moment(add_data=True)[source]#

Calculate the moment map

Parameters:
add_databool

Whether to add the resulting data object to the app according to add_results.

vue_calculate_moment(*args)[source]#
vue_overwrite_fits(*args)[source]#

Attempt to force writing the moment map if the user confirms the desire to overwrite.