\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
% ==========================================
\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)
\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
\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
\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.
Automatically assigned to Atomic Black Boxes (c++ defined) \\ \hline
\texttt{complex box} & : System category.
Automatically assigned to Complex Black Boxes (script defined) \\ \hline
- \texttt{command line} & : Script which defines a command line application (no embedded GUI, but command line imput parameters) \\ \hline
+ \texttt{command line} & : Script which defines a command line application \\
+ & :(no embedded GUI, but command line imput parameters) \\ \hline
\texttt{demo} & : Demonstration \\ \hline
\texttt{devel} & : Developer tool (bbCreatePackage.bbs, ...) \\ \hline
- \texttt{dicom} & : DICOM aware box \\ \hline
+ \texttt{dicom} & : DICOM aware box \\ \hline
\texttt{example} & : Example script showing a box use-case \\ \hline
\texttt{filter} & : Image processing box \\ \hline
\texttt{image} & : Image processing related box \\ \hline
\texttt{interaction} & : \\ \hline
- \texttt{math} & : Mathematical operations\\ \hline
- \texttt{mesh} & : Mesh processing related box \\ \hline
+ \texttt{math} & : Mathematical operations \\ \hline
+ \texttt{mesh} & : Mesh processing related box \\ \hline
\texttt{misc} & : A box that cannot be put in other category ! \\ \hline
\texttt{read/write} & : Box that read or write data from or to disk \\ \hline
- \texttt{viewer} & : Box which displays some data \\ \hline
- \texttt{widget} & : Piece of graphical interface \\ \hline
+ \texttt{viewer} & : Box which displays some data \\ \hline
+ \texttt{widget} & : Piece of graphical interface \\ \hline
\texttt{3D object creator} & : Sophisticated 3D widget \\ \hline
\texttt{toolsbbtk} & : Component of bbStudio \\ \hline
\end{tabular}
\end{table}
+% ==========================================
+\begin{table}[!ht]
+\caption{\label{kinds} \texttt{Black Box} kinds}
+\small
+\begin{tabular}{|ll|}
+\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
+\texttt{GUI} & : \\ \hline
+\texttt{DEFAULT\_GUI} & : \\ \hline
+\texttt{ALL} & : If kind='ALL' then sets the level for all kinds \\ \hline
+\end{tabular}
+\end{table}
\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
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. \\
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. \\
Outputs : \\
- Out : the isosurface mesh (vtkPolyData*)
- \paragraph{ImageGaussianSmooth}\\
+ \paragraph{ImageGaussianSmooth}
Performs a gaussian convolution of the input image\\
Receives : \\
- In : an image (vtkImageData*)\\
Outputs :
- Out : The image (vtkImageData*)
- \paragraph{SegmentationConnectivity} \\
+ \paragraph{SegmentationConnectivity}
Segmentation with min max threshold and connectivity \\
Receives : \\
- In : an image (vtkImageData*)\\
\texttt{include} & \texttt{<package-name>} &
Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline
+\texttt{kind} & \texttt{<box kind>} &
+Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline
+
+
+
+
\texttt{unload} & \texttt{<package-name>}&
Unloads the package \texttt{package-name}.
The package must have been previously loaded.
\texttt{endefine} & - &
Ends the definition of a complex black box type\\ \hline
-
\texttt{author} & \texttt{<string>} &
Sets the author(s) of the complex black box currently being defined \\ \hline
Sets the description of the complex black box currently being defined
\\ \hline
-
\texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} &
Defines a new input for the current complex black box,
named \texttt{name}.
It is defined as corresponding to
-the input \texttt{input} of the box \texttt{box}.
+the input \texttt{input} of the box \texttt{box}.
+
\texttt{<help>} is the help string for the new input.
The box \texttt{box} must already have been created in the complex box
and of course have an input named \texttt{input}.
\\ \hline
-
\texttt{output} & \texttt{<name>} \texttt{<box.output>} \texttt{<help>} &
Defines a new output for the current complex black box,
named \texttt{name}.
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff