Metadata-Version: 2.0
Name: dicom-numpy
Version: 0.1.1
Summary: Extract image data into a 3D numpy array from a set of DICOM files.
Home-page: https://github.com/innolitics/dicom-numpy
Author: Innolitics, LLC
Author-email: info@innolitics.com
License: MIT
Keywords: dicom numpy
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Dist: numpy
Requires-Dist: pydicom
Provides-Extra: dev
Requires-Dist: check-manifest; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'

.. image:: https://travis-ci.org/innolitics/dicom-numpy.svg?branch=master

===========
DICOM Numpy
===========

Overview
--------

This python module provides utilities for extracting image data contained in DICOM files into Numpy ndarrays.

Dependencies
------------

- Python 2.7 or Python 3.3+
- Numpy
- PyDicom

Installation
------------

.. code:: bash

    pip install dicom_numpy

Basic Usage
-----------

.. code:: python

    import dicom
    import dicom_numpy

    def extract_voxel_data(list_of_dicom_files):
        datasets = [dicom.read_file(f) for f in list_of_dicom_files]
        try:
            voxel_ndarray = dicom_numpy.combine_slices(datasets)
        except dicom_numpy.DicomImportException as e:
            # Either the DICOM files are not from the same series, there are missing
            # internal slices (we can't detect missing end slices), or the data
            # is inconsistent in some way (e.g. the size of each slice is
            # inconsistent).
            raise
        return voxel_ndarray


