Sign inSign up

fnndsc/pl-img2dcm

By fnndsc

Updated over 3 years ago

An image to DICOM converter

Image
Integration & delivery
Data science
0

3.8K

fnndsc/pl-img2dcm repository overview

pl-img2dcm

.. image:: https://img.shields.io/docker/v/fnndsc/pl-img2dcm?sort=semver :target: https://hub.docker.com/r/fnndsc/pl-img2dcm

.. image:: https://img.shields.io/github/license/fnndsc/pl-img2dcm :target: https://github.com/FNNDSC/pl-img2dcm/blob/master/LICENSE

.. image:: https://github.com/FNNDSC/pl-img2dcm/workflows/ci/badge.svg :target: https://github.com/FNNDSC/pl-img2dcm/actions

.. contents:: Table of Contents

Abstract

An app to convert an input image to a DICOM format

Description

img2dcm is a ChRIS ds-type is an app that simply converts an input image (jpg/png) to a DICOM format. It does require a base/reference DICOM image from which to import the tag header information.

Usage

.. code::

docker run --rm fnndsc/pl-img2dcm img2dcm
    [-i|--inputImageFilter <imageFilter>]
    [-d|--inputDCMFilter <dicomFilter>]
    [-h|--help]
    [--json] [--man] [--meta]
    [--savejson <DIR>]
    [-v|--verbosity <level>]
    [--version]
    <inputDir> <outputDir>

Arguments


.. code::

    [-i|--inputImageFilter <imageFilter>]
    A glob pattern string, default is "**/*.png", representing the input
    file pattern to analyze.

    [-d|--inputDCMFilter <dicomFilter>]
    A glob pattern string, default is "**/*.dcm", representing the input
    dicom files to fetch tags.

    [-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:

.. code:: bash

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

Run
~~~

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


.. code:: bash

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


Development
-----------

Build the Docker container:

.. code:: bash

    docker build -t local/pl-img2dcm .

Run unit tests:

.. code:: bash

    docker run --rm local/pl-img2dcm nosetests

Examples
--------

Put some examples here!


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

Tag summary

Content type

Image

Digest

sha256:1b401b33e

Size

176.5 MB

Last updated

over 3 years ago

docker pull fnndsc/pl-img2dcm