How gacou54/pyorthanc works
PyOrthanc is a Python client for Orthanc: callers use sync/async REST wrappers to manage DICOM data, search and materialize typed resources, upload/retrieve files, and issue remote-modality operations. The REST client is the transport layer; resource objects add hierarchy, metadata, downloads, and anonymization. README capabilities include the Orthanc Python-plugin SDK, represented here with its enum support. Edges reflect explicit README claims or source-index references and excerpts; unsampled internals are not expanded.
Main entry points: client.py Sync client · study.py Study resource · series.py Series resource · patient.py Patient resource
Components 21
REST Clients
- Sync client
pyorthanc/client.py - Async client
pyorthanc/async_client.py - Plugin internal client
pyorthanc/_internal_client.py
DICOM Workflows
- DICOM search
pyorthanc/_find.py - Resource filtering
pyorthanc/_filtering.py - DICOM upload
pyorthanc/_upload.py - Remote modality
pyorthanc/_modality.py - File retrieval
pyorthanc/retrieve.py - Async jobs
pyorthanc/jobs.py
Resource Model
- Patient resource
pyorthanc/_resources/patient.py - Study resource
pyorthanc/_resources/study.py - Series resource
pyorthanc/_resources/series.py - Instance resource
pyorthanc/_resources/instance.py - Resource base
pyorthanc/_resources/resource.py
Plugin SDK
- Orthanc plugin SDK
pyorthanc/orthanc_sdk.py - SDK enums
pyorthanc/_orthanc_sdk_enums.py
Other components
- Python caller
- Orthanc server
- Remote PACS
- DICOM files
- Orthanc Python plugin
Connections 43
- Python caller → Sync client: uses
README.md - Python caller → Async client: uses
README.md - Python caller → DICOM search: searches
README.md - Python caller → DICOM upload: uploads
README.md - Python caller → Remote modality: queries
README.md - Python caller → File retrieval: retrieves
README.md - Python caller → Orthanc plugin SDK: uses
README.md - Sync client → Orthanc server: REST requests
README.md - Async client → Orthanc server: async REST
README.md - Plugin internal client → Orthanc server: internal calls
- DICOM search → Sync client: queries
pyorthanc/_find.py - DICOM search → Patient resource: creates resources
pyorthanc/_find.py - DICOM search → Study resource: creates resources
pyorthanc/_find.py - DICOM search → Series resource: creates resources
pyorthanc/_find.py - DICOM search → Instance resource: creates resources
pyorthanc/_find.py - Resource filtering → Patient resource: filters
pyorthanc/_filtering.py - Resource filtering → Study resource: filters
pyorthanc/_filtering.py - Resource filtering → Series resource: filters
pyorthanc/_filtering.py - Resource filtering → Instance resource: filters
pyorthanc/_filtering.py - DICOM upload → Sync client: sends files
pyorthanc/_upload.py - DICOM files → DICOM upload: provides input
README.md - Remote modality → Sync client: issues queries
pyorthanc/_modality.py - Sync client → Remote PACS: routes DICOM
README.md - File retrieval → Patient resource: writes resources
pyorthanc/retrieve.py - File retrieval → Study resource: writes resources
pyorthanc/retrieve.py - File retrieval → Series resource: writes resources
pyorthanc/retrieve.py - File retrieval → Instance resource: writes resources
pyorthanc/retrieve.py - Patient resource → Study resource: constructs children
pyorthanc/_resources/patient.py - Study resource → Series resource: constructs children
pyorthanc/_resources/study.py - Series resource → Instance resource: uses instances
pyorthanc/_resources/series.py - Patient resource → Resource base: inherits
pyorthanc/_resources/patient.py - Study resource → Resource base: inherits
pyorthanc/_resources/study.py - Series resource → Resource base: inherits
pyorthanc/_resources/series.py - Instance resource → Resource base: inherits
pyorthanc/_resources/instance.py - Patient resource → Sync client: calls REST
pyorthanc/_resources/patient.py - Study resource → Sync client: calls REST
- Series resource → Sync client: calls REST
pyorthanc/_resources/series.py - Instance resource → Sync client: calls REST
pyorthanc/_resources/instance.py - Patient resource → Async jobs: creates jobs
pyorthanc/_resources/patient.py - Study resource → Async jobs: creates jobs
pyorthanc/_resources/study.py - Series resource → Async jobs: creates jobs
pyorthanc/_resources/series.py - Orthanc Python plugin → Orthanc plugin SDK: hosts API
README.md - Orthanc plugin SDK → SDK enums: uses enums
pyorthanc/orthanc_sdk.py