Skip to main content

REST client for Orthanc DICOM servers

Project description

Orthanc REST client

Build Status PyPI version

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for orthanc-rest-client, version 0.5.7
Filename, size File type Python version Upload date Hashes
Filename, size orthanc_rest_client-0.5.7-py3-none-any.whl (16.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size orthanc_rest_client-0.5.7.tar.gz (23.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page