packages/itk/src/bbitkImageSeriesReader.h

   1 /*
   2  # ---------------------------------------------------------------------
   3  #
   4  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   5  #                        pour la SantÈ)
   6  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   7  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   9  #
  10  #  This software is governed by the CeCILL-B license under French law and
  11  #  abiding by the rules of distribution of free software. You can  use,
  12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  13  #  license as circulated by CEA, CNRS and INRIA at the following URL
  14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  15  #  or in the file LICENSE.txt.
  16  #
  17  #  As a counterpart to the access to the source code and  rights to copy,
  18  #  modify and redistribute granted by the license, users are provided only
  19  #  with a limited warranty  and the software's author,  the holder of the
  20  #  economic rights,  and the successive licensors  have only  limited
  21  #  liability.
  22  #
  23  #  The fact that you are presently reading this means that you have had
  24  #  knowledge of the CeCILL-B license and that you accept its terms.
  25  # ------------------------------------------------------------------------ */
  26
  27
  28 /*=========================================================================
  29   Program:   bbtk
  30   Module:    $RCSfile: bbitkImageSeriesReader.h,v $
  31   Language:  C++
  32   Date:      $Date: 2012/11/16 08:50:39 $
  33   Version:   $Revision: 1.12 $
  34 =========================================================================*/
  35
  36
  37
  38
  39 /**
  40  * \file
  41  * \brief class ITKImageSeriesReader : generic ITKImage reader
  42  */
  43 /**
  44  * \class bbtk::ITKImageSeriesReader
  45  * \brief Generic ITKImage reader
  46  */
  47 #ifdef _USE_ITK_
  48
  49 #ifndef __bbitkImageSeriesReader_h_INCLUDED__
  50 #define __bbitkImageSeriesReader_h_INCLUDED__
  51
  52 #include "bbtkAtomicBlackBox.h"
  53 #include "bbitkImage.h"
  54
  55 namespace bbitk
  56 {
  57
  58   //=================================================================
  59   // BlackBox declaration
  60   class ImageSeriesReader : public bbtk::AtomicBlackBox
  61   {
  62
  63     BBTK_BLACK_BOX_INTERFACE(ImageSeriesReader,
  64                              bbtk::AtomicBlackBox);
  65     BBTK_DECLARE_INPUT(FileNames,std::vector<std::string>);
  66     BBTK_DECLARE_INPUT(XSpacing,float);
  67     BBTK_DECLARE_INPUT(YSpacing,float);
  68     BBTK_DECLARE_INPUT(ZSpacing,float);
  69     BBTK_DECLARE_OUTPUT(Out,anyImagePointer);
  70     BBTK_PROCESS(Read);
  71     void Read();
  72
  73   private:
  74     // Template read method
  75     template<class T> void Read();
  76   };
  77   //=================================================================
  78
  79
  80   //=================================================================
  81   // BlackBox description
  82   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImageSeriesReader,bbtk::AtomicBlackBox);
  83   BBTK_NAME("ImageSeriesReader");
  84   BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
  85   BBTK_DESCRIPTION("Generic itk image series reader");
  86   BBTK_CATEGORY("image;read/write");
  87   typedef std::vector<std::string> vectorofstring;
  88   BBTK_INPUT(ImageSeriesReader,FileNames,
  89              "vector of file names with complete paths",vectorofstring,"file names list");
  90   BBTK_INPUT(ImageSeriesReader,XSpacing, "if images don't contain information",float,"");
  91   BBTK_INPUT(ImageSeriesReader,YSpacing, "if images don't contain information",float,"" );
  92   BBTK_INPUT(ImageSeriesReader,ZSpacing, "if images don't contain information",float,"");
  93
  94   BBTK_OUTPUT(ImageSeriesReader,Out,"Output itk::image<T,D> with type T and dimension D determined by the content of the files + vector size",anyImagePointer,"");
  95
  96   BBTK_END_DESCRIBE_BLACK_BOX(ImageSeriesReader);
  97   //=================================================================
  98
  99
 100 }
 101 //namespace bbtk
 102 #endif
 103
 104 #endif