]> Creatis software - bbtk.git/blob - kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
Feature #2006 Black Box for BitmapButtons
[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / VTK_ImageAlgorithm-template.xml
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 <?xml version="1.0" encoding="iso-8859-1"?>
29 <!--==========================================================================
30    STARTS THE DESCRIPTION OF THE BLACK BOX -->
31
32 <blackbox name="__BLACKBOXNAME__" type="VTK_ImageAlgorithm">
33
34  <!--========================================================================
35     THE BOX DOCUMENTATION -->
36
37 <author>__AUTHOR__</author>
38 <description><PRE>__DESCRIPTION__</PRE></description>
39 <category>__CategoryBlackBox__</category>
40
41 <!--========================================================================
42     #include directives to be put in the .h generated
43     There must be one tag per file to include -->
44
45 <include>vtkImageAnisotropicDiffusion3D.h</include> 
46 <include>vtkImageData.h                  </include> 
47
48   <!--========================================================================
49     THE vtk class the box inherits from (if any) -->
50 <vtkparent>vtkImageAnisotropicDiffusion3D</vtkparent>
51
52  <!--========================================================================
53     INPUTS/OUTPUTS DECLARATION -->
54
55 <input name="In" type="vtkImageData*" special="vtk input" description="Input image"/>
56 <output name="Out" type="vtkImageData*" special="vtk output" description="Output image"/>
57 <input name="DiffusionThreshold" type="double" special="vtk parameter" description="Difference threshold that stops diffusion"/>
58
59   <!--========================================================================
60     CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
61     THE CONSTRUCTION METHOD BODY :
62     Generaly you initialize the Input variables with their default values
63     This is also where you should allocate the output pointers -->
64
65   <constructor>
66   <PRE>
67     bbSetInputIn(0);
68   </PRE>
69   </constructor>
70
71   <!-- THE COPY-CONSTRUCTION METHOD BODY :
72     Here does nothing 
73     But this is where you should allocate the output pointers if any
74     and copy the pointed values (to avoid bug caused by multiple references)-->
75   <copyconstructor>
76   <PRE>
77   </PRE>
78   </copyconstructor>
79
80   <!-- THE DESTRUCTION METHOD BODY :
81     Here does nothing 
82     but this is where you should desallocate the output pointers if any -->
83
84   <destructor>
85   <PRE>
86
87   </PRE>
88   </destructor>
89
90 <!--=======================================================================-->
91 <!-- END OF BLACK BOX DESCRIPTION -->
92 </blackbox>
93