PackRecalage/src/bbPackRecalageGridOnImageGenerator.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 #
   8 #  This software is governed by the CeCILL-B license under French law and
   9 #  abiding by the rules of distribution of free software. You can  use,
  10 #  modify and/ or redistribute the software under the terms of the CeCILL-B
  11 #  license as circulated by CEA, CNRS and INRIA at the following URL
  12 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  13 #  or in the file LICENSE.txt.
  14 #
  15 #  As a counterpart to the access to the source code and  rights to copy,
  16 #  modify and redistribute granted by the license, users are provided only
  17 #  with a limited warranty  and the software's author,  the holder of the
  18 #  economic rights,  and the successive licensors  have only  limited
  19 #  liability.
  20 #
  21 #  The fact that you are presently reading this means that you have had
  22 #  knowledge of the CeCILL-B license and that you accept its terms.
  23 # ------------------------------------------------------------------------
  24 */
  25
  26
  27 //=====
  28 // Before editing this file, make sure it's a file of your own (i.e.: it wasn't generated from xml description; if so : your modifications will be lost)
  29 //=====
  30 #ifndef __bbPackRecalageGridOnImageGenerator_h_INCLUDED__
  31 #define __bbPackRecalageGridOnImageGenerator_h_INCLUDED__
  32 #include "bbPackRecalage_EXPORT.h"
  33 #include "bbtkAtomicBlackBox.h"
  34 #include "iostream"
  35
  36 //VTK
  37 #include "vtkImageData.h"
  38
  39 //OWN
  40 #include "MyGridOnImageGenerator.h"
  41
  42 namespace bbPackRecalage
  43 {
  44
  45 class bbPackRecalage_EXPORT GridOnImageGenerator
  46  :
  47    public bbtk::AtomicBlackBox
  48 {
  49   BBTK_BLACK_BOX_INTERFACE(GridOnImageGenerator,bbtk::AtomicBlackBox);
  50 //=====
  51 // Before editing this file, make sure it's a file of your own (i.e.: it wasn't generated from xml description; if so : your modifications will be lost)
  52 //=====
  53   BBTK_DECLARE_INPUT(In,vtkImageData*);
  54   BBTK_DECLARE_INPUT(GridSpcX,double);
  55   BBTK_DECLARE_INPUT(GridSpcY,double);
  56   BBTK_DECLARE_INPUT(GridSpcZ,double);
  57
  58   BBTK_DECLARE_OUTPUT(Out,vtkImageData*);
  59
  60   BBTK_PROCESS(Process);
  61   void Process();
  62 //=====
  63 // Before editing this file, make sure it's a file of your own (i.e.: it wasn't generated from xml description; if so : your modifications will be lost)
  64 //=====
  65
  66 private:
  67
  68   //Grid on image generator attribute
  69   MyGridOnImageGenerator* gridOnImageGenerator;
  70
  71 };
  72
  73 BBTK_BEGIN_DESCRIBE_BLACK_BOX(GridOnImageGenerator,bbtk::AtomicBlackBox);
  74 BBTK_NAME("GridOnImageGenerator");
  75 BBTK_AUTHOR("Alfredo Morales Pinzon, morales@creatis.insa-lyon.fr, write me if you have questions :) N'hésitez pas");
  76 BBTK_DESCRIPTION("Box that creates an grid over an image. This is usually used to visualized the deformation that takes place over an image after a transformation, specially when non-rigid registration is applied. In order to create the grid the user must specify the spacing in each direction using the image coordinates, for example in milimeters. The final image contrast is based on the maximum and minimum values over the entire image.");
  77 BBTK_CATEGORY("Registration");
  78
  79 BBTK_INPUT(GridOnImageGenerator,In,"Input image",vtkImageData*,"");
  80 BBTK_INPUT(GridOnImageGenerator,GridSpcX,"Grid spacing in X",double,"");
  81 BBTK_INPUT(GridOnImageGenerator,GridSpcY,"Grid spacing in Y",double,"");
  82 BBTK_INPUT(GridOnImageGenerator,GridSpcZ,"Grid spacing in Z",double,"");
  83
  84 BBTK_OUTPUT(GridOnImageGenerator,Out,"Output image",vtkImageData*,"");
  85 BBTK_END_DESCRIBE_BLACK_BOX(GridOnImageGenerator);
  86 //=====
  87 // Before editing this file, make sure it's a file of your own (i.e.: it wasn't generated from xml description; if so : your modifications will be lost)
  88 //=====
  89 }
  90 // EO namespace bbPackRecalage
  91
  92 #endif // __bbPackRecalageGridOnImageGenerator_h_INCLUDED__
  93