Merge branch 'public' into 'main'

Public

See merge request roboct/definitions/json_schemas!19

examples/generated/example_header.json

 {
-    "uuid": "0060361f-056d-11f0-b60b-f46d3febaf36"
+    "uuid": "06f48f47-059d-11f0-b60b-f46d3febaf36"
 }
\ No newline at end of file

examples/generated/example_joint.json

+{
+    "q": 0.0
+}
\ No newline at end of file

examples/generated/example_projection.json

@@ -36,7 +36,7 @@
             "z": 0.0
         },
         "header": {
-            "uuid": "005f11bd-056d-11f0-b60b-f46d3febaf36"
+            "uuid": "06f352d6-059d-11f0-b60b-f46d3febaf36"
         }
     }
 }
\ No newline at end of file

examples/generated/example_roi.json

 {
     "header": {
-        "uuid": "00670fe0-056d-11f0-b60b-f46d3febaf36"
+        "uuid": "06fe834b-059d-11f0-b60b-f46d3febaf36"
     },
     "roi_center_position_mm": [
         0.0,

pyproject.toml

 [project]
 name = "thd-json"
-version = "0.1.11"
+version = "0.1.12"
 description = "THD JSON schema and validation tools."
 authors = [
     { name = "swittl", email = "simon.wittl@th-deg.de" }

scripts/generate_example_data.py

@@ -4,6 +4,7 @@ from thd_json.header import get_header_validator, generate_header
 from thd_json.source import get_source_validator
 from thd_json.detector import get_detector_validator
 from thd_json.roi import get_roi_validator
+from thd_json.joint import get_joint_validator
 from hypothesis import given, settings
 import json
 from pathlib import Path
@@ -29,6 +30,7 @@ def main():
         ("source", get_source_validator),
         ("detector", get_detector_validator),
         ("roi", get_roi_validator),
+        ("joint", get_joint_validator),
     ]:
         validator = get_validator()
         schema = validator.get_schema()

src/thd_json/detector/detector.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Detector File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "pixel_pitch_mm": {

src/thd_json/header/header.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Data Metadata Header File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "timestamp": {

src/thd_json/image/image.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Projection Image File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "header": {

src/thd_json/joint/__init__.py

+from thd_json import Validator
+
+from pathlib import Path
+import argparse
+
+
+def get_joint_validator(json_suffix: str = "*.json") -> Validator:
+    return Validator(Path(__file__).parent / Path("joint.json"), json_suffix)
+
+
+def joint_cli():
+    parser = argparse.ArgumentParser(
+        description="JSON THD Joint 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_joint_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__":
+    joint_cli()

src/thd_json/joint/joint.json

+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "THD Data Metadata Joint File Schema",
+  "type": "object",
+  "version": "0.1.12",
+  "date": "20.03.2025",
+  "properties": {
+    "q": {
+      "type": "number",
+      "description": "Current angle of one joint.",
+      "format": "uuid"
+    }
+  },
+  "required": [
+    "q"
+  ],
+  "additionalProperties": false
+}
\ No newline at end of file

src/thd_json/projection/projection.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Projection File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "image": {

src/thd_json/projection_geometry/projection_geometry.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Projection Geometry File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "header": {

src/thd_json/roi/roi.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD ROI File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "header": {

src/thd_json/source/source.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD X-Ray Source File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "voltage_kv": {

src/thd_json/thd_joint_states/__init__.py

+from thd_json import Validator
+
+from pathlib import Path
+import argparse
+
+
+def get_thd_joint_states_validator(json_suffix: str = "*.json") -> Validator:
+    return Validator(Path(__file__).parent / Path("thd_joint_states.json"), json_suffix)
+
+
+def thd_joint_states_cli():
+    parser = argparse.ArgumentParser(
+        description="JSON THD Joint 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_thd_joint_states_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__":
+    thd_joint_states_cli()

src/thd_json/thd_joint_states/thd_joint_states.json

+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "THD Data Metadata Joint States File Schema",
+  "type": "object",
+  "version": "0.1.12",
+  "date": "20.03.2025",
+  "properties": {
+    "header": {
+      "$ref": "../header/header.json"
+    },
+    "master_joint_e1": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a1": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a2": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a3": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a4": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a5": {
+      "$ref": "../joint/joint.json"
+    },
+    "master_joint_a6": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_e1": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_a1": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_a2": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_a3": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_a4": {
+      "$ref": "../joint/joint.json"
+    },
+    "slave_joint_a5": {
+      "$ref": "../joint/joint.json"
+    },
+    "salve_joint_a6": {
+      "$ref": "../joint/joint.json"
+    },
+    "table_joint_a1": {
+      "$ref": "../joint/joint.json"
+    }
+  },
+  "required": [
+    "master_joint_e1",
+    "master_joint_a1",
+    "master_joint_a2",
+    "master_joint_a3",
+    "master_joint_a4",
+    "master_joint_a5",
+    "master_joint_a6",
+    "slave_joint_e1",
+    "slave_joint_a1",
+    "slave_joint_a2",
+    "slave_joint_a3",
+    "slave_joint_a4",
+    "slave_joint_a5",
+    "slave_joint_a6",
+    "table_joint_a1"
+  ],
+  "additionalProperties": false
+}
\ No newline at end of file

src/thd_json/volume/volume.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "THD Projection Volume File Schema",
   "type": "object",
-  "version": "0.1.11",
+  "version": "0.1.12",
   "date": "20.03.2025",
   "properties": {
     "header": {

uv.lock

@@ -356,7 +356,7 @@ wheels = [
 
 [[package]]
 name = "thd-json"
-version = "0.1.11"
+version = "0.1.12"
 source = { editable = "." }
 dependencies = [
     { name = "hatchling" },