Skip to content

FNNDSC/pl-orthanc_push

Folders and files

NameName
Last commit message
Last commit date
Oct 3, 2024
Nov 21, 2022
Jan 22, 2025
Nov 21, 2022
Nov 21, 2022
Mar 14, 2023
Nov 21, 2022
Feb 2, 2023
Oct 4, 2024
Jan 22, 2025

Repository files navigation

pl-orthanc_push

https://img.shields.io/docker/v/fnndsc/pl-orthanc_push?sort=semver https://img.shields.io/github/license/fnndsc/pl-orthanc_push

An app to push/upload dicoms to an orthanc server and optionally also "piggy back" to a remote modality (if specified).

orthanc_push is a ChRIS ds-type application that takes in DICOMs as input files and pushes them to a remote Orthanc server and in addition also to an optional remote modality.

docker run --rm fnndsc/pl-orthanc_push orthanc_push
    [-f|--inputFileFilter <inputFileFilter>]
    [-o|--orthancUrl <orthancServerUrl>]
    [-u|--username <orthancUserName>]
    [-p|--password <orthancPassword>]
    [-r|--pushToRemote <remoteModality>]
    [-h|--help]
    [--json] [--man] [--meta]
    [--savejson <DIR>]
    [-v|--verbosity <level>]
    [--version]
    <inputDir> <outputDir>
[-f|--inputFileFilter <inputFileFilter>]
A glob pattern string, default is "**/*.dcm", representing the input
file pattern to analyze.

[-o|--orthancUrl <orthancServerUrl>]
URL of the orthanc server.

[-u|--username <orthancUserName>]
The username to login to the orthanc server.

[-p|--password <orthancPassword>]
Specify the password to login to the orthanc server.

[-r|--pushToRemote <remoteModality>]
If specified, orthanc will send dicoms to the target remote modality

[-h] [--help]
If specified, show help message and exit.

[--json]
If specified, show json representation of app and exit.

[--man]
If specified, print (this) man page and exit.

[--meta]
If specified, print plugin meta data and exit.

[--savejson <DIR>]
If specified, save json representation file to DIR and exit.

[-v <level>] [--verbosity <level>]
Verbosity level for app. Not used currently.

[--version]
If specified, print version number and exit.

Getting inline help is:

docker run --rm fnndsc/pl-orthanc_push orthanc_push --man

You need to specify input and output directories using the -v flag to docker run.

docker run --rm -u $(id -u)                                 \
    -v $(pwd)/in:/incoming -v $(pwd)/out:/outgoing          \
    fnndsc/pl-orthanc_push orthanc_push                     \
    /incoming /outgoing

Build the Docker container:

docker build -t local/pl-orthanc_push .

Run unit tests:

docker run --rm local/pl-orthanc_push nosetests

Put some examples here!

https://raw.githubusercontent.com/FNNDSC/cookiecutter-chrisapp/master/doc/assets/badge/light.png