Cubeviz#

class jdaviz.configs.cubeviz.helper.Cubeviz(*args, **kwargs)[source]#

Bases: CubeConfigHelper, LineListMixin

Cubeviz Helper class

Attributes Summary

specviz

A Specviz helper (Specviz) for the Jdaviz application that is wrapped by Cubeviz.

Methods Summary

`get_aperture_photometry_results`()
`get_data`([data_label, spatial_subset, ...])	Returns data with name equal to `data_label` of type `cls` with subsets applied from `spectral_subset`, if applicable.
`load_data`(data[, data_label, ...])	Load and parse a data cube with Cubeviz.
`select_wavelength`(wavelength)

Attributes Documentation

specviz#: A Specviz helper (Specviz) for the Jdaviz application that is wrapped by Cubeviz.

Methods Documentation

get_aperture_photometry_results()[source]#

Deprecated since version 4.2: The get_aperture_photometry_results function is deprecated and may be removed in a future version. Use plugins[‘Aperture Photometry’].export_table() instead.

Return aperture photometry results, if any.: Results are calculated using Aperture Photometry plugin.

Returns:

resultsQTable or None: Photometry results if available or None otherwise.

get_data(data_label=None, spatial_subset=None, spectral_subset=None, cls=None, use_display_units=False)[source]#

Returns data with name equal to data_label of type cls with subsets applied from spectral_subset, if applicable.

Parameters:

data_labelstr, optional: Provide a label to retrieve a specific data set from data_collection.
spatial_subsetstr, optional: Spatial subset applied to data. Only applicable if data_label points to a cube or image. To extract a spectrum from a cube, use the spectral extraction plugin instead.
spectral_subsetstr, optional: Spectral subset applied to data.
clsSpectrum1D, CCDData, optional: The type that data will be returned as.
use_display_unitsbool, optional: Specify whether the returned data is in native units or the current display units.

Returns:

datacls: Data is returned as type cls with subsets applied.

load_data(data, data_label=None, override_cube_limit=False, **kwargs)[source]#

Load and parse a data cube with Cubeviz. (Note that only one cube may be loaded per Cubeviz instance.)

Parameters:

datastr, HDUList, Spectrum1D, or ndarray: A string file path, astropy FITS object pointing to the data cube, a spectrum object, or a Numpy array cube. If plain array is given, axes order must be (x, y, z).
data_labelstr or None: Data label to go with the given data. If not given, one will be automatically generated.
override_cube_limitbool: Override internal cube count limitation and load the data anyway. Setting this to True is not recommended unless you know what you are doing.
**kwargsdict: Extra keywords accepted by Jdaviz application-level parser.

select_wavelength(wavelength)[source]#

Deprecated since version 4.2: The select_wavelength function is deprecated and may be removed in a future version. Use plugins[‘Slice’].value instead.

Select the slice closest to the provided wavelength.

Parameters:

wavelengthfloat: Wavelength to select in units of the x-axis of the spectrum. The nearest slice will be selected if “snap to slice” is enabled in the slice plugin.