2320 crea Feature New Normal Documentation of the bbitkImage mechanism

[crea.git] / appli / creaNewProject / NewProject / bbtk_mySamplePackage_PKG / src / bbmySamplePackagemySampleBoxWithITK.h

diff --git a/appli/creaNewProject/NewProject/bbtk_mySamplePackage_PKG/src/bbmySamplePackagemySampleBoxWithITK.h b/appli/creaNewProject/NewProject/bbtk_mySamplePackage_PKG/src/bbmySamplePackagemySampleBoxWithITK.h
index c2c36f6af2290bf4bc708c3792f829c4aef61ab3..7c0d888a9c04b7918967d84694b7972e0f1dac2e 100644 (file)
--- a/appli/creaNewProject/NewProject/bbtk_mySamplePackage_PKG/src/bbmySamplePackagemySampleBoxWithITK.h
+++ b/appli/creaNewProject/NewProject/bbtk_mySamplePackage_PKG/src/bbmySamplePackagemySampleBoxWithITK.h
@@ -1,3 +1,30 @@
+/*
+# ---------------------------------------------------------------------
+#
+# 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.
+# ------------------------------------------------------------------------ 
+*/ 
+
 
 #ifndef __bbmySamplePackagemySampleBoxWithITK_h_INCLUDED__
 #define __bbmySamplePackagemySampleBoxWithITK_h_INCLUDED__
@@ -11,14 +38,28 @@
 //
 // 2. Modify de CMakeList.txt file of this package.
 //             2.1. Uncomment the line  SET(${BBTK_PACKAGE_NAME}_USE_ITK  ON)
-//             2.2. Add the line:       
-//                             ${BBTK_DIR}/../../../include/bbitk
+//             2.2. Add the lines:       
+//                             ${BBTK_DIR}/../../../include/bbitk      # linux
+//                             ${BBTK_DIR}/include/bbitk               # windows
 //                  In the SET(${BBTK_PACKAGE_NAME}_INCLUDE_DIRS   section
 //
 // 3. In the .h file of your box, don't forget:
 //             3.1. Define the DIM and the TYPE of the images
 //                   (Comment out the BBTK_ITK_IMAGE_DIM_xxx
 //                    and the BBTK_ITK_IMAGE_TYPE_xxx_t you don't need)
+//                    Ex:
+//                             // Definition of the DIM and TYPE of the itkImage ..
+//                             #define BBTK_ITK_IMAGE_DIM_2
+//                             #define BBTK_ITK_IMAGE_DIM_3
+//                             #define BBTK_ITK_IMAGE_DIM_4
+//                             #define BBTK_ITK_IMAGE_TYPE_int8_t
+//                             #define BBTK_ITK_IMAGE_TYPE_uint8_t
+//                             #define BBTK_ITK_IMAGE_TYPE_int16_t
+//                             #define BBTK_ITK_IMAGE_TYPE_uint16_t
+//                             #define BBTK_ITK_IMAGE_TYPE_int32_t
+//                             #define BBTK_ITK_IMAGE_TYPE_uint32_t
+//                             #define BBTK_ITK_IMAGE_TYPE_float
+//                             #define BBTK_ITK_IMAGE_TYPE_double
 //             3.2. Define the ProcessTemplate method with the 
 //                BBTK_TEMPLATE_ITK_IMAGE_SWITCH mechanism.
 //