]> Creatis software - bbtk.git/blob - packages/vtk/src/bbvtkMIPCreator.h
re-indent / Fix comments
[bbtk.git] / packages / vtk / src / bbvtkMIPCreator.h
1 /*=========================================================================                                                                               
2   Program:   bbtk
3   Module:    $RCSfile: bbvtkMIPCreator.h,v $
4   Language:  C++
5   Date:      $Date: 2010/04/08 14:37:59 $
6   Version:   $Revision: 1.9 $
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  * \brief Short description in one line
33  * 
34  * Long description which 
35  * can span multiple lines
36  */
37 /**
38  * \file 
39  * \brief Pattern for the definition of a new type of Node (header)
40  */
41 /**
42  * \class bbtk::NodePatern 
43  * \brief Pattern for the definition of a new type of Node 
44  */
45
46 #ifdef _USE_VTK_
47
48 #ifndef __bbvtkMIPCreator_h_INCLUDED__
49 #define __bbvtkMIPCreator_h_INCLUDED__
50
51 #include "bbtkAtomicBlackBox.h"
52
53 #include "vtkImageData.h"
54 #include <vtkImageShiftScale.h>
55 #include <vtkVolumeRayCastMIPFunction.h>
56 #include <vtkVolumeRayCastMapper.h>
57 #include "vtkProp3D.h"
58 #include "vtkVolume.h"
59
60 #include "bbvtk_EXPORT.h"
61
62 namespace bbvtk
63 {
64   class bbvtk_EXPORT MIPCreator : public bbtk::AtomicBlackBox
65   { 
66   public:
67     BBTK_BLACK_BOX_INTERFACE(MIPCreator,bbtk::AtomicBlackBox);
68     //    BBTK_DECLARE_INPUT(Contour,int);
69     BBTK_DECLARE_INPUT(In,vtkImageData *);
70     BBTK_DECLARE_INPUT(Shift,int);
71     BBTK_DECLARE_INPUT(Scale,float);
72     BBTK_DECLARE_OUTPUT(Out,vtkProp3D*);
73     BBTK_PROCESS(Process);
74     void Process();
75     
76   protected:
77   private:
78     vtkImageShiftScale                  *mCast;
79     vtkVolumeRayCastMIPFunction         *mMIP;
80     vtkVolumeRayCastMapper              *mMapper;
81     vtkVolume                           *mVolume;
82   };
83    
84   //=================================================================
85   // UserBlackBox description
86   BBTK_BEGIN_DESCRIBE_BLACK_BOX(MIPCreator,bbtk::AtomicBlackBox);
87   BBTK_NAME("MIPCreator");
88   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
89   BBTK_DESCRIPTION("Creates a Maximum Intensity Projection (MIP) view of a 3D image. Creates a vtkProp3D object to insert into a 3D scene (e.g. a Viewer3D)");
90   BBTK_CATEGORY("3D object creator");
91   BBTK_INPUT(MIPCreator,Shift,"Gray scale shift",int,"");
92   BBTK_INPUT(MIPCreator,Scale,"Gray scale scaling",float,"");
93   BBTK_INPUT(MIPCreator,In,"Input Image",vtkImageData *,"");
94   BBTK_OUTPUT(MIPCreator,Out,"MIP object to plug into a 3D viewer",vtkProp3D*,"");
95   BBTK_END_DESCRIBE_BLACK_BOX(MIPCreator);
96   //=================================================================
97
98 }//namespace bbvtk
99
100 #endif  //__bbtvtkMIPCreator_h__
101
102 #endif //_USE_VTK_
103