packages/itk/src/bbitkImageProperties.h

   1 /*=========================================================================
   2
   3   Program:   bbtk
   4   Module:    $RCSfile: bbitkImageProperties.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008/04/18 12:59:50 $
   7   Version:   $Revision: 1.6 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*//**
  18 /**
  19  * \file
  20  * \brief class ITKImageProperties : generic ITKImage reader
  21  */
  22 /**
  23  * \class bbtk::ITKImageProperties
  24  * \brief Generic ITKImage reader
  25  */
  26 #ifdef _USE_ITK_
  27
  28 #ifndef __bbtkITKImageProperties_h__
  29 #define __bbtkITKImageProperties_h__
  30
  31 #include "bbtkAtomicBlackBox.h"
  32 #include "bbitkImage.h"
  33 #include "bbitkImageRegion.h"
  34
  35 namespace bbitk
  36 {
  37
  38   //=================================================================
  39   // BlackBox declaration
  40   class ImageProperties : public bbtk::AtomicBlackBox
  41   {
  42
  43     BBTK_BLACK_BOX_INTERFACE(ImageProperties,
  44                              bbtk::AtomicBlackBox);
  45
  46     BBTK_DECLARE_INPUT(In,anyImagePointer);
  47     BBTK_DECLARE_OUTPUT(TypeName,std::string);
  48     BBTK_DECLARE_OUTPUT(Dimension,unsigned int);
  49     BBTK_DECLARE_OUTPUT(LargestPossibleRegion,anyImageRegion);
  50     BBTK_DECLARE_OUTPUT(Index,std::vector<int>);
  51     BBTK_DECLARE_OUTPUT(Size,std::vector<int>);
  52     BBTK_DECLARE_OUTPUT(Spacing,std::vector<float>);
  53     BBTK_PROCESS(DoIt);
  54     void DoIt();
  55
  56   private:
  57     // Template doit method
  58     template<class ImageType> void DoIt();
  59   };
  60   //=================================================================
  61
  62
  63   //=================================================================
  64   // BlackBox description
  65   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImageProperties,bbtk::AtomicBlackBox);
  66   BBTK_NAME("ImageProperties");
  67   BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
  68   BBTK_CATEGORY("image");
  69   BBTK_DESCRIPTION("Outputs different properties of an image (type, dimension, size, spacing, ...)");
  70   BBTK_INPUT(ImageProperties,In,"Input image",anyImagePointer,"");
  71   BBTK_OUTPUT(ImageProperties,TypeName,"Pixel type name",std::string,"pixel type");
  72   BBTK_OUTPUT(ImageProperties,Dimension,"Dimension",unsigned int,"image dimension");
  73   BBTK_OUTPUT(ImageProperties,LargestPossibleRegion,"Global extent of the image",anyImageRegion,"");
  74   BBTK_OUTPUT(ImageProperties,Index,"Origin of the image",std::vector<int>,"image index");
  75   BBTK_OUTPUT(ImageProperties,Size,"Size in each dimension",std::vector<int>,"image size");
  76   BBTK_OUTPUT(ImageProperties,Spacing,"Size of the voxels",std::vector<float>,"voxel size");
  77   BBTK_END_DESCRIBE_BLACK_BOX(ImageProperties);
  78   //=================================================================
  79
  80
  81 }
  82 //namespace bbitk
  83 #endif
  84
  85 #endif