from astropy.utils.decorators import deprecated
from numbers import Number
from jdaviz.core.events import SliceSelectSliceMessage, NewViewerMessage
from jdaviz.core.helpers import CubeConfigHelper
from jdaviz.configs.rampviz.plugins.viewers import RampvizImageView
__all__ = ['Rampviz']
_temporal_axis_names = ['group', 'groups']
[docs]
class Rampviz(CubeConfigHelper):
"""Rampviz Helper class"""
_default_configuration = 'rampviz'
_default_group_viewer_reference_name = "group-viewer"
_default_diff_viewer_reference_name = "diff-viewer"
_default_integration_viewer_reference_name = "integration-viewer"
_cube_viewer_default_label = _default_group_viewer_reference_name
_loaded_flux_cube = None
_cube_viewer_cls = RampvizImageView
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.cube_cache = {}
self.load = self._load
[docs]
@deprecated(since="4.5", alternative="load")
def load_data(self, data, data_label=None, **kwargs):
"""
Load and parse a data cube with Cubeviz.
(Note that only one cube may be loaded per Cubeviz instance.)
Parameters
----------
data : str, `~roman_datamodels.datamodels.DataModel`, `~astropy.nddata.NDDataArray` or ndarray
A string file path, Roman DataModel object pointing to the
data cube, an NDDataArray, or a Numpy array.
If plain array is given, axes order must be ``(x, y, z)``.
data_label : str or `None`
Data label to go with the given data. If not given,
one will be automatically generated.
**kwargs : dict
Extra keywords accepted by Jdaviz application-level parser.
""" # noqa
if data_label:
if not data_label.endswith('[DATA]'):
data_label += '[DATA]'
kwargs['data_label'] = data_label
try:
self._load(data, format='Ramp', **kwargs)
except Exception:
self._load(data, format='Image', **kwargs)
self._set_x_axis()
def _set_x_axis(self, msg={}):
group_viewer = self.app.get_viewer(self._default_group_viewer_reference_name)
ref_data = group_viewer.state.reference_data
if ref_data:
group_viewer.state.x_att = ref_data.id["Pixel Axis 0 [z]"]
group_viewer.state.y_att = ref_data.id["Pixel Axis 1 [y]"]
[docs]
@deprecated(since="4.5", alternative="viz.plugins['Ramp Slice'].value = group_index")
def select_group(self, group_index):
"""
Select the slice closest to the provided wavelength.
Parameters
----------
group_index : float
Group index to select in units of the x-axis of the integration.
The nearest group will be selected if "snap to slice" is enabled
in the slice plugin.
"""
if not isinstance(group_index, Number):
raise TypeError("group_index must be convertible to an integer")
if group_index < 0:
raise ValueError("group_index must be positive")
msg = SliceSelectSliceMessage(value=int(group_index), sender=self)
self.app.hub.broadcast(msg)
[docs]
def get_data(self, data_label=None, spatial_subset=None,
temporal_subset=None, cls=None, use_display_units=False):
"""
Returns data with name equal to ``data_label`` of type ``cls`` with subsets applied from
``temporal_subset``, if applicable.
Parameters
----------
data_label : str, optional
Provide a label to retrieve a specific data set from data_collection.
spatial_subset : str, 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.
temporal_subset : str, optional
cls : `~specutils.Spectrum`, `~astropy.nddata.CCDData`, optional
The type that data will be returned as.
Returns
-------
data : cls
Data is returned as type cls with subsets applied.
"""
return self._get_data(data_label=data_label, spatial_subset=spatial_subset,
temporal_subset=temporal_subset,
cls=cls, use_display_units=use_display_units)
[docs]
def create_image_viewer(self, viewer_name=None, data=None):
"""
Create a new image viewer.
Parameters
----------
viewer_name : str or `None`
Viewer name/ID to use. If `None`, it is auto-generated.
Returns
-------
viewer : `~jdaviz.configs.imviz.plugins.viewers.ImvizImageView`
Image viewer instance.
"""
from jdaviz.configs.rampviz.plugins.viewers import RampvizImageView
# Cannot assign data to real Data because it loads but it will
# not update checkbox in Data menu.
return self.app._on_new_viewer(
NewViewerMessage(RampvizImageView, data=None, sender=self.app),
vid=viewer_name, name=viewer_name)
