Add support to TiledDataset for missing, irregular or overlapping tiles

dkist/io/asdf/converters/tiled_dataset.py

@@ -5,16 +5,23 @@ class TiledDatasetConverter(Converter):
     tags = [
         "tag:dkist.nso.edu:dkist/tiled_dataset-0.1.0",
         "asdf://dkist.nso.edu/tags/tiled_dataset-1.0.0",
+        "asdf://dkist.nso.edu/tags/tiled_dataset-1.1.0",
     ]
     types = ["dkist.dataset.tiled_dataset.TiledDataset"]
 
     def from_yaml_tree(cls, node, tag, ctx):
         from dkist.dataset.tiled_dataset import TiledDataset
 
-        return TiledDataset(node["datasets"], node["inventory"])
+        try:
+            mask = node["mask"]
+        except KeyError:
+            mask = None
+
+        return TiledDataset(node["datasets"], node["inventory"], mask)
 
     def to_yaml_tree(cls, tiled_dataset, tag, ctx):
         tree = {}
         tree["inventory"] = tiled_dataset._inventory
         tree["datasets"] = tiled_dataset._data.tolist()
+        tree["mask"] = tiled_dataset._data.mask.tolist()
         return tree

dkist/io/asdf/resources/schemas/tiled_dataset-1.1.0.yaml

@@ -0,0 +1,35 @@
+%YAML 1.1
+---
+$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
+id: "asdf://dkist.nso.edu/schemas/tiled_dataset-1.0.0"
+
+title: |
+  A DKIST Tiled Dataset object.
+description:
+  The container for a set of Dataset objects.
+
+type: object
+properties:
+  datasets:
+    description: A nested structure of Dataset objects
+    type: array
+    items:
+      type: array
+      items:
+        anyOf:
+          - tag: "asdf://dkist.nso.edu/tags/dataset-1.*"
+          - null: true
+  inventory:
+    description: A copy of the inventory record for this dataset.
+    type: object
+  mask:
+    description: A mask to indicate if invalid or missing Datasets should be ignored.
+    type: array
+    items:
+      type: array
+      items:
+        - type: boolean
+
+required: [datasets, inventory, mask]
+additionalProperties: false
+...