REST client for Orthanc DICOM servers
Project description
Orthanc REST client
Provides a REST client targeted at Orthanc REST API endpoints.
Based on the excellent apiron library.
Install
pip install orthanc-rest-client
How to use
Import the pre-defined client and pass the server details
from orthanc_rest_client import Orthanc
orthanc = Orthanc('http://localhost:8042')
# Patient endpoints
orthanc.get_patients()
orthanc.get_patient(id)
...and so on
# Study endpoints
orthanc.get_studies()
orthanc.get_study(id)
...and so on
# Series endpoints
orthanc.get_series()
orthanc.get_one_series(id)
...and so on
# Instance endpoints
orthanc.get_instances()
orthanc.get_instance(id)
...and so on
# Get changes
orthanc.get_changes()
# Find objects by query
query = {'Level': 'Patient',
'Query': {'PatientName': 'Jon*'},
}
orthanc.find(query)
# Get previous queries
orthanc.get_queries()
There are many other preconfigured endpoints.
Authentication
Pass valid auth object:
from requests.auth import HTTPBasicAuth
auth = HTTPBasicAuth('orthanc', 'orthanc')
orthanc = Orthanc('https://test.server.com', auth=auth)
Then call functions normally (the auth object is passed automatically).
Advanced examples
For example, to save an instance file to local directory:
def save_dcm_file(instance_id):
fileName = '.'.join([instance_id, "dcm"])
with open(fileName, 'wb') as dcm:
for chunk in orthanc.get_instance_file(instance_id):
dcm.write(chunk)
To get a zip of DCM files from a series:
with open('test.zip', 'wb') as z:
for chunk in orthanc.get_series_archive(<id>):
z.write(chunk)
Security warning on non-HTTPS endpoints
The rest client will warn when using HTTP endpoints. Strongly consider using HTTPS given the data sensitivity.
You can disable the warning using the warn_insecure
keyword argument:
orthanc = Orthanc('http://insecure.endpoint.com', warn_insecure=False)
Further help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
orthanc_rest_client-0.5.7.tar.gz
(23.6 kB
view hashes)
Built Distribution
Close
Hashes for orthanc_rest_client-0.5.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e14450b28c8837f008dd39d24becc3a8fb8dc7d492204e3d71b19a76dc2865f3 |
|
MD5 | cd1a8a4d40394cefd881e49029eafba6 |
|
BLAKE2b-256 | b2118837b32a7d13898a5f1e0b4e9767b03f4c5fa078a6524e80b748d56ddbd9 |
Close
Hashes for orthanc_rest_client-0.5.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d4036558c88c3f78061344d7a65d0fd940a260bb7d318d9ee3585892956c5b2 |
|
MD5 | 21503cd13a06a567f3a881be01cbed30 |
|
BLAKE2b-256 | 13824e9c2ae7eb459060f888137fc5d5b6ae3bfb608ef39a0cf217407e798130 |