\begin{verbatim}
bbtk
creaContours
- creaReaders
- creaViewers
+ creaImageIO
+ creaLib
gdcm
itk
vtk
\item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
interaction).
\item {\bf\emph{itkvtk}} : special boxes (adaptors) to convert \itk structures into \vtk structures and conversally.
- %\item {\bf\emph{creaReaders}} : Provides hight level widgets to read images, including DICOM.
+ %\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
\item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development..
\end{itemize}
\item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
\vtk & : prints help on the package \texttt{package-name} and its boxes (with brief description). The package must have been previously loaded\\ \hline
\texttt{wxvtk} & : widget boxes based on the \vtk library.\\ \hline
\texttt{itkvtk} & : adaptors to convert \itk structures into \vtk structures and conversally.\\ \hline
-%\texttt{creaReaders} & : provides high level widgets to read images including DICOM.\\ \hline
+%\texttt{creaImageIO} & : provides high level widgets to read images including DICOM.\\ \hline
\texttt{toolsbbtk} & : Tools for bbtk administration and package development.\\ \hline
\end{tabular}
If you want to run your own uninstalled version (say : you downloaded and compiled the
cvs version in order to use a recently commited patch, but you want to be able to still use the standard version),
-you have to open a console, cd in the bin directory of the built tree and type \texttt{./bbStudio}.
+you have to open a console, cd in the \texttt{bin} directory of the built tree and type \texttt{./bbStudio}.
% ==============================================
\subsubsection{Using an already existing script}
\texttt{set} & \texttt{<box.input>} \texttt{<value>} &
Sets the input \texttt{input} of
the box named \texttt{box} to the value \texttt{value}.
-There must exist an \texttt{adaptor}
+An \texttt{adaptor} must exist
in the packages loaded which converts a \texttt{std::string}
to the type of the input \texttt{input}. \\ \hline
\texttt{print} & \texttt{<string>} &
Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
output \texttt{output} of the box named \texttt{box}.
-There must exist an \texttt{adaptor}
+An \texttt{adaptor} must exist
in the packages loaded which converts
the type of the output \texttt{output}
to a \texttt{std::string}.
connected to its inputs
are also processed recursively (pipeline processing).\\ \hline
\texttt{exec} & \texttt{freeze} &
- allows to block execution commands while keeping definition commands active.\\ \hline
+ Allows to block execution commands while keeping definition commands active.(This one is not for end user)\\ \hline
\texttt{exec} & \texttt{unfreeze} &
- turns back to 'normal' mode.\\ \hline
+ Turns back to 'normal' mode (This one is not for end user).\\ \hline
\end{tabular}
\end{table}
% ==========================================
\hline
Command & Parameters & Effect \\ \hline
-\texttt{author} & - &
-Adds the string <string> to the author information of the black box being defined \\ \hline
+\texttt{author} & \texttt{<author-name>} &
+Adds the string \texttt{<author-name>} to the author information of the black box being defined \\ \hline
-\texttt{category} & - &
- Adds the string <string> to the category information of the black box being defined \\ \hline
+\texttt{category} & \texttt{<category-name>} &
+ Adds the string \texttt{<category-name>} to the category information of the black box being defined \\ \hline
\texttt{help} & - &
Prints help on available commands \\ \hline
\texttt{box-type}.
The box type must belong to a package which has been previously loaded \\ \hline
+& \texttt{<debug-directive>} &
+[expr|-C|-D]
+ Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
+ \texttt{-C} checks the factory integrity.
+ \texttt{-D} turns on objects debug info after main ends\\ \hline
+
\texttt{include} & \texttt{<file-name>} &
Includes and executes the content of the file named \texttt{file-name}
exactly like if you were typing its content at the place were the
\texttt{include} command is. \\ \hline
\texttt{load} & \texttt{<package-name>} &
-Loads the package \texttt{package-name}\\ \hline
+Loads the package \texttt{package-name} (use it only if you know that you won't work with complex black boxes) \\ \hline
\texttt{include} & \texttt{<package-name>} &
Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline
\texttt{reset} & - & Deletes all boxes and unloads all packages so
that \bbi gets back to its initial state \\ \hline
-\texttt{quit} & - & Exits the interpreter\\ \hline
+\texttt{quit} & - & Exits the interpreter (Don't use it under \bbStudions)\\ \hline
\end{tabular}
\end{table}
\end{figure}
It allows you to query informations about what you can find in the packages (boxes and applications), using several criterions
-(warning : it's case sensitive)
+(warning : it's case sensitive, i.e \texttt{Button} will give different results thn \texttt{button} ...)
\begin {itemize}
-\item Pakages
+\item Pakages :\\
All the boxes and applications held in a given package (e.g. \texttt{wxvtk}, \texttt{std}, ...)
-\item Name
+\item Name :\\
You can query on a subpart of the name of a box or an application (e.g. \texttt{DICOM})
-\item Description
-You can query on a substring of the description of a box or an application (e.g. \texttt{DICOM})
-\item Category
+\item Description :\\
+You can query on a substring of the description of a box or an application (e.g. \texttt{utton} : user wants to get all
+the\texttt{Button} as well as the \texttt{button} )
+\item Category :\\
You can query on a sub part of the category name of a box or an application (e.g. \texttt{3D})
-\item Input Type
+\item Input Type :\\
You can query all the boxes or applications that have at least one Input entry of the given type (e.g. \texttt{int})
-\item Output Type
+\item Output Type :\\
You can query all the boxes or applications that have at least one Output entry of the given type (e.g. \texttt{int})
-\item Input Nature
+\item Input Nature :\\
You can query all the boxes or applications that have at least one Input entry of the given nature (e.g. \texttt{signal})
-\item Output Nature
+\item Output Nature :\\
You can query all the boxes or applications that have at least one Output entry of the given nature (e.g.
\texttt{signal},\texttt{file name})
\end {itemize}
--- [/home/jpr/Creatis/bbtk/binLIN/bin\Release]
\end{verbatim}
-(depending on whom you are, and whether \texttt{bbStudio} is installed or not.)\\
+(depending on who you are, and whether \texttt{bbStudio} is installed or not.)\\
Just use your favourite text editor to add :
\begin{itemize}
the name of the directory that contains the \texttt{.bbs} sripts of the package you
want to use,
\item at the end of the \texttt{PACKAGE Paths} part
- the name of the directory that contains the dynamic libraries (\texttt{.dll} or \texttt{.so}) of the package you
+ the name of the directory that contains the dynamic libraries (\texttt{.dll} or \texttt{.so}) of the package you must run the
+ option \texttt{Generate index} in the menu \texttt{Tools}.
want to use.
-\end{itemize}
+\end{itemize}
+
+If you want (and sure you will) to be able to use the Help tools as well on the features provided by this package, you must
% ==========================================
\vspace{0.5cm}\hrule \\
\section{Using black boxes in \CPP programs}
// Execution pipeline
// ------------------
- // We have to pass the 'factory', in order to call automatically an adaptor, if necessary.
+ // We have to pass the 'factory', in order to call automatically an adaptor,
+ // if necessary.
bbtk::Connection::Pointer s2t = bbtk::Connection::New(slider,"Out",
text,"In",
factory);
git://git.creatis.insa-lyon.fr / bbtk.git / commitdiff