parent data implementation

Author: kecnry

jdaviz/configs/imviz/helper.py

@@ -186,12 +186,14 @@ def load_data(self, data, data_label=None, show_in_viewer=True, **kwargs):
                            format='Image',
                            data_label=data_label,
                            extension=extensions,
+                           parent=kwargs.pop('parent', None),
                            show_in_viewer=show_in_viewer)
         elif isinstance(data, str) and data.endswith('.reg'):
             self._load(data,
                        format='Subset',
                        data_label=data_label,
                        extension=extensions,
+                       parent=kwargs.pop('parent', None),
                        show_in_viewer=show_in_viewer)
         else:
             # extensions is None or a single extension or data is NDData and importer will handle
@@ -210,6 +212,7 @@ def load_data(self, data, data_label=None, show_in_viewer=True, **kwargs):
                        data_label=data_label,
                        data_label_as_prefix=data_label_as_prefix,
                        extension=extensions,
+                       parent=kwargs.pop('parent', None),
                        show_in_viewer=show_in_viewer)
 
     def link_data(self, align_by='pixels', wcs_fallback_scheme=None, wcs_fast_approximation=True):

jdaviz/core/loaders/importers/image/image.py

@@ -11,7 +11,7 @@
 from traitlets import Bool, List, Any, observe
 
 
-from jdaviz.core.template_mixin import SelectFileExtensionComponent
+from jdaviz.core.template_mixin import SelectFileExtensionComponent, DatasetSelect
 
 from jdaviz.core.registries import loader_importer_registry
 from jdaviz.core.loaders.importers import BaseImporterToDataCollection
@@ -42,6 +42,10 @@ class ImageImporter(BaseImporterToDataCollection):
     extension_selected = Any().tag(sync=True)
     extension_multiselect = Bool(True).tag(sync=True)
 
+    # Data-association
+    parent_items = List().tag(sync=True)
+    parent_selected = Any().tag(sync=True)
+
     # user-settable option to treat the data_label as prefix and append the extension later
     data_label_as_prefix = Bool(False).tag(sync=True)
     # whether the current data_label should be treated as a prefix
@@ -50,11 +54,17 @@ class ImageImporter(BaseImporterToDataCollection):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
+
         if self.default_data_label_from_resolver:
             self.data_label_default = self.default_data_label_from_resolver
         elif self.app.config == 'imviz':
             self.data_label_default = 'Image'
 
+        self.parent = DatasetSelect(self, 'parent_items', 'parent_selected',
+                                    multiselect=None, manual_options=['Auto'])
+        self.parent.add_filter('is_image', 'not_from_plugin')
+        self.parent.selected = 'Auto'
+
         self.input_hdulist = isinstance(self.input, fits.HDUList)
         if self.input_hdulist:
             self.extension = SelectFileExtensionComponent(self,
@@ -69,7 +79,7 @@ def __init__(self, *args, **kwargs):
 
     @property
     def user_api(self):
-        expose = ['data_label_as_prefix']
+        expose = ['parent', 'data_label_as_prefix']
         if self.input_hdulist:
             expose += ['extension']
         return ImporterUserApi(self, expose)
@@ -157,6 +167,32 @@ def __call__(self, show_in_viewer=True):
             exts = [None] * len(outputs)
             hdus = [None] * len(outputs)
 
+        # If parent is set to 'Auto', use any present SCI/DATA extension as parent
+        # of any other extensions
+        if self.parent.selected == 'Auto' and len(exts) > 1:
+            for ext in ('SCI', 'DATA'):
+                if ext in exts:
+                    parent_ext = ext
+                    break
+            else:
+                parent_ext = None
+            if parent_ext is not None:
+                parent_index = exts.index(parent_ext)
+                sort_inds = [parent_index] + [i for i in range(len(exts)) if i != parent_index]
+                outputs = [outputs[i] for i in sort_inds]
+                exts = [exts[i] for i in sort_inds]
+                hdus = [hdus[i] for i in sort_inds]
+
+                parent_hdu = hdus[parent_index]
+                # assume self.data_label_is_prefix is True
+                parent = self._get_label_with_extension(base_data_label,
+                                                        parent_ext,
+                                                        ver=parent_hdu.ver if parent_hdu else None)
+        elif self.parent.selected == 'Auto':
+            parent = None
+        else:
+            parent = self.parent.selected
+
         for output, ext, hdu in zip(outputs, exts, hdus):
             if output is None:
                 # needed for NDData where one of the "extensions" might
@@ -173,6 +209,7 @@ def __call__(self, show_in_viewer=True):
                 # If data_label is not a prefix, we use it as is.
                 data_label = base_data_label
             self.add_to_data_collection(output, data_label,
+                                        parent=parent if parent != data_label else None,
                                         show_in_viewer=show_in_viewer,
                                         cls=CCDData)
 

jdaviz/core/loaders/importers/image/image.vue

@@ -10,6 +10,16 @@
       :api_hints_enabled="api_hints_enabled"
       hint="Extension to use from the FITS HDUList."
     ></plugin-select>
+    <plugin-dataset-select
+      :items="parent_items"
+      :selected.sync="parent_selected"
+      :show_if_single_entry="true"
+      :multiselect="false"
+      label="Parent Dataset"
+      api_hint="ldr.importer.parent ="
+      :api_hints_enabled="api_hints_enabled"
+      hint="Select a parent dataset to associate the new data with."
+    ></dataset-select>
     <v-row>
       <plugin-auto-label
         :value.sync="data_label_value"

jdaviz/core/loaders/importers/importer.py

@@ -159,7 +159,8 @@ def load_into_viewer(self, data_label, default_viewer_reference=None):
             viewer = self.app._jdaviz_helper.viewers.get(default_viewer_label)
             viewer.data_menu.add_data(data_label)
 
-    def add_to_data_collection(self, data, data_label=None, show_in_viewer=True, cls=None):
+    def add_to_data_collection(self, data, data_label=None,
+                               parent=None, show_in_viewer=True, cls=None):
         if data_label is None:
             data_label = self.data_label_value.strip()
         if hasattr(data, 'meta'):
@@ -168,6 +169,8 @@ def add_to_data_collection(self, data, data_label=None, show_in_viewer=True, cls
             except TypeError:
                 pass
         self.app.add_data(data, data_label=data_label)
+        if parent is not None:
+            self.app._set_assoc_data_as_child(data_label, parent)
         # store the original input class so that get_data can default to the
         # same class as the input
         cls = cls if cls is not None else data.__class__

jdaviz/tests/test_app.py

@@ -192,7 +192,7 @@ def test_data_associations(imviz_helper):
     assert imviz_helper.app._get_assoc_data_children('parent_data') == ['child_data']
     assert imviz_helper.app._get_assoc_data_parent('child_data') == 'parent_data'
 
-    with pytest.raises(NotImplementedError):
+    with pytest.raises(ValueError):
         # we don't (yet) allow children of children:
         imviz_helper.load_data(data_child, data_label='grandchild_data', parent='child_data')