cat2tom / dicomautomaton Goto Github PK

About
=====

    DICOMautomaton is a collection of tools for analyzing `medical physics'
  data, specifically dosimetric and medical imaging data in the DICOM format. It
  has become something of a platform that provides a variety of possible
  operations. DICOMautomaton is designed to be easy to develop and the user
  interface is fairly rough. 

    The basic workflow is:
  1. Files are loaded (from a DB or various types of files),
  2. A list of operations are provided and sequentially performed, mutating the
     data state,
  3. Files of various kinds can be written or a viewer can be invoked. (Both
     are implemented as operations that can be chained together sequentially.)

    Some operations are interactive. Others will run on their own for days
  (weeks). Each operation provides a description of the parameters that can be
  configured. To see this documentation, invoke:
        $> dicomautomaton_dispatcher -u
  and for general information invoke:
        $> dicomautomaton_dispatcher -h

    NOTE: DICOMautomaton should NOT be used for clinical purposes. It is 
  suitable for research or support tool purposes only.


License and Copying
===================

    All materials herein which may be copywrited, where applicable, are.
  Copyright 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017 hal clark. See the
  LICENSE file for details about the license. Informally, DICOMautomaton is
  available under a GPLv3+ license. The Imebra library is bundled for
  convenience and was not written by the author; consult it's license file in
  [src/imebra/license.txt].

    All liability is herefore disclaimed. The person(s) who use this source
  and/or software do so strictly under their own volition. They assume all
  associated liability for use and misuse, including but not limited to
  damages, harm, injury, and death which may result, including but not limited
  to that arising from unforeseen and unanticipated implementation defects.
  

Dependencies
============

    Dependencies are listed in the PKGBUILD file (using Arch Linux package
  naming conventions) and in the CMakeLists.txt file (Debian package naming
  conventions).

    Notably, DICOMautomaton depends on the author's "Ygor", "Explicator", 
  and "YgorClustering" projects. See
      [https://gitlab.com/hdeanclark/Ygor]
      or [https://github.com/hdclark/Ygor]
  and
      [https://gitlab.com/hdeanclark/Explicator] 
      or [https://github.com/hdclark/Explicator] 
  and (only for compilation)
      [https://gitlab.com/hdeanclark/YgorClustering]
      or [https://github.com/hdclark/YgorClustering]

  
Installation
============

  This project uses CMake to build. Use the usual commands to compile:
   $ cd /path/to/source/directory
   $ mkdir build && cd build/
    THEN
     # If by-passing your package manager.
       $ cmake ../ -DCMAKE_INSTALL_PREFIX=/usr
       $ make && sudo make install
    OR
     # If building for Debian.
       $ cmake ../ -DCMAKE_INSTALL_PREFIX=/usr
       $ make && make package
       $ sudo dpkg -i sudo dpkg -i *.deb
       $ sudo apt-get -f install   # Or [--fix-missing] in lieu of [-f].
    OR
     # If building for Arch Linux.
       $ rsync -a --exclude build ../ ./
       $ makepkg --syncdeps --noconfirm # Optionally also [--install].


Project Home
============

    This project's homepage can be found at [http://www.halclark.ca/]. The
  source code is available at either
          [https://gitlab.com/hdeanclark/DICOMautomaton/] 
  or
          [https://github.com/hdclark/DICOMautomaton/].