Feature #1774

[bbtk.git] / kernel / doc / bbtkUsersGuide / bbtkReferenceManual.tex

diff --git a/kernel/doc/bbtkUsersGuide/bbtkReferenceManual.tex b/kernel/doc/bbtkUsersGuide/bbtkReferenceManual.tex
index 56a71c500226f5dcb1a280ae2f164b6895d0f8ab..450bf140991699abdc3c91bfbab42e1ebd399baa 100644 (file)
--- a/kernel/doc/bbtkUsersGuide/bbtkReferenceManual.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkReferenceManual.tex
@@ -1,3 +1,29 @@
+% # ---------------------------------------------------------------------
+% #
+% # 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.
+% # ------------------------------------------------------------------------ */
+%
+
 % ==========================================
 \documentclass[11pt,final,a4paper]{article}
 \input{config.tex}
@@ -5,7 +31,9 @@
 
 
 
+
 \begin{document}
+
 \begin{center}
 
 {\Large \BBTK}
@@ -18,12 +46,23 @@
 \vspace{0.5cm}
 
 
-Last modified on : September 20, 2008 \\
+Last modified on : September 20 2008 \\
 Generated on : \today 
 \vspace{0.5cm}
-
-Fantomas, Belphegor
 \end{center}
+\begin{center}
+Fr\'ed\'eric Cervenansky, Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
+\end{center}
+\begin{center}
+CREATIS, Centre de Recherche en Imagerie M\'edicale \\ CNRS UMR 5220, INSERM U1044\\
+INSA Lyon\\
+Universit\'e Claude-Bernard Lyon 1\\
+http://www.creatis.insa-lyon.fr/site/en/CreatoolsBBTK
+\end{center}
+
+
+
+
 
 % ==========================================
 \tableofcontents
@@ -59,8 +98,8 @@ their new affectation.
 \small
 \begin{tabular}{|ll|}
 \hline
-\texttt{Kind name}                & : Meaning                         \\ \hline \\ \hline
-\texttt{ADAPTOR}                  & : Adaptor Box                     \\ \hline
+\texttt{Kind name}                & : Meaning                          \\ \hline \\ \hline
+\texttt{ADAPTOR}                  & : Adaptor Box                      \\ \hline
 \texttt{DEFAULT\_ADAPTOR}         & :                                  \\ \hline
 \texttt{WIDGET\_ADAPTOR}          & :                                  \\ \hline
 \texttt{DEFAULT\_WIDGET\_ADAPTOR} & :                                  \\ \hline
@@ -76,7 +115,7 @@ their new affectation.
    \bf\emph{Boxes} : Box retrieving on various criterions :
       \begin{itemize}
         \item {\bf\emph{By name}} (Alphabetical list)
-        \item {\bf\emph{By package}} (see table : \ref{bbi-list_of_packages})
+        \item {\bf\emph{By package}}  (see table : \ref{bbi-list_of_packages})
         \item {\bf\emph{By category}} (see table : \ref{categories})
         \item {\bf\emph{Adaptors}} Used internaly to perform type conversions (not end user intended)     
       \end{itemize}
@@ -483,7 +522,7 @@ It contains two atomic black boxes.
 
 It contains too some sophisticated complex black boxes :
  
-     \paragraph{IsoSurfaceWithControls} 
+     \paragraph{IsoSurfaceWidget} 
      Image iso-surface extractor (vtk::IsoSurfaceExtractor) with associated control panel (isovalue, opacity and colour)\\
      Receives :\\
      - an initial isovalue (Isovalue)
@@ -492,7 +531,7 @@ It contains too some sophisticated complex black boxes :
      Outputs :\\
      \textless vtkProp3D* \textgreater (In)\\
       
-     \paragraph{MIPWithControls}     
+     \paragraph{MIPWidget}     
      Maximum Intensity Projection (MIP) creator (vtk::MIPCreator) with associated control panel (shift and scale) \\
     Receives :\\
      - an initial scale (Scale)