]> Creatis software - bbtk.git/blob - packages/vtk/src/bbvtkPiecewiseFunction.h
Clean code
[bbtk.git] / packages / vtk / src / bbvtkPiecewiseFunction.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: bbvtkPiecewiseFunction.h,v $
31   Language:  C++
32   Date:      $Date: 2012/11/16 08:51:58 $
33   Version:   $Revision: 1.3 $
34 =========================================================================*/
35
36
37 /**
38  * \brief Short description in one line
39  * 
40  * Long description which 
41  * can span multiple lines
42  */
43 /**
44  * \file 
45  * \brief Pattern for the definition of a new type of Node (header)
46  */
47 /**
48  * \class bbtk::NodePatern 
49  * \brief Pattern for the definition of a new type of Node 
50  */
51
52
53 #ifdef _USE_VTK_
54
55
56 #ifndef __bbvtkPiecewiseFunction_h_INCLUDED__
57 #define __bbvtkPiecewiseFunction_h_INCLUDED__
58
59
60 #include "bbtkAtomicBlackBox.h"
61
62 #include "vtkPiecewiseFunction.h"
63
64 #include "bbvtk_EXPORT.h"
65
66 namespace bbvtk
67 {
68
69
70   
71   class bbvtk_EXPORT PiecewiseFunction : public bbtk::AtomicBlackBox
72   { 
73   public:
74     BBTK_BLACK_BOX_INTERFACE(PiecewiseFunction,bbtk::AtomicBlackBox);
75
76     BBTK_DECLARE_INPUT(X,std::vector<float>);
77     BBTK_DECLARE_INPUT(Y,std::vector<float>);
78     BBTK_DECLARE_OUTPUT(Out,vtkPiecewiseFunction*);
79     BBTK_PROCESS(Process);
80     void Process();
81     
82   protected:
83   };
84    
85   //=================================================================
86   // UserBlackBox description
87   BBTK_BEGIN_DESCRIBE_BLACK_BOX(PiecewiseFunction,bbtk::AtomicBlackBox);
88   BBTK_NAME("PiecewiseFunction");
89   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
90   BBTK_DESCRIPTION("Creates a piecewise function  ( see exampleVolumeRendering )");
91   BBTK_CATEGORY("misc");
92   BBTK_INPUT(PiecewiseFunction,X,"X coords of the points of the function",
93              std::vector<float>,"");
94   BBTK_INPUT(PiecewiseFunction,Y,"Y coords of the points of the function",
95              std::vector<float>,"");
96   BBTK_OUTPUT(PiecewiseFunction,Out,"The piecewise function created",
97               vtkPiecewiseFunction*,"");
98   BBTK_END_DESCRIBE_BLACK_BOX(PiecewiseFunction);
99   //=================================================================
100
101
102 }//namespace bbvtk
103
104 #endif  //__bbtvtkPiecewiseFunction_h__
105
106 #endif //_USE_VTK_
107