added roi and volume

examples/generated/example_roi.json

+{
+    "header": {
+        "timestamp": "2000-01-01T00:00:00Z",
+        "uuid": ""
+    },
+    "roi_center_position_mm": [
+        0.0,
+        0.0,
+        0.0
+    ],
+    "roi_orientation_quat": [
+        0.0,
+        0.0,
+        0.0,
+        0.0
+    ],
+    "roi_resolution_mm": [
+        0.0,
+        0.0,
+        0.0
+    ],
+    "roi_voxels": [
+        1,
+        1,
+        1
+    ]
+}
\ No newline at end of file

examples/generated/example_volume.json

+{
+    "timestamp": "2000-01-01T00:00:00Z",
+    "uuid": "",
+    "volume_path": ".tif"
+}
\ No newline at end of file

scripts/generate_example_data.py

@@ -4,6 +4,8 @@ from thd_json.header import get_header_validator
 from thd_json.source import get_source_validator
 from thd_json.detector import get_detector_validator
 from thd_json.image import get_image_validator
+from thd_json.roi import get_roi_validator
+from thd_json.volume import get_volume_validator
 from hypothesis import given, settings
 import json
 from pathlib import Path
@@ -19,6 +21,8 @@ def main():
         ("source", get_source_validator),
         ("detector", get_detector_validator),
         ("image", get_image_validator),
+        ("roi", get_roi_validator),
+        ("volume", get_volume_validator),
     ]:
         validator = get_validator()
         schema = validator.get_schema()

src/thd_json/roi/__init__.py

+from thd_json import Validator
+
+from pathlib import Path
+import argparse
+
+
+def get_roi_validator(json_suffix: str = "*.json") -> Validator:
+    return Validator(Path(__file__).parent / Path("roi.json"), json_suffix)
+
+
+def roi_cli():
+    parser = argparse.ArgumentParser(description="JSON THD ROI Validator CLI with uv.")
+    parser.add_argument("folder", help="Folder to check.", type=str)
+    parser.add_argument(
+        "suffix", help="Projection suffix.", default="*.json", type=Path, nargs="?"
+    )
+    args = parser.parse_args()
+
+    suffix = str(args.suffix)
+    if not suffix.startswith("*"):
+        raise ValueError(f'The suffix must always start with: "*". \nIt is: {suffix}')
+
+    validator = get_roi_validator(suffix)
+
+    folder = Path(args.folder)
+    if not folder.exists():
+        raise FileNotFoundError(f"Folder: {folder} does not exist")
+
+    validator.folder(Path(args.folder))
+
+
+if __name__ == "__main__":
+    roi_cli()

src/thd_json/roi/roi.json

+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "THD ROI File Schema",
+    "type": "object",
+    "version": 0.6,
+    "date": "20.11.2024",
+    "properties": {
+      "header": {
+        "$ref": "./header/header.json"
+      },
+      "roi_center_position_mm": {
+        "type": "array",
+        "description": "Position of the focal spot in millimeters.",
+        "items": {
+          "type": "number"
+        },
+        "minItems": 3,
+        "maxItems": 3
+      },
+      "roi_orientation_quat": {
+        "type": "array",
+        "description": "Quaternion representing the detector's center orientation.",
+        "items": {
+          "type": "number"
+        },
+        "minItems": 4,
+        "maxItems": 4
+      },
+      "roi_resolution_mm": {
+        "type": "array",
+        "description": "Center position of the detector in millimeters.",
+        "items": {
+          "type": "number"
+        },
+        "minItems": 3,
+        "maxItems": 3
+      },
+      "roi_voxels": {
+        "type": "array",
+        "description": "Center position of the detector in millimeters.",
+        "items": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "minItems": 3,
+        "maxItems": 3
+      }
+    },
+    "required": [
+      "header",
+      "roi_center_position_mm",
+      "roi_orientation_quat",
+      "roi_resolution_mm",
+      "roi_voxels"
+    ],
+    "additionalProperties": false
+  }
+  
\ No newline at end of file

src/thd_json/volume/__init__.py

+from thd_json import Validator
+
+from pathlib import Path
+import argparse
+
+
+def get_volume_validator(json_suffix: str = "*.json") -> Validator:
+    return Validator(Path(__file__).parent / Path("volume.json"), json_suffix)
+
+
+def volume_cli():
+    parser = argparse.ArgumentParser(
+        description="JSON THD Volume Validator CLI with uv."
+    )
+    parser.add_argument("folder", help="Folder to check.", type=str)
+    parser.add_argument(
+        "suffix", help="Projection suffix.", default="*.json", type=Path, nargs="?"
+    )
+    args = parser.parse_args()
+
+    suffix = str(args.suffix)
+    if not suffix.startswith("*"):
+        raise ValueError(f'The suffix must always start with: "*". \nIt is: {suffix}')
+
+    validator = get_volume_validator(suffix)
+
+    folder = Path(args.folder)
+    if not folder.exists():
+        raise FileNotFoundError(f"Folder: {folder} does not exist")
+
+    validator.folder(Path(args.folder))
+
+
+if __name__ == "__main__":
+    volume_cli()

src/thd_json/volume/volume.json

+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "THD Projection Volume File Schema",
+    "type": "object",
+    "version": 0.6,
+    "date": "20.11.2024",
+    "properties": {
+        "timestamp": {
+            "type": "string",
+            "description": "Timestamp, e.g. 2018-11-13T20:20:39+00:00",
+            "format": "date-time"
+        },
+        "uuid": {
+            "type": "string",
+            "description": "Unique identifier",
+            "format": "uuid"
+        },
+        "volume_path": {
+            "type": "string",
+            "description": "Path to TIFF file.",
+            "pattern": "^.*\\.(tif|tiff)$"
+        }
+    },
+    "required": [
+        "timestamp",
+        "uuid",
+        "volume_path"
+    ],
+    "additionalProperties": false
+}
\ No newline at end of file