Add option to get_data to apply spectral subset to collapse spatial

jdaviz/configs/cubeviz/helper.py

@@ -120,7 +120,8 @@ def specviz(self):
             self._specviz = Specviz(app=self.app)
         return self._specviz
 
-    def get_data(self, data_label=None, cls=None, subset_to_apply=None, function=None):
+    def get_data(self, data_label=None, cls=None, subset_to_apply=None, function=None,
+                 spectral_to_spatial=None):
         """
         Returns data with name equal to data_label of type cls with subsets applied from
         subset_to_apply.
@@ -138,6 +139,9 @@ def get_data(self, data_label=None, cls=None, subset_to_apply=None, function=Non
             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.
+        spectral_to_spatial : str, optional
+            Spectral subset to be applied to spatial subset. Only possible if function is
+            set to True.
 
         Returns
         -------
@@ -147,7 +151,8 @@ def get_data(self, data_label=None, cls=None, subset_to_apply=None, function=Non
         """
         if function is True:
             return self.specviz.get_data(data_label=data_label, cls=cls,
-                                         subset_to_apply=subset_to_apply)
+                                         subset_to_apply=subset_to_apply,
+                                         spectral_to_spatial=spectral_to_spatial)
         elif function is False:
             function = None
         return self._get_data(data_label=data_label, cls=cls, subset_to_apply=subset_to_apply,

jdaviz/configs/specviz/helper.py

@@ -271,7 +271,7 @@ def set_spectrum_tick_format(self, fmt, axis=None):
             self._default_spectrum_viewer_reference_name
         ).figure.axes[axis].tick_format = fmt
 
-    def get_data(self, data_label=None, cls=None, subset_to_apply=None):
+    def get_data(self, data_label=None, cls=None, subset_to_apply=None, spectral_to_spatial=None):
         """
         Returns data with name equal to data_label of type cls with subsets applied from
         subset_to_apply.
@@ -284,6 +284,9 @@ def get_data(self, data_label=None, cls=None, subset_to_apply=None):
             The type that data will be returned as.
         subset_to_apply : str, optional
             Subset that is to be applied to data before it is returned.
+        spectral_to_spatial : str, optional
+            Spectral subset to be applied to spatial subset. Only possible if this is
+            a specviz instance inside cubeviz.
 
         Returns
         -------
@@ -302,4 +305,4 @@ def get_data(self, data_label=None, cls=None, subset_to_apply=None):
             function = None
 
         return self._get_data(data_label=data_label, cls=cls, subset_to_apply=subset_to_apply,
-                              function=function)
+                              function=function, spectral_to_spatial=spectral_to_spatial)

jdaviz/core/helpers.py

@@ -22,6 +22,7 @@
 from glue.config import data_translator
 from ipywidgets.widgets import widget_serialization
 from specutils import Spectrum1D
+from specutils.manipulation import extract_region
 
 
 from jdaviz.app import Application
@@ -410,7 +411,8 @@ def show_in_new_tab(self, title=None):  # pragma: no cover
                       DeprecationWarning)
         return self.show(loc="sidecar:tab-after", title=title)
 
-    def _get_data(self, data_label=None, cls=None, subset_to_apply=None, function=None):
+    def _get_data(self, data_label=None, cls=None, subset_to_apply=None, function=None,
+                  spectral_to_spatial=None):
         list_of_valid_function_values = ('minimum', 'maximum', 'mean',
                                          'median', 'sum')
         if function and function not in list_of_valid_function_values:
@@ -480,9 +482,15 @@ def _get_data(self, data_label=None, cls=None, subset_to_apply=None, function=No
                             warnings.warn(f"Not able to get {data_label} returned with"
                                           f" subset {subsets.label} applied of type {cls}."
                                           f" Exception: {e}")
+        # Apply spectral subset to spatial subset if applicable
+        if spectral_to_spatial:
+            sr = self.app.get_subsets(spectral_to_spatial)
+            if sr:
+                data = extract_region(data, sr, return_single_spectrum=True)
+
         return data
 
-    def get_data(self, data_label=None, cls=None, subset_to_apply=None):
+    def get_data(self, data_label=None, cls=None, subset_to_apply=None, spectral_to_spatial=None):
         """
         Returns data with name equal to data_label of type cls with subsets applied from
         subset_to_apply.
@@ -495,14 +503,17 @@ def get_data(self, data_label=None, cls=None, subset_to_apply=None):
             The type that data will be returned as.
         subset_to_apply : str, optional
             Subset that is to be applied to data before it is returned.
+        spectral_to_spatial : str, optional
+            Spectral subset to be applied to spatial subset.
 
         Returns
         -------
         data : cls
             Data is returned as type cls with subsets applied.
 
         """
-        return self._get_data(data_label=data_label, cls=cls, subset_to_apply=subset_to_apply)
+        return self._get_data(data_label=data_label, cls=cls, subset_to_apply=subset_to_apply,
+                              spectral_to_spatial=spectral_to_spatial)
 
 
 class ImageConfigHelper(ConfigHelper):