Text2D vtk

[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / VTK_ImageAlgorithm-template.xml

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
index 3f0f0eccbe4297ae58a561be635b644b308e065b..9ffe86787993c63fc3fbf78b099c2a1b59c73c80 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
@@ -1,19 +1,93 @@
+<!--
+ # ---------------------------------------------------------------------
+ #
+ # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+ #                        pour la SantÈ)
+ # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+ # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+ # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+ #
+ #  This software is governed by the CeCILL-B license under French law and
+ #  abiding by the rules of distribution of free software. You can  use,
+ #  modify and/ or redistribute the software under the terms of the CeCILL-B
+ #  license as circulated by CEA, CNRS and INRIA at the following URL
+ #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+ #  or in the file LICENSE.txt.
+ #
+ #  As a counterpart to the access to the source code and  rights to copy,
+ #  modify and redistribute granted by the license, users are provided only
+ #  with a limited warranty  and the software's author,  the holder of the
+ #  economic rights,  and the successive licensors  have only  limited
+ #  liability.
+ #
+ #  The fact that you are presently reading this means that you have had
+ #  knowledge of the CeCILL-B license and that you accept its terms.
+ # ------------------------------------------------------------------------ */
+ -->
+
 <?xml version="1.0" encoding="iso-8859-1"?>
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 
 <blackbox name="__BLACKBOXNAME__" type="VTK_ImageAlgorithm">
 
+ <!--========================================================================
+    THE BOX DOCUMENTATION -->
+
 <author>__AUTHOR__</author>
 <description><PRE>__DESCRIPTION__</PRE></description>
 <category>__CategoryBlackBox__</category>
 
+<!--========================================================================
+    #include directives to be put in the .h generated
+    There must be one tag per file to include -->
+
 <include>vtkImageAnisotropicDiffusion3D.h</include> 
-<include>vtkImageData.h</include> 
+<include>vtkImageData.h                  </include> 
+
+  <!--========================================================================
+    THE vtk class the box inherits from (if any) -->
 <vtkparent>vtkImageAnisotropicDiffusion3D</vtkparent>
 
+ <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
+
 <input name="In" type="vtkImageData*" special="vtk input" description="Input image"/>
 <output name="Out" type="vtkImageData*" special="vtk output" description="Output image"/>
 <input name="DiffusionThreshold" type="double" special="vtk parameter" description="Difference threshold that stops diffusion"/>
 
-</blackbox>
+  <!--========================================================================
+    CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
+    THE CONSTRUCTION METHOD BODY :
+    Generaly you initialize the Input variables with their default values
+    This is also where you should allocate the output pointers -->
 
+  <constructor>
+  <PRE>
+    bbSetInputIn(0);
+  </PRE>
+  </constructor>
+
+  <!-- THE COPY-CONSTRUCTION METHOD BODY :
+    Here does nothing 
+    But this is where you should allocate the output pointers if any
+    and copy the pointed values (to avoid bug caused by multiple references)-->
+  <copyconstructor>
+  <PRE>
+  </PRE>
+  </copyconstructor>
+
+  <!-- THE DESTRUCTION METHOD BODY :
+    Here does nothing 
+    but this is where you should desallocate the output pointers if any -->
+
+  <destructor>
+  <PRE>
+
+  </PRE>
+  </destructor>
+
+<!--=======================================================================-->
+<!-- END OF BLACK BOX DESCRIPTION -->
+</blackbox>