packages/vtk/src/bbvtkImagePlanes.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbvtkImagePlanes.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/12/03 13:35:32 $
   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 /**
  33  * \brief Short description in one line
  34  *
  35  * Long description which
  36  * can span multiple lines
  37  */
  38 /**
  39  * \file
  40  * \brief Pattern for the definition of a new type of Node (header)
  41  */
  42 /**
  43  * \class bbtk::NodePatern
  44  * \brief Pattern for the definition of a new type of Node
  45  */
  46
  47
  48 #ifdef _USE_VTK_
  49
  50
  51 #ifndef __bbvtkImagePlanes_h_INCLUDED__
  52 #define __bbvtkImagePlanes_h_INCLUDED__
  53
  54
  55 #include "bbtkAtomicBlackBox.h"
  56
  57
  58 class vtkImageData;
  59 class vtkImagePlaneWidget;
  60
  61 namespace bbvtk
  62 {
  63
  64   typedef std::vector<double> winLevel;
  65
  66   class /*BBTK_EXPORT*/ ImagePlanes : public bbtk::AtomicBlackBox
  67   {
  68   public:
  69     BBTK_BLACK_BOX_INTERFACE(ImagePlanes,bbtk::AtomicBlackBox);
  70     //    BBTK_DECLARE_INPUT(Contour,int);
  71     BBTK_DECLARE_INPUT(In,vtkImageData *);
  72     BBTK_DECLARE_INPUT(WindowLevel,winLevel);
  73
  74     BBTK_DECLARE_OUTPUT(PlaneX,vtkImagePlaneWidget*);
  75     BBTK_DECLARE_OUTPUT(PlaneY,vtkImagePlaneWidget*);
  76     BBTK_DECLARE_OUTPUT(PlaneZ,vtkImagePlaneWidget*);
  77     BBTK_DECLARE_OUTPUT(ImageX,vtkImageData*);
  78     BBTK_DECLARE_OUTPUT(ImageY,vtkImageData*);
  79     BBTK_DECLARE_OUTPUT(ImageZ,vtkImageData*);
  80     BBTK_PROCESS(Process);
  81     void Process();
  82
  83   protected:
  84     virtual void bbUserConstructor();
  85     virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer);
  86     virtual void bbUserDestructor();
  87     void Init();
  88   private:
  89     vtkImageData* image;
  90   };
  91
  92   //=================================================================
  93   // UserBlackBox description
  94   BBTK_BEGIN_DESCRIBE_BLACK_BOX(ImagePlanes,bbtk::AtomicBlackBox);
  95   BBTK_NAME("ImagePlanes");
  96   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  97   BBTK_DESCRIPTION("Creates three 3D planes with the input image mapped onto with which the user can interact. The output vtkImagePlaneWidget objects are to be inserted into a 3D scene (e.g. a Viewer3D)");
  98   BBTK_CATEGORY("3D object creator");
  99   BBTK_INPUT(ImagePlanes,In,"Input Image",vtkImageData *,"");
 100   BBTK_INPUT(ImagePlanes,WindowLevel,"Widdow Level",winLevel,"");
 101
 102   BBTK_OUTPUT(ImagePlanes,PlaneX,"The image plane in X direction",vtkImagePlaneWidget*,"");
 103   BBTK_OUTPUT(ImagePlanes,PlaneY,"The image plane in Y direction",vtkImagePlaneWidget*,"");
 104   BBTK_OUTPUT(ImagePlanes,PlaneZ,"The image plane in Z direction",vtkImagePlaneWidget*,"");
 105   BBTK_OUTPUT(ImagePlanes,ImageX,"The image in X direction",vtkImageData*,"");
 106   BBTK_OUTPUT(ImagePlanes,ImageY,"The image in Y direction",vtkImageData*,"");
 107   BBTK_OUTPUT(ImagePlanes,ImageZ,"The image in Z direction",vtkImageData*,"");
 108   BBTK_END_DESCRIBE_BLACK_BOX(ImagePlanes);
 109   //=================================================================
 110
 111
 112
 113
 114
 115 }//namespace bbvtk
 116
 117 #endif  //__bbtvtkImagePlanes_h__
 118
 119 #endif //_USE_VTK_
 120