metadata

Author: amazy

orthanc_api_client/instance.py

@@ -10,6 +10,7 @@ def __init__(self, json_instance: object):
         self.dicom_id = self.main_dicom_tags.get('SOPInstanceUID')
         self.series_orthanc_id = json_instance.get('ParentSeries')
         self.labels = json_instance.get('Labels') or []
+        self.metadata = json_instance.get('Metadata') or None
 
 
 class Instance:
@@ -56,4 +57,9 @@ def tags(self):  # lazy loading of tags ....
 
     @property
     def labels(self):
-        return self.info.labels
+        return self.info.labels
+    
+    def get_metadata(self, metadata_name: str) -> str:
+        if self.info.metadata is None:
+            self.info.metadata = self._api_client.instances.get_metadata(self.orthanc_id)
+        return self.info.metadata.get(metadata_name)

orthanc_api_client/resources/instances.py

@@ -31,6 +31,8 @@ def get_tags(self, orthanc_id: str) -> Tags:
         json_tags = self._api_client.get_json(f"{self._url_segment}/{orthanc_id}/tags")
         return Tags(json_tags)
 
+    def get_metadata(self, orthanc_id: str) -> dict:
+        return self._api_client.get_json(f"{self._url_segment}/{orthanc_id}/metadata?expand")
 
     def modify(self, orthanc_id: str, replace_tags: Any = {}, remove_tags: List[str] = [], keep_tags: List[str] = [], force: bool = False) -> bytes:
 

orthanc_api_client/resources/resources.py

@@ -141,7 +141,7 @@ def set_string_metadata(self, orthanc_id: str, metadata_name: str, content: Opti
 
     def get_binary_metadata(self, orthanc_id: str, metadata_name: str, default_value: Optional[str] = None) -> bytes:
 
-        content, revision = self.get_metadata_with_revision(
+        content, revision = self.get_binary_metadata_with_revision(
             orthanc_id=orthanc_id,
             metadata_name=metadata_name,
             default_value=default_value
@@ -184,7 +184,7 @@ def get_string_metadata_with_revision(self, orthanc_id: str, metadata_name: str,
         return content.decode('utf-8') if content is not None else None, revision
 
     def has_metadata(self, orthanc_id: str, metadata_name: str) -> bool:
-        return self.get_metadata(orthanc_id=orthanc_id, metadata_name=metadata_name, default_value=None) is not None
+        return self.get_binary_metadata(orthanc_id=orthanc_id, metadata_name=metadata_name, default_value=None) is not None
 
     def _anonymize(self, orthanc_id: str, replace_tags={}, keep_tags=[], delete_original=True, force=False) -> str:
         """

orthanc_api_client/resources/studies.py

@@ -4,7 +4,8 @@
 from .resources import Resources
 from ..tags import Tags
 from ..exceptions import *
-from ..study import StudyInfo, Study
+from ..study import Study
+from ..instance import Instance
 from ..helpers import to_dicom_date, to_dicom_time
 from ..downloaded_instance import DownloadedInstance
 from ..labels_constraint import LabelsConstraint
@@ -25,6 +26,23 @@ def get_instances_ids(self, orthanc_id: str) -> List[str]:
 
         return instances_ids
 
+    def get_instances(self, orthanc_id: str) -> List[Instance]:
+        instances = []
+
+        instances_info = self._api_client.post(
+            f"tools/find",
+            json={
+                "Level": "Instance",
+                "Query": {},
+                "ResponseContent": ["MainDicomTags", "Metadata", "Parent", "Labels"],
+                "ParentStudy": orthanc_id
+            }).json()
+        
+        for instance_info in instances_info:
+            instances.append(Instance.from_json(self._api_client, instance_info))
+
+        return instances
+
     def get_series_ids(self, orthanc_id: str) -> List[str]:
         study_info = self._api_client.get_json(f"{self._url_segment}/{orthanc_id}")
         return study_info["Series"]
@@ -58,11 +76,11 @@ def lookup(self, dicom_id: str) -> str:
     def find(self,
              query: object,
              case_sensitive: bool = True,
-             labels: [str] = [],
+             labels: List[str] = [],
              labels_constraint: LabelsConstraint = LabelsConstraint.ANY,
              limit: int = 0,
              since: int = 0,
-             order_by: [dict] = []
+             order_by: List[dict] = []
              ) -> List[Study]:
         """
         find a study in Orthanc based on the query and the labels

release-notes.md

@@ -1,3 +1,11 @@
+v 0.19.0
+========
+
+- Added `Instance.get_metadata()`
+- Added `Study.get_instances()` that also retrieves the metadata in a single API call
+- fix `Instances.has_metadata`
+
+
 v 0.18.8
 ========
 

setup.py

@@ -28,7 +28,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version='0.18.8',  # Required
+    version='0.19.0',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:

tests/docker-setup/docker-compose.yml

@@ -1,7 +1,7 @@
 version: "3"
 services:
   orthanc-a:
-    image: orthancteam/orthanc-pre-release:2025.01.20
+    image: orthancteam/orthanc:25.8.2
     ports: ["10042:8042"]
     environment:
       VERBOSE_STARTUP: "true"
@@ -58,7 +58,7 @@ services:
       ORTHANC__HTTP_THREADS_COUNT: "10"
 
   orthanc-c:
-    image: orthancteam/orthanc:24.2.3
+    image: orthancteam/orthanc:25.8.2
     ports: ["10044:8042"]
     environment:
       VERBOSE_STARTUP: "true"

tests/docker-setup/orthanc-b/Dockerfile

@@ -1,4 +1,4 @@
-FROM orthancteam/orthanc:24.10.1
+FROM orthancteam/orthanc:25.8.2
 
 RUN pip install  --break-system-packages pydicom==3.0.1
 

tests/test_api_client.py

@@ -167,6 +167,16 @@ def test_study(self):
             self.assertTrue(os.path.exists(file.name))
             self.assertTrue(os.path.getsize(file.name) > 0)
 
+    def test_study_instances(self):
+        self.oa.delete_all_content()
+
+        instances_ids = self.oa.upload_folder(here / "stimuli/MR/Brain")
+        study_id = self.oa.instances.get_parent_study_id(instances_ids[0])
+
+        instances = self.oa.studies.get_instances(study_id)
+        self.assertEqual(3, len(instances))
+        self.assertEqual('1.2.840.10008.5.1.4.1.1.4', instances[0].get_metadata('SopClassUid'))
+
 
 
     def test_series(self):
@@ -642,6 +652,9 @@ def test_metadata_with_revision(self):
             default_value=None
         )
         self.assertEqual(None, value)
+        self.assertFalse(self.oa.instances.has_metadata(instances_ids[0], '1024'))
+        instance = self.oa.instances.get(instances_ids[0])
+        self.assertIsNone(instance.get_metadata('1024'))
 
         content = b'123456789'
         revision = self.oa.instances.set_binary_metadata(
@@ -657,6 +670,9 @@ def test_metadata_with_revision(self):
         )
 
         self.assertEqual(content, content_readback.encode('utf-8'))
+        self.assertTrue(self.oa.instances.has_metadata(instances_ids[0], '1025'))
+        instance = self.oa.instances.get(instances_ids[0])
+        self.assertIsNotNone(instance.get_metadata('1025'))
 
         # update if match current revision
         self.oa.instances.set_string_metadata(