*** empty log message ***

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

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index 045b66bd9484276c5b16c7bd870c7a41e55d1cbf..bef81cc1074033761e3098d39cccc8bfd7c45692 100644 (file)
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -2,10 +2,23 @@
 \documentclass[11pt,final,a4paper]{article}
 \input{config.tex}
 \begin{document}
-\title{The Black Box Toolkit\\User's Guide}
-\date{\today}
-\author{Laurent Guigues}
-\maketitle
+\begin{center}
+
+{\Large \BBTK}
+\vspace{1cm}
+
+{\Huge User's Guide}
+\vspace{1cm}
+
+\bbtk version 1.0
+\vspace{0.5cm}
+
+September 10th 2008
+\vspace{0.5cm}
+
+Laurent Guigues, Jean-Pierre Roux
+\end{center}
+
 % ==========================================
 \tableofcontents
 % ==========================================
@@ -190,7 +203,9 @@ involve complex graphical interfaces.
 \section{The Development environment (bbStudio)}
 \label{bbStudio}
 
-Just run it, typing in a console \texttt{bbed}.
+Just run it, typing in a console \bbStudio 
+or clicking on its icon or its menu entry.
+At start, \bbStudio opens with the 'Help' tab selected.
 You'll get something like in figure 
 \ref{bbi-fig-bbStudio-gui}
 (the exact appearance of \bbStudio is system and \bbtk version dependent)
@@ -202,7 +217,8 @@ You'll get something like in figure
 \end{center}
 \end{figure}
 
-All the entries of this Help 'bookmark' are self-explanatory :
+The 'Help' tab of \bbStudio is used to browse the html help of \BBTK.
+All the entries of the starting page are self-explanatory :
 
  \begin{itemize}
    \item {\bf\emph{Wiki}}: Direct link to the bbtk Wiki (intranet only, right now, www
@@ -229,7 +245,7 @@ All the entries of this Help 'bookmark' are self-explanatory :
 \begin{table}[!ht]
 \caption{\label{bbi-list_of_packages} List of bbtk supplied packages.}
 \small
-\begin{tabular}{|ll||}
+\begin{tabular}{|lp{10cm}|}
 \hline
 Package         & What it's used for \\ \hline
 \texttt{std}    & : the 'standard' package including basic useful boxes \\ \hline 
@@ -250,9 +266,9 @@ Package         & What it's used for \\ \hline
 \begin{table}[!ht]
 \caption{\label{categories} \texttt{Black Box} categories}
 \small
-\begin{tabular}{|ll|}
+\begin{tabular}{|lp{10cm}|}
 \hline
- \texttt{Categ name}     & : Meaning                                          \\ \hline \\ \hline
+ \texttt{Category name}     & : Meaning                                          \\ \hline \\ \hline
  \texttt{adaptor}        & : Adaptor box                                      \\ \hline
  \texttt{application}    & : Final application, end user intended             \\ \hline
  \texttt{atomic box}     & : System category.
@@ -666,8 +682,10 @@ To process this special substrings, \bbi does:
 \item postpone an implicit 'new line' character to the string
 \end{enumerate}
 
-\paragraph
+%\paragraph
+
 Box processing is needed if:
+
 \begin{itemize}
 \item at least input has changed since last processing or
 \item the input \texttt{'BoxProcessMode'} of the box is set to 
@@ -1518,7 +1536,7 @@ It contains some vtk based image processing filters :
      Creates a Cone 
 
      \paragraph{ImageAnisotropicDiffusion3D}
-vtkImageAnisotropicDiffusion3D diffuses an volume iteratively. \\
+vtk\-Image\-Anisotropic\-Diffusion\-3D dif\-fuses a volume iteratively. \\
 The neighborhood of the diffusion is determined by the instance flags. \\
 if 'Faces' is on, the 6 voxels adjoined by faces are included in the neighborhood. \\
 If 'Edges' is on the 12 edge connected voxels are included, and if 'Corners' is on, the 8 corner connected voxels are included. \\
@@ -1539,6 +1557,7 @@ The gradient between the voxel and the neighbor must be below the 'DiffusionThre
      Exports objet sizes, and Spacings
      
      \paragraph{ImageDilateErode3D}
+
      Dilates one value and erodes another.\\ 
      vtkImageDilateErode3D will dilate one value and erode another. \\
      It uses an elliptical foot print, and only erodes/dilates on the boundary of the two values. \\
@@ -1552,7 +1571,7 @@ The gradient between the voxel and the neighbor must be below the 'DiffusionThre
      Outputs : \\
      - Out : the isosurface mesh (vtkPolyData*)     
      
-     \paragraph{ImageGaussianSmooth}\\
+     \paragraph{ImageGaussianSmooth}
      Performs a gaussian convolution of the input image\\
      Receives : \\
      - In : an image (vtkImageData*)\\
@@ -1607,7 +1626,7 @@ The gradient between the voxel and the neighbor must be below the 'DiffusionThre
      Outputs :
      - Out : The image (vtkImageData*)     
      
-     \paragraph{SegmentationConnectivity} \\
+     \paragraph{SegmentationConnectivity}
      Segmentation with min max threshold and connectivity  \\  
      Receives : \\
      - In : an image (vtkImageData*)\\