]> Creatis software - bbtk.git/blobdiff - packages/itk/src/bbitkImageProperties.h
*** empty log message ***
[bbtk.git] / packages / itk / src / bbitkImageProperties.h
index f6083b9e25456be60f1721d50f8cd5e6e72c557d..8f20835356c61f5be23ea89786fe7eaedc3c62a2 100644 (file)
@@ -1,20 +1,33 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbitkImageProperties.h,v $
   Language:  C++
-  Date:      $Date: 2008/02/05 12:03:01 $
-  Version:   $Revision: 1.1 $
-                                                                                
-  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
-  l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
-                                                                                
-     This software is distributed WITHOUT ANY WARRANTY; without even
-     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-     PURPOSE.  See the above copyright notices for more information.
-                                                                                
-=========================================================================*//**
+  Date:      $Date: 2008/10/17 08:18:21 $
+  Version:   $Revision: 1.8 $
+=========================================================================*/
+
+/* ---------------------------------------------------------------------
+
+* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
+* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
+*
+*  This software is governed by the CeCILL-B license under French law and 
+*  abiding by the rules of distribution of free software. You can  use, 
+*  modify and/ or redistribute the software under the terms of the CeCILL-B 
+*  license as circulated by CEA, CNRS and INRIA at the following URL 
+*  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
+*  or in the file LICENSE.txt.
+*
+*  As a counterpart to the access to the source code and  rights to copy,
+*  modify and redistribute granted by the license, users are provided only
+*  with a limited warranty  and the software's author,  the holder of the
+*  economic rights,  and the successive licensors  have only  limited
+*  liability. 
+*
+*  The fact that you are presently reading this means that you have had
+*  knowledge of the CeCILL-B license and that you accept its terms.
+* ------------------------------------------------------------------------ */                                                                         
+
 /**
  * \file 
  * \brief class ITKImageProperties : generic ITKImage reader
 #ifndef __bbtkITKImageProperties_h__
 #define __bbtkITKImageProperties_h__
 
-#include "bbtkUserBlackBox.h"
+#include "bbtkAtomicBlackBox.h"
 #include "bbitkImage.h"
 #include "bbitkImageRegion.h"
 
 namespace bbitk
 {
 
-  class ImageProperties : public bbtk::UserBlackBox  
+  //=================================================================
+  // BlackBox declaration
+  class ImageProperties : public bbtk::AtomicBlackBox  
   {
     
-    BBTK_USER_BLACK_BOX_INTERFACE(ImageProperties,
-                                 bbtk::UserBlackBox);
+    BBTK_BLACK_BOX_INTERFACE(ImageProperties,
+                            bbtk::AtomicBlackBox);
 
     BBTK_DECLARE_INPUT(In,anyImagePointer);
     BBTK_DECLARE_OUTPUT(TypeName,std::string);
@@ -55,21 +70,23 @@ namespace bbitk
     // Template doit method 
     template<class ImageType> void DoIt();
   };
+  //=================================================================
   
 
   //=================================================================
-  // UserBlackBox description
-  BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImageProperties,bbtk::UserBlackBox);
+  // BlackBox description
+  BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImageProperties,bbtk::AtomicBlackBox);
   BBTK_NAME("ImageProperties");
-  BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
-  BBTK_DESCRIPTION("Extracts the different properties of an image (type, dimension, size, spacing, ...)");
-  BBTK_INPUT(ImageProperties,In,"Input image",anyImagePointer);
-  BBTK_OUTPUT(ImageProperties,TypeName,"Pixel type name",std::string);
-  BBTK_OUTPUT(ImageProperties,Dimension,"Dimension",unsigned int);
-  BBTK_OUTPUT(ImageProperties,LargestPossibleRegion,"Global extent of the image",anyImageRegion);
-  BBTK_OUTPUT(ImageProperties,Index,"Origin of the image",std::vector<int>);
-  BBTK_OUTPUT(ImageProperties,Size,"Size in each dimension",std::vector<int>);
-  BBTK_OUTPUT(ImageProperties,Spacing,"Size of the voxels",std::vector<float>);
+  BBTK_AUTHOR("laurent.guigues at creatis.insa-lyon.fr");
+  BBTK_CATEGORY("image");
+  BBTK_DESCRIPTION("Outputs different properties of an image (type, dimension, size, spacing, ...)");
+  BBTK_INPUT(ImageProperties,In,"Input image",anyImagePointer,"");
+  BBTK_OUTPUT(ImageProperties,TypeName,"Pixel type name",std::string,"pixel type");
+  BBTK_OUTPUT(ImageProperties,Dimension,"Dimension",unsigned int,"image dimension");
+  BBTK_OUTPUT(ImageProperties,LargestPossibleRegion,"Global extent of the image",anyImageRegion,"");
+  BBTK_OUTPUT(ImageProperties,Index,"Origin of the image",std::vector<int>,"image index");
+  BBTK_OUTPUT(ImageProperties,Size,"Size in each dimension",std::vector<int>,"image size");
+  BBTK_OUTPUT(ImageProperties,Spacing,"Size of the voxels",std::vector<float>,"voxel size");
   BBTK_END_DESCRIBE_BLACK_BOX(ImageProperties);
   //=================================================================