packages/itk/src/bbitkImageProperties.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbitkImageProperties.h,v $
   4   Language:  C++
   5   Date:      $Date: 2011/02/27 18:30:48 $
   6   Version:   $Revision: 1.10 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31 /**
  32  * \file
  33  * \brief class ITKImageProperties : generic ITKImage reader
  34  */
  35 /**
  36  * \class bbtk::ITKImageProperties
  37  * \brief Generic ITKImage reader
  38  */
  39 #ifdef _USE_ITK_
  40
  41 #ifndef __bbtkITKImageProperties_h__
  42 #define __bbtkITKImageProperties_h__
  43
  44 #include "bbtkAtomicBlackBox.h"
  45 #include "bbitkImage.h"
  46 #include "bbitkImageRegion.h"
  47
  48 namespace bbitk
  49 {
  50
  51   //=================================================================
  52   // BlackBox declaration
  53   class ImageProperties : public bbtk::AtomicBlackBox
  54   {
  55
  56     BBTK_BLACK_BOX_INTERFACE(ImageProperties,
  57                              bbtk::AtomicBlackBox);
  58
  59     BBTK_DECLARE_INPUT(In,anyImagePointer);
  60     BBTK_DECLARE_OUTPUT(TypeName,std::string);
  61     BBTK_DECLARE_OUTPUT(Dimension,unsigned int);
  62     BBTK_DECLARE_OUTPUT(LargestPossibleRegion,anyImageRegion);
  63     BBTK_DECLARE_OUTPUT(Index,std::vector<int>);
  64     BBTK_DECLARE_OUTPUT(Size,std::vector<int>);
  65     BBTK_DECLARE_OUTPUT(Spacing,std::vector<float>);
  66         BBTK_DECLARE_OUTPUT(MinMax,std::vector<float>);
  67     BBTK_PROCESS(DoIt);
  68     void DoIt();
  69
  70   private:
  71     // Template doit method
  72     template<class ImageType> void DoIt();
  73   };
  74   //=================================================================
  75
  76   //=================================================================
  77   // BlackBox description
  78   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImageProperties,bbtk::AtomicBlackBox);
  79   BBTK_NAME("ImageProperties");
  80   BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
  81   BBTK_CATEGORY("image");
  82   BBTK_DESCRIPTION("Outputs different properties of an image (type, dimension, size, spacing, ...)");
  83   BBTK_INPUT(ImageProperties,In,"Input image",anyImagePointer,"");
  84   BBTK_OUTPUT(ImageProperties,TypeName,"Pixel type name",std::string,"pixel type");
  85   BBTK_OUTPUT(ImageProperties,Dimension,"Dimension",unsigned int,"image dimension");
  86   BBTK_OUTPUT(ImageProperties,LargestPossibleRegion,"Global extent of the image",anyImageRegion,"");
  87   BBTK_OUTPUT(ImageProperties,Index,"Origin of the image",std::vector<int>,"image index");
  88   BBTK_OUTPUT(ImageProperties,Size,"Size in each dimension",std::vector<int>,"image size");
  89   BBTK_OUTPUT(ImageProperties,Spacing,"Size of the voxels",std::vector<float>,"voxel size");
  90   BBTK_OUTPUT(ImageProperties,MinMax,"Minimum and the maximum intensity values of an image",std::vector<float>,"");
  91   BBTK_END_DESCRIBE_BLACK_BOX(ImageProperties);
  92   //=================================================================
  93
  94 }
  95 //namespace bbitk
  96 #endif
  97
  98 #endif