]> Creatis software - bbtk.git/blob - packages/vtk/src/bbvtkMIPCreator.h
Feature #1774
[bbtk.git] / packages / vtk / src / bbvtkMIPCreator.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  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9  #
10  #  This software is governed by the CeCILL-B license under French law and
11  #  abiding by the rules of distribution of free software. You can  use,
12  #  modify and/ or redistribute the software under the terms of the CeCILL-B
13  #  license as circulated by CEA, CNRS and INRIA at the following URL
14  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
15  #  or in the file LICENSE.txt.
16  #
17  #  As a counterpart to the access to the source code and  rights to copy,
18  #  modify and redistribute granted by the license, users are provided only
19  #  with a limited warranty  and the software's author,  the holder of the
20  #  economic rights,  and the successive licensors  have only  limited
21  #  liability.
22  #
23  #  The fact that you are presently reading this means that you have had
24  #  knowledge of the CeCILL-B license and that you accept its terms.
25  # ------------------------------------------------------------------------ */
26
27
28 /*=========================================================================
29   Program:   bbtk
30   Module:    $RCSfile: bbvtkMIPCreator.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:51:58 $
33   Version:   $Revision: 1.11 $
34 =========================================================================*/
35
36 /**
37  * \brief Short description in one line
38  *
39  * Long description which
40  * can span multiple lines
41  */
42 /**
43  * \file
44  * \brief Pattern for the definition of a new type of Node (header)
45  */
46 /**
47  * \class bbtk::NodePatern
48  * \brief Pattern for the definition of a new type of Node
49  */
50
51 #ifdef _USE_VTK_
52
53 #ifndef __bbvtkMIPCreator_h_INCLUDED__
54 #define __bbvtkMIPCreator_h_INCLUDED__
55
56 #include "bbtkAtomicBlackBox.h"
57
58 #include "vtkImageData.h"
59 #include <vtkImageShiftScale.h>
60 #include <vtkVolumeRayCastMIPFunction.h>
61 #include <vtkVolumeRayCastMapper.h>
62 #include "vtkProp3D.h"
63 #include "vtkVolume.h"
64
65 #include "bbvtk_EXPORT.h"
66
67 namespace bbvtk
68 {
69    class bbvtk_EXPORT MIPCreator : public bbtk::AtomicBlackBox
70   {
71   public:
72     BBTK_BLACK_BOX_INTERFACE(MIPCreator,bbtk::AtomicBlackBox);
73     //    BBTK_DECLARE_INPUT(Contour,int);
74     BBTK_DECLARE_INPUT(In,vtkImageData *);
75     BBTK_DECLARE_INPUT(DensityPoints, std::vector<double> );
76     BBTK_DECLARE_INPUT(OpacityValues, std::vector<double> );
77     BBTK_DECLARE_INPUT(MinColorWindow, double );
78     BBTK_DECLARE_INPUT(MaxColorWindow, double );
79     BBTK_DECLARE_OUTPUT(Out,vtkProp3D*);
80     BBTK_PROCESS(Process);
81     void Process();
82
83   protected:
84   private:
85     std::vector<double> DensityPoints;
86     std::vector<double> OpacityValues;
87     vtkImageShiftScale                  *mCast;
88     vtkVolumeRayCastMIPFunction         *mMIP;
89     vtkVolumeRayCastMapper              *mMapper;
90     vtkVolume                           *mVolume;
91     vtkPiecewiseFunction *opacityTransferFunction;
92     vtkPiecewiseFunction *grayTransferFunction;
93     double scale;
94   };
95
96   //=================================================================
97   // UserBlackBox description
98   BBTK_BEGIN_DESCRIBE_BLACK_BOX(MIPCreator,bbtk::AtomicBlackBox);
99   BBTK_NAME("MIPCreator");
100   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
101   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)");
102   BBTK_CATEGORY("3D object creator");
103   BBTK_INPUT(MIPCreator,DensityPoints,"Density values of the original image", std::vector<double>,"");
104   BBTK_INPUT(MIPCreator,OpacityValues,"Opacity values for the MIP function", std::vector<double>,"");
105   BBTK_INPUT(MIPCreator,In,"Input Image",vtkImageData *,"");
106   BBTK_INPUT(MIPCreator,MinColorWindow,"Minimum density value for MIP color function", double,"");
107   BBTK_INPUT(MIPCreator,MaxColorWindow,"Maximum density value for MIP color function", double,"");
108   BBTK_OUTPUT(MIPCreator,Out,"MIP object to plug into a 3D viewer",vtkProp3D*,"");
109   BBTK_END_DESCRIBE_BLACK_BOX(MIPCreator);
110   //=================================================================
111
112 }//namespace bbvtk
113
114 #endif  //__bbtvtkMIPCreator_h__
115
116 #endif //_USE_VTK_
117