Cubeviz

class jdaviz.configs.cubeviz.helper.Cubeviz(*args, **kwargs)

Bases: ImageConfigHelper, 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()	Return aperture photometry results, if any.
get_data([data_label, spatial_subset, ...])	Returns data with name equal to data_label of type cls with subsets applied from spatial_subset and/or spectral_subset using function if applicable.
load_data(data[, data_label, ...])	Load and parse a data cube with Cubeviz.
select_slice(slice)	Deprecated since version 3.9.
select_wavelength(wavelength)	Select the slice closest to the provided wavelength.

Attributes Documentation

specviz

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

Methods Documentation

get_aperture_photometry_results()

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, function=None, cls=None, use_display_units=False)

Returns data with name equal to data_label of type cls with subsets applied from spatial_subset and/or spectral_subset using function 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.

spectral_subsetstr, optional

Spectral subset applied to data.

function{True, False, ‘minimum’, ‘maximum’, ‘mean’, ‘median’, ‘sum’}, optional

Ignored if data_label does not point to cube-like data. If True, will collapse according to the current collapse function defined in the spectrum viewer. If provided as a string, the cube will be collapsed with the provided function. If False, None, or not passed, the entire cube will be returned (unless there are values for spatial_subset and spectral_subset).

clsSpectrum1D, CCDData, optional

The type that data will be returned as.

Returns:

datacls

Data is returned as type cls with subsets applied.

load_data(data, data_label=None, override_cube_limit=False, **kwargs)

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_slice(slice)

Deprecated since version 3.9: The select_slice function is deprecated and may be removed in a future version. Use select_wavelength instead.

Select a slice by index.

Parameters:

sliceint

Slice integer to select

select_wavelength(wavelength)

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.