\bbtk version 1.0
\vspace{0.5cm}
-September 10th 2008
+
+Last modified on : September 16, 2008 \\
+Generated on : \today
\vspace{0.5cm}
Laurent Guigues, Jean-Pierre Roux
providing a \CPP framework for the definition
of elementary processing \emph{units}, called {\bf black boxes},
and the definition and execution of processing \emph{chains}
-made up of these black boxes.
+made up of these black boxes. \\
+It's a part of the \texttt{Creatools suite} composed mainly of :
+\begin{verbatim}
+ bbtk
+ creaContours
+ creaReaders
+ creaViewers
+ gdcm
+ itk
+ vtk
+ wxWidgets
+\end{verbatim}
% ==========================================
\subsection{The black box philosophy}
% ==========================================
+
+\href{http://www.answers.com/topic/black-box-theater}{The Answers Dictionary} defines a {\bf black box} as
+\emph{``A device or theoretical construct with known or specified performance characteristics
+but unknown or unspecified constituents and means of operation''} \\
\href{http://en.wikipedia.org/wiki/Black_box_\%28disambiguation\%29}{Wikipedia}
defines a {\bf black box} as
\emph{``any component in a system in which only the input and output
characteristics are of interest, without regard to its internal mechanism
-or structure''}.
-I would add something very important to this definition :
+or structure''}. \\
+We should merge theese definitions. :
not only the inputs and outputs are of interest but also
\emph{what the box does} !
Hence, I would say that a black box is any \emph{\bf documented}
component of a system, letting the user know
\emph{\bf what} the box is supposed to do and
\emph{\bf how to use it}
-but not \emph{\bf how it does it}.
+but not \emph{\bf how it does it}. \\
\BBTK provides a systematic framework
to encapsulate (or ``wrap'') any
description of its inputs and outputs, etc.
\end{itemize}
-(in fact, genericity is achieved because the interface is symbolic.
-I let you think about this\dots)
+(Actually, genericity is achieved because the interface is symbolic.
+We let you think about this\dots)
-Of course, symbolic data attached to box can be
-{\bf queried}: what are the inputs/outputs of the box ?
+Of course, symbolic data attached to a box may be
+{\bf queried} : what are the inputs/outputs of the box ?
what are their type ? their description ? etc.
This allows {\bf automatic documentation} of boxes.
then gives the way to:
\begin{itemize}
-\item The definition of an {\bf interpreted language},
+\item The definition of an {\bf interpreted script language},
which allows to manipulate packages and boxes very easily in symbolic way.
-\BBTK provides one: \bbi (the Black Box Interpreter).
+\BBTK provides one : \bbi (the Black Box Interpreter).
\item {\bf Automatic documentation} of existing packages.
\texttt{html} documentation of packages is proposed by
-\bbi.
+\bbins.
\end{itemize}
-Finally, these different components allow {\bf efficient}:
+Finally, these different components allow {\bf efficient} :
\begin{itemize}
\item {\bf capitalization and reuse} of existing processing units,
% ==========================================
\subsection{\bbtk components}
% ==========================================
-\BBTK includes:
+\BBTK includes :
\begin{itemize}
\item A \CPP {\bf\emph{library}} - called \bbtk - which defines a framework
- (abstract classes) to develop black boxes and to store them into
+ (abstract classes) to develop black boxes and store them into
dynamic libraries, called black box \emph{packages}.
- \item Different {\bf\emph{black box packages}}:
+ \item Different {\bf\emph{black box packages}} :
\begin{itemize}
- \item {\bf\emph{std}}: the 'standard' package including basic useful boxes.
- \item {\bf\emph{wx}}: basic graphical interface elements (widgets: sliders, buttons, etc. based on the \texttt{wxWidgets} library).
- \item {\bf\emph{itk}}: the basic image processing package, based on the \texttt{itk} library.
- \item {\bf\emph{vtk}}: the basic image and surfaces processing package, based on the \texttt{vtk} library.
- \item {\bf\emph{wxvtk}}: widget boxes based on the \texttt{vtk} library.
- \item {\bf\emph{itkvtk}}: boxes to convert \texttt{itk} structures into \texttt{vtk} structures and conversally.
+ \item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
+ \item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).
+ \item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
+ \item {\bf\emph{vtk}} : the basic images and surfaces processing and vizualization package, based on the \vtk library.
+ \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{toolsbbtk}} : Tools for bbtk administration and package development..
\end{itemize}
- \item A {\bf\emph{Developement environment}}, called bbStudio, which provides
+ \item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
\begin{itemize}
- \item An online {\bf\emph{script editor}}, called bbed
- \item A powerfull {\bf\emph{Help environment}}, called bbhelp
+ \item An online {\bf\emph{script editor}}
+ \item A powerfull {\bf\emph{Help environment}}, called \bbPackageBrowser
whith integrated
\begin{itemize}
\item Online documentation scaning
\item Checking Demo and examples
\end{itemize}
- \item An {\bf\emph{interpreter}}, called \bbi, which allows to
+ \item An {\bf\emph{interpreter}}, called \bbins, which allows to
load black box packages and to define and execute
processing chains by connecting various black boxes of the already loaded packages.
- \item {\bf\emph{Utilities}}:
+ \item {\bf\emph{Utilities}} :
\begin{itemize}
\item \bbfy generates the \CPP code of a black box from a
description file written in \texttt{xml}.
%\item \bbdoc generates the html documentation of a black box package
- %(author, description, description of its black boxes:
+ %(author, description, description of its black boxes :
%author, description, inputs, outputs, and so on).
\item \bbCreatePackage allows to create the basic file architecture
to start the development of a new black box package.
\end{center}
\end{figure}
+\newpage
+
% ==========================================
\subsection{Structure of this guide}
% ==========================================
This guide is divided into three parts.
The first part (\ref{bbStudio}) is a brief presentation of the very intuitive Development
-environment, \bbStudio.
+environment, \bbStudions.
The second part (\ref{bb0})
-is devoted to the use of the \emph{black box interpreter} \bbi.
+is devoted to the use of the \emph{black box interpreter} \bbins.
This is the highest level of use of the toolkit, which
allows to create and execute processing chains by connecting
black boxes of existing packages.
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.
+At start, \bbStudio opens with a very minimal 'How to use' in the middle. \\
+Don't forget to read it : it will vanish at the first mouse click. \\
+\begin{verbatim}
+1) Click on the 'Demo' or 'Examples' link.
+2) Select a Demo or an Example
+3) Click on the [Source] link : the source file is loaded in bbStudio
+4) Click on the 'Run button' (the down arrow at the bottom right
+ of the source file).
+\end{verbatim}
+
You'll get something like in figure
-\ref{bbi-fig-bbStudio-gui}
-(the exact appearance of \bbStudio is system and \bbtk version dependent)
+\ref{bbi-fig-bbStudio-gui-start}
+(the exact appearance of \bbStudio is Operating System and \bbtk version dependent)
+
+\begin{figure}[!ht]
+\caption{\label{bbi-fig-bbStudio-gui-start}The bbStudio Development environment interface at start time}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png}
+\end{center}
+\end{figure}
+
+
+Feel free to resize any part you want.
+Your preferences will be kept next time you run again \bbStudio. \\
+
+Let's have a look at the resized window :
\begin{figure}[!ht]
\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface}
\end{center}
\end{figure}
-The 'Help' tab of \bbStudio is used to browse the html help of \BBTK.
-All the entries of the starting page are self-explanatory :
+You can see four parts :
+\begin{itemize}
+ \item {\bf{Files}}
+ \item {\bf{Messages}}
+ \item {\bf{Command}}
+ \item {\bf{Help}}
+\end{itemize}
+
+The stuff is written using the Advanced User Interface library of wxWidgets,
+whose 'docking manager' allows windows and toolbars to be floated/docked
+onto a frame.\\
+Please don't use this feature at learning time (the snapshots of this document
+ wouldn't match with your screen ...)
+
+\subsection{'Files' part}
+\label{bbi-FilesPart}
+
+It's the .bbs script editor.\\
+If you load a file holding a script, it will be displayed here, and you'll be
+able to modify it, to save it, to save-as it, to run it, using the
+lower toolbar
+
+
+\subsection{'Messages' part}
+\label{bbi-MessagesPart}
+
+Two kinds of messages will be output here:\\
+System messages : produced by the kernel, in case of a user mistyping, or an execution error\\
+Script messages : produced by the \bbtk equivalent of \texttt{printf} or \texttt{std::cout} in user programs
+
+\subsection{'Command' part}
+\label{bbi-CommandPart}
+This is where user will type his requirements.
+
+\subsection{'Help Contents' part}
+\label{bbi-HelpContentsPart}
+
+The 'Help Contents' part 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
- later).
- \item {\bf\emph{Demo}}: Link to some demonstrations.
- \item {\bf\emph{User's Guide}}: Step to step How-to for user who just wants to create his own
- application, just using already existing boxes.
- \item {\bf\emph{Package Developper's Guide}}: Step to step How-to for user who wants to create his own
- black boxes.
- \item {\bf\emph{Developper's Guide}}: Sorry, not yet written.
- \item {\bf\emph{Reference Manual}}: Sorry, not yet written.
- \item {\bf\emph{Doxygen Documentation}}: Doxygen source browser.
- \item {\bf\emph{Boxes}}: Box retrieving on various criterions :
+ \item {\bf\emph{Help Contents}}
+ \begin{itemize}
+ %\item {\bf\emph{Wiki}} : Direct link to the bbtk Wiki (intranet only, right now, www
+ %later).
+ \item {\bf\emph{Demo}} : Link to some 'sophisticated' demonstrations.
+ \item {\bf\emph{Examples}} : Link to some detailed 'How to use' examples
+ \end{itemize}
+
+ \item {\bf\emph{Guides}}
+ \begin{itemize}
+ \item {\bf\emph{User's Guide}} : Step to step How-to for user who wants to create his own
+ application, just using already existing boxes.
+ \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for user who wants to create his own
+ black boxes.
+ \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers. Sorry, not yet written.
+ \item {\bf\emph{Reference Manual}} : Sorry, not yet written.
+ \item {\bf\emph{Booklet}} : Vade mecum. Sorry, not yet written.
+ \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.
+ \end{itemize}
+
+ \item {\bf\emph{Boxes}} : Box retrieving on various criterions :
\begin{itemize}
- \item {\bf\emph{By name}}
+ \item {\bf\emph{By name}} (Alphabetical list)
\item {\bf\emph{By package}} (see table : \ref{bbi-list_of_packages})
- \item {\bf\emph{By category}} (see table :\ref{categories})
+ \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}
+
\end{itemize}
-
% ==========================================
\begin{table}[!ht]
\caption{\label{bbi-list_of_packages} List of bbtk supplied packages.}
\hline
Package & What it's used for \\ \hline
\texttt{std} & : the 'standard' package including basic useful boxes \\ \hline
-\texttt{wx} & : basic graphical interface elements (widgets: sliders, buttons, etc. based on the \texttt{wxWidgets} library \\ \hline
-\texttt{itk} & : the basic image processing package, based on the \texttt{itk} library. (without description)\\ \hline
-\texttt{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 \texttt{vtk} library.\\ \hline
-\texttt{itkvtk} & : boxes to convert \texttt{itk} structures into \texttt{vtk} structures and conversally.\\ \hline
+\texttt{wx} & : basic graphical interface elements (widgets : sliders, buttons, etc.) based on the \texttt{wxWidgets} library \\ \hline
+\itk & : the basic image processing package, based on the \itk library. (without description)\\ \hline
+\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{toolsbbtk} & : Tools for bbtk administration and package development.\\ \hline
\end{tabular}
\end{table}
\small
\begin{tabular}{|lp{10cm}|}
\hline
- \texttt{Category 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.
\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{widget} & : Piece of graphical interface \\ \hline
\texttt{3D object creator} & : Sophisticated 3D widget \\ \hline
\texttt{toolsbbtk} & : Component of bbStudio \\ \hline
\end{tabular}
\end{table}
+\newpage
+ .\newline
+ .\newline
+ .\newline
+ .\newline
+ .\newline
+ .\newline
+ . \newline
% ==========================================
% ==========================================
% ==========================================
\label{bb0}
% ==========================================
- Call it with the bookmark \emph{File}.
+ Atomatically open in the left upper part of bbStudio.
\begin{figure}[!ht]
\end{center}
\end{figure}
-Using the lower tool bar, you can :
+Using the lower tool bar (see figure : \ref{lowertoolbar}), you can :
+
\begin{figure}[!ht]
\caption{\label{lowertoolbar}The lower tool bar}
\begin{itemize}
- \item {\bf\emph{new}}: Create a newfile to hold a script
- \item {\bf\emph{open}}: Open a already existing file holding a script
- \item {\bf\emph{close}}: Close a file holding a script
- \item {\bf\emph{save}}: Save he current file (if modified)
- \item {\bf\emph{save as}}: Save he current file under a different name
- \item {\bf\emph{execute}}: Execute the script you just loaded/modified/written
+ \item {\bf\emph{New file}} : Create a new file to hold a script
+ \item {\bf\emph{Open file}} : Open a already existing file holding a script
+ \item {\bf\emph{Close file}} : Close a file holding a script
+ \item {\bf\emph{Save file}} : Save he current file (if modified)
+ \item {\bf\emph{Save file as}} : Save he current file under a different name
+ \item {\bf\emph{Run file}} : Execute the script you just loaded/modified/written
\end{itemize}
The script language is very simple.
Everything is done with only a very few commands (See table \ref{bbi-reference-box}).
-The philosophy of this part is also very simple:
+The philosophy of this part is also very simple :
it introduces the \bbi commands using examples,
starting with the most simple commands.
The first section of this part
(\ref{bbi-getting-started})
is designed like a tutorial,
-which progressively introduces all the concepts of \bbi.
-We suggest you run \bbi and follow the examples,
+which progressively introduces all the concepts of the command interpretor.
+We suggest you run \bbStudio and follow the examples,
to see how it works in practice.
At the end of this section,
-you will be able to use \bbi and write
+you will be able to use \bbStudio and write
own black box processing scripts.
After this tutorial,
the section \ref{bbi-more-on}
(called \emph{more on...})
-goes deeper into various issues of \bbi.
+goes deeper into various issues of the command interpretor.
Read it at your convenience,
-either linearly to learn more about \bbi,
+either linearly to learn more about \bbStudio,
or in random order to get an answer
to a particular question.
Finally, the section \ref{bbi-reference}
-summarizes all the commands of \bbi,
+summarizes all the commands of \bbStudions,
their parameters and effect.
Use it as a reference.
+
+\newpage
+
+
% ==========================================
\subsection{Getting started}
\label{bbi-getting-started}
+
+% ==============================================
+\subsubsection{Installed tree \emph{vs} Built tree}
+% ==============================================
+
+If you want to use the 'installed' version (it means you downloaded and run the Windows
+installer, or the Fedora package, or you downloaded, compiled and installed the
+cvs version), just open a console and type \bbStudions, or double click on the application icon. \\
+
+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}.
+
+% ==============================================
+\subsubsection{Using an already existing script}
+% ==============================================
+
+Run \bbStudio the way you need. \\
+In the part 'Help contents' (See figure \ref{HelpContents}), select \texttt{Examples} link.
+
+\begin{figure}[!ht]
+\caption{\label{HelpContents}Help Contents}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{HelpContents.png}
+\end{center}
+\end{figure}
+
+You will be asked to select a Box category (See figure \ref{BoxCategories}); \\
+Select \texttt{example}.
+
+
+\begin{figure}[!ht]
+\caption{\label{BoxCategories}Box Categories}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{BoxCategories.png}
+\end{center}
+\end{figure}
+
+You will be asked to choose a script (See figure \ref{example}).
+
+\begin{figure}[!ht]
+\caption{\label{example}example list}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{example.png}
+\end{center}
+\end{figure}
+
+
+
+Select \texttt{wx::exampleSlider} (See figure \ref{exampleSlider});
+
+\begin{figure}[!ht]
+\caption{\label{exampleSlider}example 'exampleSlider'}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{exampleSlider.png}
+\end{center}
+\end{figure}
+
+You can see the graphical summary representation of the current script (the elementary boxes that compose it, and their
+connections) \\
+Click on \texttt{source}, and you'll be able to see the (very simple) script,
+in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
+
+\begin{figure}[!ht]
+\caption{\label{exampleSliderSource}source code of 'exampleSlider'}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
+\end{center}
+\end{figure}
+
+Run it, using the lower toolbar (see figure : \ref{lowertoolbar})
+
+You'll get something like in \ref{execSliderSource}.
+
+\begin{figure}[!ht]
+\caption{\label{execSliderSource}execution of 'exampleSlider'}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{execSliderSource.png}
+\end{center}
+\end{figure}
+
+Feel free to move the slider, to check it actually works...
+
+
+\newpage
+
% ==========================================
\subsubsection{Creating and executing black boxes}
% ==========================================
To learn interactivelly the script language features, you can use the black box
interpreter :
-open a console and type \texttt{bbi}
+open a console and type \bbStudio
or double click on the application icon.
You get a window which looks like the one in figure
\ref{bbi-fig-bbi-gui}
-(the exact appearance of \bbi is system and \bbtk version dependent)
-\footnote{If you compiled \bbtk without \wx then \bbi does not have a
-graphical interface but a simple prompt}.
+(the exact appearance of \bbStudio is system and \bbtk version dependent)
+
+%\footnote{If you compiled \bbtk without \wx then \bbi does not have a
+%graphical interface but a simple prompt}.
\begin{figure}[!ht]
\caption{\label{bbi-fig-bbi-gui}The black box interpreter interface}
\end{center}
\end{figure}
-The 'Command' tab is subdivided into two parts :
-one single line zone at the bottom in which you can enter your commands and
-one multiple line zone in which \bbi prints out the result of your commands.
-, just using already existing boxes.
+The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of :
+one single line zone (Command), at the bottom in which you can enter your commands and
+a multiple line zone in which the Command interpreter prints out the result of your commands.
+The upper part contains the script editor; we shall not use it right now, you may reduce it
Try typing in the input zone (in this manual,
the commands entered by the user will be preceded by a prompt \textgreater) :
> help
\end{verbatim}
-you get the list of the commands of the interpreter:
+you get the list of the commands of the interpreter :
\begin{verbatim}
-Available commands:
+Available commands :
author
category
config
\end{verbatim}
To get help on a particular command type \texttt{help <command-name>},
-for example:
+for example :
\begin{verbatim}
-> help quit
+> help author
\end{verbatim}
-gives:
+gives :
\begin{verbatim}
- quit:
- usage: quit
- Quits the program (during script execution it stops the complete execution)
+ usage : author <string>
+ Adds the string <string> to the author information of the black box being defined
\end{verbatim}
The \texttt{help} command has multiple usages.
-It is used to get help on almost anything in \bbi !
-Type \texttt{'help help'} to get help on the \texttt{help} command itself:
+It is used to get help about almost anything in the interpretor!
+Type \texttt{'help help'} to get help on the \texttt{help} command itself :
\begin{verbatim}
> help help
- usage:
+ usage :
(1) help
(2) help <command name>
(3) help packages [all]
(4) help <package name> [all]
(5) help <black box type>
(6) help <black box name>
- Effect:
+ Effect :
(1) Lists all available commands;
(2) Prints help on a particular command;
(3) Lists the packages loaded and their black boxes.
(4) Prints short help on the black boxes of a package.
Add 'all' to include adaptors;
(5) Prints full help on a black box type;
- (6) Prints information on the inputs, outputs and connections of a black box instance.
+ (6) Prints information on the inputs, outputs and connectionns
+ of a black box instance.
\end{verbatim}
-At start \bbi does not know any black box.
+At start the interpretor does not know any black box.
If you type \texttt{'help packages'}, which is
-the third form of the \texttt{help} command, you get:
+the third form of the \texttt{help} command, you get :
\begin{verbatim}
> help packages
user
workspace
\end{verbatim}
-which means that \bbi only knows one package
+which means that the interpretor only knows one package
(library of black boxes) called \texttt{user}
and which contains a black box called \texttt{workspace}.
-The \texttt{user} package is an internal package to \bbi,
+The \texttt{user} package is an internal package of the interpreter,
which stores user-defined black box types.
At start, it already contains
one box, called \texttt{workspace}.
\texttt{workspace} is a special type of black box,
called complex black box, whose purpose is
to store other black boxes.
-Any black box you create in \bbi is stored
+Any black box you create in \bbStudio is stored
in \texttt{workspace}
(this will be explained in details in sections
\ref{bbi-writing-scripts} and
\ref{bbi-more-on-complex-black-boxes}).
-If you type \texttt{'help workspace'}, you get:
+If you type \texttt{'help workspace'}, you get :
\begin{verbatim}
> help workspace
-Complex Black Box <user::workspace>
- User's workspace
- By: bbi (internal)
- Category(s) : complex box;
- * No inputs
- * No outputs
- * No boxes
+ Complex Black Box <user::workspace>
+ User's workspace
+ By : bbtk
+ Category(s) : complex box;
+ * No inputs
+ * No outputs
+ * No boxes
\end{verbatim}
In the text displayed,
tell that \texttt{workspace} does not have any input
nor output nor boxes yet.
-In order to let \bbi know of some black boxes,
+In order to let the interpreter know of some black boxes,
you must load another package.
The \texttt{std} package is the ``standard'' package,
which contains basic useful black boxes.
-To load it, type:
+To load it, type :
\begin{verbatim}
> include std
\end{verbatim}
-Then if you type:
+Then if you type :
\begin{verbatim}
> help packages
\end{verbatim}
-you get something like:
+you get something like :
+
+% std
+% ASCII
+% Add
+% ConcatStrings
+% Configuration
+% Div
+% ExecBbiCommand
+% ExecSystemCommand
+% GetVectorCharElement
+% ...
+% GetVectorUShortElement
+% MagicBox
+% MakeFileName
+% Mul
+% MultipleInputs
+% PrependDataPath
+% PrependPackageDataPath
+% StringRelay
+% StringSelect
+% user
+%
+% workspace
+
+
\begin{verbatim}
-std
- Add
- ConcatStrings
- Configuration
- Div
- ...
- StringRelay
- StringSelect
-user
- workspace
->
+
+ std
+ ASCII : ascii codes sequence to string - string to ascii...
+ Add : Adds its inputs
+ ConcatStrings : String concatenation
+ Configuration : Gets configuration informations
+ Div : Divides its inputs
+ ExecBbiCommand : Executes bbi commands
+ ExecSystemCommand : Executes system (O.S.) commands
+ GetVectorCharElement : Gets the i-th element from the input vector (std...
+ ...
+ MagicBox : Takes *any kind* of data and copies it to its ou...
+ MakeFileName : Makes a kosher file name
+ Mul : Multiplies its inputs
+ MultipleInputs : This box has multiple Void inputs and one Void o...
+ StringRelay : Just copies the value of its input to its output...
+ StringSelect : Outputs the string set to the ith input Ini (In0...
+ user
+ workspace
\end{verbatim}
-Now \bbi knows the package \texttt{std} and the black boxes it provides,
-such as the \texttt{'Add'} box, the \texttt{'ConcatStrings'}. Remark that the
+Now the interpreter knows the package \texttt{std} and the black boxes it provides,
+such as the \texttt{'Add'} box, the \texttt{'ConcatStrings'} box, and so on. Remark that the
content of \texttt{std} may vary from one version to another
as new black boxes might be added to it.
-If you type:
+If you type :
\begin{verbatim}
> help Add
\end{verbatim}
-You get:
+You'll get a text help, in the 'Message' part :
\begin{verbatim}
Black Box <std::Add>
Adds its inputs
By : laurent.guigues@creatis.insa-lyon.fr
Categories : atomic box;math;
* Inputs :
- 'BoxExecute' <bbtk::Void> [signal] : Any signal received by this input executes the box
- 'BoxProcessMode' <String> [] : Sets the processing mode of the box (Pipeline | Always | Reactive)
+ 'BoxExecute' <bbtk::Void> [signal] : Any signal received by this input
+ executes the box
+ 'BoxProcessMode' <String> [] : Sets the processing mode of the box
+ (Pipeline | Always | Reactive)
'In1' <Double> [] : First number to add
'In2' <Double> [] : Second number to add
* Outputs :
'Out' <Double> [] : Result
\end{verbatim}
+You'll get as well the same information in the 'Help' Part, in html format (see figure : \ref{HelpAdd}) :
+
+\begin{figure}[!ht]
+\caption{\label{HelpAdd}The html Help}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{HelpAdd.png}
+\end{center}
+\end{figure}
+
Like previously,
the \texttt{std::} prepended to the name \texttt{Add}
means that the box \texttt{Add}
Then comes a description
(the one which was provided by the author of the box),
the author(s) of the box (usually e-mail adress(es)) and
-the categories to which the box belong.
+the categories to which the box belongs.
Finally comes the lists of inputs and outputs of the box.
For each input or output, \bbi provides
its \emph{name} (between quotes, e.g. \texttt{'ProcessMode'}),
-its \emph{type} (between \texttt{<>}, e.g. \texttt{<Int>})
+its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
and a description.
Remark that the box \texttt{Add} is not a 'complex' black box
but an 'atomic' box, hence its help does not
mention any information concerning possible internal boxes.
You can create an \emph{instance} of an \texttt{Add} box by
-the command \texttt{new}:
+the command \texttt{new} :
\begin{verbatim}
> new Add a
\end{verbatim}
Of course, like in \texttt{C} Language, you can declare multiple boxes of the
same type in \bbi.
-After the creation of the box \texttt{a}, type:
+After the creation of the box \texttt{a}, type :
\begin{verbatim}
> help workspace
\end{verbatim}
-you get:
+you get :
\begin{verbatim}
Complex Black Box <user::workspace>
User's workspace
- By: bbi (internal)
+ By : bbtk
Category(s) : complex box;
* No inputs
* No outputs
- * Boxes:
+ * Boxes :
'a' <std::Add>
\end{verbatim}
which means that \bbi workspace now contains a black box named \texttt{a},
of type \texttt{std::Add}.
-Now look back at the help on \texttt{Add} boxes:
+Now look back at the help on \texttt{Add} boxes :
you can see that this type of box has two inputs,
with name \texttt{In1} and \texttt{In2},
and an output, with name \texttt{Out}.
You can set the input \texttt{In1}
of the \texttt{Add} box \texttt{a} to the value $1$
-by the command:
+by the command :
\begin{verbatim}
> set a.In1 1
\end{verbatim}
Similarly, setting the input \texttt{In2} of \texttt{a} to the value $2$
-is done with:
+is done with :
\begin{verbatim}
> set a.In2 2
\end{verbatim}
-And you print the output \texttt{Out} of the box \texttt{a} with:
+And you print the output \texttt{Out} of the box \texttt{a} with :
\begin{verbatim}
> print "result=$a.Out$"
result=3
In the string passed to the \texttt{print} command,
each substring enclosed between a couple of \$ is considered
as the name of an output of a box.
-To process this special substrings, \bbi does:
+To process this special substrings, the interpretor :
\begin{enumerate}
\item Processes the box if needed (see below)
\item Converts the output of the box to a string if possible
(see below)
\item Substitutes the result in the string to print
-\item postpone an implicit 'new line' character to the string
+\item Postpones an implicit 'new line' character to the string
\end{enumerate}
%\paragraph
-Box processing is needed if:
+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
+\item either at least input has changed since last processing
+\item or the input \texttt{'BoxProcessMode'} of the box is set to
\texttt{'Always'}, which forces box reprocessing.
\end{itemize}
-Note that all boxes have the input \texttt{'BoxProcessMode'}.
+Note that all boxes have an input named \texttt{'BoxProcessMode'}.\\
-Another way to process the box \texttt{a} is to issue the command:
+Another way to process the box \texttt{a} is to issue the command :
\begin{verbatim}
> exec a
\end{verbatim}
It just processes the box if needed.
This command is used to execute boxes that do not have any output,
such as boxes that write something to a file or, display a
-graphical interface, and so on.
+graphical interface, and so on. \\
-To exit \bbi, type:
-\begin{verbatim}
-> quit
-Good bye !
-\end{verbatim}
+%To exit \bbi, type :
+%\begin{verbatim}
+%> quit
+%Good bye !
+%\end{verbatim}
% ==========================================
\hrule
+
\paragraph{Summary}
%\hrule
\begin{itemize}
\item The \texttt{include} command allows to load a package, and the complex black boxes that come with it..
-\item \texttt{help} gives help on:
+\item \texttt{help} gives help on :
\begin{itemize}
\item Available commands if you just type \texttt{help}.
\item A particular command if you type \texttt{help <command-name>}.
%\item \texttt{list} displays the list of black box instances created so far (by \texttt{new}).
\item \texttt{new} : creates an instance of a black box.
\item \texttt{set} : sets the value of an input of a black box.
-\item In all \bbi, to reference the input called \texttt{i}
+\item Under any component of \bbStudions, to reference the input called \texttt{i}
of a black box called \texttt{b} you must type \texttt{'b.i'}.
The same syntax holds for outputs.
\item \texttt{print} : prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. Note that an
implicit trailing 'new line character' is added at the final string.
-\item \texttt{exec} : runs the process of a box if needed.
-\item \texttt{quit} : quits \bbi.
+\item \texttt{exec} : runs, if needed, the process of a box.
+%\item \texttt{quit} : quits \bbi.
\end{itemize}
\hrule
-\paragraph{Note :}
-A more 'modern' way to proceed is to run \texttt{bbStudio}, drag and drop the \texttt{Command} bookmark to the lower \texttt{Welcome to bbStudio!} bar.
-Wou'll get something like in figure \ref{bbCommandPlusHelp} :
+%\paragraph{Note :}
+%A more 'modern' way to proceed is to run \texttt{bbStudio}, drag and drop the \texttt{Command} bookmark to the lower \texttt{Welcome to bbStudio!} bar.
+%Wou'll get something like in figure \ref{bbCommandPlusHelp} :
+
+%\begin{figure}[!ht]
+%\caption{\label{bbCommandPlusHelp}
+%An other way to run the command interpreter}
+%\begin{center}
+%\includegraphics[width=0.5\textwidth]{bbCommandPlusHelp.png}
+%\end{center}
+%\end{figure}
-\begin{figure}[!ht]
-\caption{\label{bbCommandPlusHelp}
-An other way to run the command interpreter}
-\begin{center}
-\includegraphics[width=0.5\textwidth]{bbCommandPlusHelp.png}
-\end{center}
-\end{figure}
% ==========================================
% ==========================================
Read section \ref{bbi-more-on-pipeline-processing} to get
more information on pipeline processing.
-First start \bbi and load the package \texttt{std}:
+First start \bbStudio and load the package \texttt{std}, typing :
\begin{verbatim}
> include std
\end{verbatim}
+in the 'Command' part.
Assume you want to compute $1+2+3$. You can do it by
chaining two \texttt{Add} boxes, as shown in figure
\ref{bbi-fig-connecting-black-boxes-1}.
\begin{figure}[!ht]
-\caption{\label{bbi-fig-connecting-black-boxes-1}
-A simple pipeline which adds 3 numbers}
+\caption{\label{bbi-fig-connecting-black-boxes-1} A simple pipeline which adds 3 numbers}
\begin{center}
\includegraphics[width=0.5\textwidth]{1plus2plus3.png}
\end{center}
\end{figure}
-The \bbi instructions to create and execute this pipeline are:
+The \bbi instructions to create and execute this pipeline are :
\begin{verbatim}
> new Add a
> new Add b
The first three commands build the pipeline,
the next three set \texttt{a} and \texttt{b} black boxes inputs and the last one
-prints \texttt{b} black boxe output (the pipeline is executed before printing, because the interpretor 'knows' he box \texttt{b},
+prints \texttt{b} black boxe output (the pipeline is executed before printing, because the interpretor 'knows' the box \texttt{b},
whose output is requested, is not up to date.
The command \texttt{'connect a.Out b.In1'} ``plugs'' the output
\texttt{Out} of the box \texttt{a} into the input \texttt{In1} of the
box \texttt{b}.
-Once the boxes connected, the processing of the two boxes are chained:
+Once the boxes connected, the processing of the two boxes are chained :
getting the output of \texttt{b} requires getting its inputs,
hence getting the output of \texttt{a} which is connected to it.
This pipeline mechanism can recurse into arbitrary long
\texttt{new FileSelector} will pop a File Selector, at run time, that will out the user chosen file name. \\
\texttt{new Slider} will pop a Slider, at run time, that will out an integer, used later as a slice number.\\
-\texttt{new ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a itk::ImagePointer.
+\texttt{new ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a itk::ImagePointer.\\
\texttt{new Viewer2D} display a plane, whose number id specified by an integer.\\
\\
\texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a std::string) to the input of the reader (a std::string, too).\\
into a data of the type of \texttt{Out} (other inputs or outputs may serve
to parameter the adaptor or retreive other usefull information).
-In \bbi, if you type:
+Under \bbStudions, if you type :
\begin{verbatim}
> load std
> help std all
\end{verbatim}
-you get:
+you get :
\begin{verbatim}
Package std v1.0.0 - laurent.guigues@creatis.insa-lyon.fr
Basic useful black boxes
- Black boxes:
- Add : Adds its inputs
- Cast<double,float> [DA] : Casts a double into a float
- Cast<double,int> [DA] : Casts a double into a int
- ...
- Convert<unsigned int,string> [DA] : Converts a unsigned int into a s...
- Convert<unsigned short,string> [DA] : Converts a unsigned short into a...
- Print : Prints its input to standard out...
->
+ Black boxes :
+ ...
+ BoolToString [DA] : Converts a Bool (bool) into a string
+ CastBoolToChar [DA] : Static cast from Bool (bool) to Char (signed c...
+ CastBoolToDouble [DA] : Static cast from Bool (bool) to Double (double...
+ ...
+ CastBoolToUChar [DA] : Static cast from Bool (bool) to UChar (unsigne...
+ CastBoolToUInt [DA] : Static cast from Bool (bool) to UInt (unsigned...
+ ...
+ CastUIntToBool [DA] : Static cast from UInt (unsigned int) to Bool (...
+ CastUIntToChar [DA] : Static cast from UInt (unsigned int) to Char (...
+ CastUIntToDouble [DA] : Static cast from UInt (unsigned int) to Double...
+ ...
+
\end{verbatim}
-The \texttt{Cast<?,?>} and \texttt{Convert<?,?>} boxes are \emph{default adaptors}, which is signaled by the tag \texttt{[DA]} before their descriptions.
+\texttt{[DA]} stands for \emph{default adaptor}.
Once you have loaded the package \texttt{std}, you can
plug an output of type \texttt{char} into an input of type \texttt{double}.
-When \bbi encounters the \texttt{connect} command,
+When the interpreter encounters the \texttt{connect} command,
it looks for an adequate \emph{adaptor} in the loaded packages.
In our case, as the package \texttt{std} provides the
-\texttt{Cast<char,double>} adaptor, \bbi automatically creates an
+\texttt{CastUCharToDouble} adaptor, the interpreter automatically creates an
instance of this adaptor and place it \emph{between}
the output and the input you want to connect
(however this adaptor is hidden to you,
When the pipeline is processed the
adaptor converts the output data into the required input type,
in a totally transparent way.
-In our example, the \texttt{Cast<char,double>} adaptor
+In our example, the \texttt{CastUCharToDouble} adaptor
would simply cast the value of the \texttt{char} into a \texttt{double},
-however arbitrarily complex type conversion can be done.
+however arbitrarily complex type conversion may be done.
-Question:
+\begin{verbatim}
+Question (for info-dev):
if two adaptors with the same input and output types exist
-in the packages loaded,
-which one is chosen by \bbi at connection ?
+in two different packages, currenly loaded,
+which one is chosen by the interpreter at connection time?
+A feature is missing to specify explicitely which one user wants to choose
+(use a namespace notation ?)
+
-> Role of default adaptors
+\end{verbatim}
-Note that the \texttt{set} and \texttt{print} commands of \bbi
+Note that the \texttt{set} and \texttt{print} commands of interpreter
work with adaptors from \texttt{string} to the type of the input to set
or from the type of the output to print to \texttt{string}.
Hence in order to \texttt{set} or \texttt{print} values the adequate
-adaptors must be available in the packages currently loaded.
-
+adaptors must be available in the packages currently loaded. \\
+
+
% ==========================================
\hrule
\paragraph{Summary}
%\hrule
\begin{itemize}
\item The \texttt{connect} command allows to connect two black boxes
-\item You can connect two black boxes if (and only if):
+\item You can connect two black boxes if (and only if) :
\begin{itemize}
\item The output and the input are of the same type, or
\item There is an adaptor black box in the packages loaded which
converts data of the output type into data of the input type
\end{itemize}
-\item \texttt{help <package name>} does not display the adaptors of the package. To see them use: \texttt{help <package name> all}.
+\item \texttt{help <package name>} does not display the adaptors of the package. To see them use
: \texttt{help <package name> all}.
including adaptors
\end{itemize}
\hrule
Remember the pipeline of figure
\ref{bbi-fig-connecting-black-boxes-1}, which
-computed the sum of three doubles ?
-You can view it as a whole and define
+computed the sum of three doubles?
+You can consider it as a whole and define
a new black box type, which will be a \emph{complex black box},
having three inputs and one output,
as shown in figure \ref{bbi-fig-complex-black-box-1}.
\begin{figure}[!ht]
-\caption{\label{bbi-fig-complex-black-box-1}
-Creating the complex black box \texttt{Add3}}
+\caption{\label{bbi-fig-complex-black-box-1} Creating the complex black box \texttt{Add3}}
\begin{center}
\includegraphics[width=0.5\textwidth]{Add3.png}
\end{center}
\end{figure}
The \bbi commands to define this complex black box are
-the following:
+the following :
\begin{verbatim}
> load std
> endefine
\end{verbatim}
-Explainations:
+Explainations :
As we will use \texttt{Add} boxes, we need to load the package \texttt{std}, which is done in first line.
exactly in the same way than outside a complex box definition.
The commands \texttt{author}, \texttt{description}, \texttt{input}
-and \texttt{output} are commands specific to complex boxes definition:
+and \texttt{output} are commands specific to complex boxes definition :
\texttt{author} and \texttt{description} are used for the documentation
of the new box. You can provide multiple \texttt{author} or
\texttt{input} and \texttt{output} are used to define the inputs and outputs
of the new complex box.
-Their syntax is the same: for each new input/output you need to say
+Their syntax is the same : for each new input/output you need to say
to which internal input/output it corresponds and to provide
a help string documenting the input/output.
In our example, we define that the box \texttt{Add3} has
-three inputs: \texttt{x}, \texttt{y} and \texttt{z}.
+three inputs : \texttt{x}, \texttt{y} and \texttt{z}.
The input \texttt{x} corresponds to the input \texttt{In1} of the
internal box \texttt{a}.
In the same way, the external input \texttt{y}
new box type.
After this definition, if you ask for help
-on packages, you get:
+on packages, you get :
\begin{verbatim}
> help packages
std
\end{verbatim}
The \texttt{user} package now contains a new black box type, called
-\texttt{Add3}. If you ask for help on this type of box, you get:
+\texttt{Add3}. If you ask for help on this type of box, you get :
\begin{verbatim}
> help Add3
Complex Black Box <user::Add3>
adds 3 doubles
- By: myself
- * Inputs:
- 'x' <double>: first double to add
- 'y' <double>: second double to add
- 'z' <double>: third double to add
- * Outputs:
- 'result' <double>: output
- * Boxes:
+ By : myself
+ * Inputs :
+ 'x' <double> : first double to add
+ 'y' <double> : second double to add
+ 'z' <double> : third double to add
+ * Outputs :
+ 'result' <double> : output
+ * Boxes :
'a' <std::Add>
'b' <std::Add>
\end{verbatim}
-and you can use it like any other box, for example type:
+and you can use it like any other box, for example type :
\begin{verbatim}
> new Add3 a
As a side note, we can say that, for consistency reasons, it would have been better to name
\texttt{In1}, \texttt{In2} and \texttt{In3} the inputs of the black box \texttt{Add3},
-since all the 'natural entry' of a box is named \texttt{In}, or\texttt{In}x if there are more than one 'natural
+since all the 'natural entry' of a box is named \texttt{In}, or \texttt{In}\emph{x} if there are more than one 'natural
entry'.
% ==========================================
%\hrule
\begin{itemize}
\item The \texttt{define/endefine} commands allows to define complex black box types, i.e. types of black boxes made up of other black boxes.
-Inside a \texttt{define/endefine} block:
+Inside a \texttt{define/endefine} block :
\begin{itemize}
\item The \texttt{author} and \texttt{description} commands allow to document the new type of box
\item The \texttt{input} and \texttt{output} commands allow to define the inputs and outputs of the new type of box, that is to which inputs and outputs
write the \bbi commands defining the new box
into a text file and afterwards include that file in \bbi.
Doing this, you start writing \bbi scripts.
-The conventionnal extension for such scripts is \texttt{bbs}
+The conventionnal (and mandatory) extension for such scripts is \texttt{bbs}
(black box script).
For consistency reasons, you are requested to prepend \texttt{bb} to the name.
For example, the \texttt{Add3} complex box we previously worked on
-can be defined in the \texttt{bbAdd3.bbs} file:
+can be defined in the \texttt{bbAdd3.bbs} file :
\begin{file}{bbAdd3.bbs}
\begin{verbatim}
\end{verbatim}
\end{file}
-Lines starting with a \texttt{\#} character are ignored, they
-are considered as comments by \bbi.
-To use this file in \bbi, use the \texttt{include} command:
+Lines starting with a \texttt{\#} character or a \texttt{\//\//} character are ignored, they
+are considered as comments by the interpreter.
+To use this file in \bbStudions, click on the \texttt{include} button, and browse your filestore to find the file.
\begin{verbatim}
> include bbAdd3.bbs
> help Add3
Complex Black Box <user::Add3>
adds 3 doubles
- By: myself
- * Inputs:
- 'x' <double>: first double to add
- 'y' <double>: second double to add
- 'z' <double>: third double to add
- * Outputs:
- 'result' <double>: output
- * Boxes:
+ By : myself
+ * Inputs :
+ 'x' <double> : first double to add
+ 'y' <double> : second double to add
+ 'z' <double> : third double to add
+ * Outputs :
+ 'result' <double> : output
+ * Boxes :
'a' <std::Add>
'b' <std::Add>
>
and so on ...
\end{verbatim}
-If the file has the \texttt{bbs} extension, you can ommit it and just type:
+If the file has the \texttt{bbs} extension, you can ommit it and just type :
\begin{verbatim}
> include Add3
\end{verbatim}
+\subsubsection{Creating complex black boxes that use complex black boxes}
+\label{bbi-complex-complex-black-boxes}
+
+
Of course, you can include script files in other script files,
-like in the following example:
+like in the following example :
\begin{file}{bbAdd4.bbs}
\begin{verbatim}
\end{verbatim}
\end{file}
+
+
+\subsubsection{Naming Conventions}
+\label{bbi-Naming Conventions}
+
+
% ==========================================
-\hrule
-\paragraph{Naming Conventions}
+%\hrule
+%\paragraph{Naming Conventions}
%\hrule
-\hrule
+%\hrule
% ==========================================
\begin{itemize}
\item
-File names:
+File names :
For consistency reasons, you are requested to prepend \texttt{bb}, and postpone an extention \texttt{.bbs},
to the names of the files that hold a \texttt{complex black box} definition.
For example, the \texttt{Add3} complex box we previously worked on
can be defined in the \texttt{bbAdd3.bbs} file.
\item
-Search Paths
+Search Paths :
+For consistency reasons, the names of dynamic libraries holding the packages must start by \texttt{libbb}.
+For instance, the package \texttt{wx} will be in the library \texttt{libbbwx.dll} (Windows) or \texttt{libbbwx.so}
+(Linux).
+
+
\end{itemize}
% ==========================================
\hrule
\paragraph{Summary}
%\hrule
\begin{itemize}
-\item The \texttt{include} command allows to include a script file in \bbi.
-\item Lines starting with a \texttt{\#} or with a \texttt{\//} are treated as comments in \bbi scripts.
-\item Lines between a line starting with a \texttt{\//*} an a line starting with a \texttt{*\//} are treated as comments in \bbi scripts.
+\item The \texttt{include} command tells the interpreter to include a script file.
+\item Lines starting with a \texttt{\#} or with a \texttt{\//\//} are considered as comments by the interpreter.
+\item Lines between a line starting with a \texttt{\//*} an a line starting with a \texttt{*\//} are considered as comments by the interpreter.
\end{itemize}
\hrule
\label{bbi-command-line-app}
% ==========================================
-Now that you now how to create complex black boxes
+Now that you know how to create complex black boxes
(with \texttt{define/endefine}), think
back to the \texttt{workspace} object.
Remember that it is also
a \texttt{complex black box}.
-In fact what you are doing when you type \bbi commands
-outside a \texttt{define/endefine} block
-is to progressively define the \texttt{workspace}
+Actually, when you type interpreter commands
+outside a \texttt{define/endefine} block,
+you progressively define the \texttt{workspace}
complex black box.
-You can think of it like if at start
-\bbi was issuing a command \texttt{'define workspace'}
+You can think of it like if at start the interpreter
+was issuing a command \texttt{'define workspace'}
and then letting you define the interior of the box
\texttt{workspace}.
This input will then be connected to the
parameters that the user passes to the command line.
-For example, consider the script:
+For example, consider the script :
\begin{file}{add.bbs}
\begin{verbatim}
The third and fourth lines define two inputs \texttt{x}
and \texttt{y}. When you execute this script,
you can pass these two arguments on the command line,
-like this:
+like this :
\begin{verbatim}
> bbi add x=1 y=1
\end{verbatim}
You can also invoke \bbi the option \texttt{-h},
-which gives help on the \texttt{workspace} box:
+which gives help on the \texttt{workspace} box :
\begin{verbatim}
> bbi add -h
User's workspace
- By: bbi (internal)
- * Inputs:
- 'x' <double>: first number to add
- 'y' <double>: second number to add
+ By : bbi (internal)
+ * Inputs :
+ 'x' <double> : first number to add
+ 'y' <double> : second number to add
\end{verbatim}
To get a better help, use the \texttt{description}
-and \texttt{author} commands:
+and \texttt{author} commands :
\begin{file}{add.bbs}
\begin{verbatim}
\end{verbatim}
\end{file}
-Now if you ask for help on the \texttt{add} script, you get:
+Now if you ask for help on the \texttt{add} script, you get :
\begin{verbatim}
> bbi add -h
Adds two numbers
- By: foo@bar.com
- * Inputs:
- 'x' <double>: first number to add
- 'y' <double>: second number to add
+ By : foo@bar.com
+ * Inputs :
+ 'x' <double> : first number to add
+ 'y' <double> : second number to add
\end{verbatim}
Rather than getting the inputs of a script
from the command line, you can ask \bbi to
prompt the user for the values, using the \texttt{-t}
-commutator:
+commutator :
\begin{verbatim}
> bbi add -t
x+y=7
\end{verbatim}
-If \bbi is compiled in graphical mode (with \wx),
+\bbStudio is always compiled in graphical mode (with \wx), therefore
you can also use the \texttt{-g} commutator.
\bbi then prompts the user in graphical mode,
displaying a dialog box for each input,
\label{bbi-overview}
% ==========================================
-If \bbi is compiled in graphical mode
-(option \texttt{BUILD\_bbi\_GRAPHICAL} of \cmake, requires \wx),
+\bbStudio is always compiled in graphical mode
+(option \texttt{BUILD\_bbi\_GRAPHICAL} of \cmakens, requires \wxns),
then you can use special black boxes which are
graphical interface components (widgets).
Basic components are provided in the package \texttt{wx},
such as buttons, sliders, file open/save dialogs, etc.
-As first example, type the following commands in \bbi:
+As first example, type the following commands in \bbi :
\begin{verbatim}
> load wx
> new InputText t
When you close the window, the text you entered is printed by
the \texttt{print} command.
-Type \texttt{help wx}, you get something like:
+Type \texttt{help wx}, you get something like :
\begin{verbatim}
Package wx v1.0.0- info-dev@creatis.insa-lyon.fr
Basic graphical interface elements (sliders, buttons ...) based on wxWidgets
\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}.
See the files \texttt{test*.bbs} in the \texttt{scripts/test} directory.
-There are two kinds of widgets: ``terminal'' widgets and ``container'' widgets.
+There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
are ``terminal'' widgets.
-``container'' widgets are of another kind: they are designed to
+``container'' widgets are of another kind : they are designed to
contain other widgets in order to build larger dialog boxes.
For example, the \texttt{LayoutSplit} widget is a container which
``splits'' horizontally a window into two parts,
to a ``handle''.
The script \texttt{scripts/test/testSplit.bbs} demonstrate its use.
-Run it: it displays a window with two sliders.
+Run it : it displays a window with two sliders.
Move the sliders and close the window.
The final positions of the sliders are printed out.
-Now edit the file to see how this is done:
+Now edit the file to see how this is done :
\begin{file}{scripts/test/testSplit.bbs}
\begin{verbatim}
A \texttt{LayoutSplit} box \texttt{s} is also created.
The \texttt{connect} commands then ``includes'' the sliders in the
split ``container''.
-The input \texttt{Widget} is common to all widget boxes:
+The input \texttt{Widget} is common to all widget boxes :
every widget can be inserted into another widget.
The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{container}
widgets
-(in \bbi type \texttt{help Slider}:
+(in \bbi type \texttt{help Slider} :
you will see the output \texttt{Widget};
-type \texttt{help LayoutSplit}:
+type \texttt{help LayoutSplit} :
you will see the inputs \texttt{Widget1} and \texttt{Widget2}
and the output \texttt{Widget}).
When you connect the \texttt{Widget} output of a container
you order to include the widget in the container.
Of course, the order of connection is important.
In our case, the slider \texttt{s1} is included first,
-then the slider \texttt{s2}: \texttt{s1} will be placed
+then the slider \texttt{s2} : \texttt{s1} will be placed
on top of \texttt{s2} (the \texttt{LayoutSplit} box is
implemented that way, but this is arbitrary choice).
-Right now, there are only \emph{three} container widgets in the \texttt{wx} package:
-the \texttt{LayoutSplit} widget we just described, the \texttt{LayoutLine} , and the \texttt{LayoutTab}
+Right now, there are only \emph{three} container widgets in the \texttt{wx} package :
+\begin{itemize}
+\item {the \texttt{LayoutSplit} widget} we just described, the \texttt{LayoutLine} , and the \texttt{LayoutTab}
widget.
-The \texttt{LayoutLine} widget can have multiple children and
+\item {the \texttt{LayoutLine} widget} can have multiple children and
divides its window into as much parts as children,
each part of equal size.
The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
See the example \texttt{test/testSizer.bbs}.
With only those two containers you can already create
-complex dialog boxes (of course containers can be nested, which
-leads to tree-like structures of widgets).
+complex dialog boxes (of course containers can be nested, which leads to tree-like structures of widgets).
See the script \texttt{bbtk/share/bbtk/bbs/wx/appli/ExampleLayoutSplit.bbs} for an example.
-The \texttt{LayoutTab} widget is based on the \texttt{wxNotebook.}
+\item {The \texttt{LayoutTab} widget} is based on the \texttt{wxNotebook.}\\
+The label of each 'note book' is the name of the object it contains.
+\end{itemize}
+
+
+=====> TODO \\
-One word about a special widget in the package \texttt{wx}:
+
+One word about a special widget in the package \texttt{wx} :
the \texttt{Button}... to be continued.
% ==========================================
\label{bbi-deep-box}
% ==========================================
-Any widget box has two mandatory Outputs :
-
-\begin{itemize}
- \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, it
- will popup. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of any \texttt{Layout box}, it will be embedded in its parent window.
- \item {\bf\emph{Boxchange}} : Signals any modification of the box. This output may be connect if necessary to the \emph{BoxExecute} of an other box,
- further within the execution pipeline.
-\end{itemize}
-
Any widget box has two mandatory Inputs :
\begin{itemize}
\item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
\item {\bf\emph{BoxProcessMode}} : Sets the processing mode of the box :
\begin{itemize}
- \item {\bf\emph{Pipeline}} : bbUpdate() calls Process only if Status == MODIFIED (normal pipeline processing)
- \item {\bf\emph{Always}} : bbUpdate() always calls Process
- \item {\bf\emph{Reactive}} : bbSetModifiedStatus() calls bbUpdate()
+ \item {\bf\emph{Pipeline}} : bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
+ The box executes itself only when an entry was changed (normal pipeline processing).
+ \item {\bf\emph{Reactive}} : bbSetModifiedStatus() calls bbUpdate() \\
+ Warning : Re-processed immediately when \emph{any entry} changed.\\
+ To be more selective, better use \texttt{connect A.BoxChange \emph{currentBox}.BoxExecute}.
+ \item {\bf\emph{Always}} : bbUpdate() always calls Process. \\
+ Usefull for 'sources', that must be processed, even when no entry changed (e.g. : FileSelector, ColorSelector)\\
+ This one is not end user intended (for Package developer only)
\end{itemize}
\end{itemize}
Any \emph{Layout box} (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has at one or more mandatory Inputs :
\begin{itemize}
- \item {\bf\emph{Widget}}\texttt{i} : e.g. a \emph{LayoutSplit} box (Widget which splits a window in two fixed size parts)
- has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.
+ \item {\bf\emph{Widget}}\texttt{i} : e.g. a \emph{LayoutSplit} box (Widget which splits a window in two resizeable parts)
+ has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.\\
+ e.g. a \emph{LayoutLine} divides the window in up to 9 (depending on the number of inputs \emph{Widget}i) fixed size parts.
\end{itemize}
+Any widget box has two mandatory Outputs :
+
+\begin{itemize}
+ \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, it
+ will popup. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of any \texttt{Layout box}, it will be embedded in its parent window.
+ \item {\bf\emph{Boxchange}} : Signals any modification of the box. This output may be connect if necessary to the \emph{BoxExecute} entry of an other box,
+ further within the execution pipeline.
+\end{itemize}
+
+
+
% ==========================================
\subsection{More on ...}
\label{bbi-more-on}
\subsubsection{Black box packages}
\label{bbi-more-on-packages}
% ==========================================
-
There are various others user-intended packages :
+
+\begin{verbatim}
+---> Were moved in a 'Reference Manual' ?\\
+---> Any suggestion welcome!
+\end{verbatim}
+
\begin{itemize}
\item{vtk} \\
-It contains some vtk based image processing filters :
-% \begin{enumerate}
-
- \paragraph{AppendPolyData}
- Appends one of more polygonal datasets into a single polygonal dataset
-
- \paragraph{ConeSource}
- Creates a Cone
-
- \paragraph{ImageAnisotropicDiffusion3D}
-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. \\
-'DiffusionFactor' determines how far a pixel value moves toward its neighbors, and is insensitive to the number of neighbors chosen.\\
-The diffusion is anisotropic because it only occurs when a gradient measure is below 'GradientThreshold'. \\
-Two gradient measures exist and are toggled by the 'GradientMagnitudeThreshold' flag. \\
-When 'GradientMagnitudeThreshold' is on, the magnitude of the gradient, computed by central differences, above 'DiffusionThreshold' a voxel is not
-modified. \\
-The alternative measure examines each neighbor independently.\\
-The gradient between the voxel and the neighbor must be below the 'DiffusionThreshold' for diffusion to occur with THAT neighbor.\\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - Diffusion : Difference threshold that stops the diffusion\\
- Outputs : \\
- - Out : the isosurface mesh (vtkPolyData*)
-
- \paragraph{ImageCharacteristics}
- 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. \\
- The filter is restricted to the X, Y, and Z axes for now.\\
- It can degenerate to a 2 or 1 dimensional filter by setting the kernel size to 1 for a specific axis. \\
- (bbfication of vtkImageDilateErode3D) \\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - DilateValue : The dilatation value\\
- - ErodeValue : The erosion value\\
- Outputs : \\
- - Out : the isosurface mesh (vtkPolyData*)
-
- \paragraph{ImageGaussianSmooth}
- Performs a gaussian convolution of the input image\\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - StdDevX : Standard deviation in X direction\\
- - StdDevY : Standard deviation in Y direction\\
- Outputs : \\
- - Out : the isosurface mesh (vtkPolyData*)
-
- \paragraph{ImagePlanes}
- Creates three 3D planes with the input image mapped onto with which the user can interact; \\
- The output vtkImagePlaneWidget objects are to be inserted into a 3D scene (e.g. a Viewer3D)
- Receives : \\
- - In : an image (vtkImageData*)\\
- Outputs : \\
- - PlaneX : the image plane in X direction (vtkImagePlaneWidget*)\\
- - PlaneY : the image plane in Y direction (vtkImagePlaneWidget*)\\
- - PlaneY : the image plane in Z direction (vtkImagePlaneWidget*)\\
-
- Outputs : \\
- - Out : the isosurface mesh (vtkPolyData*)
-
- \paragraph{IsoSurfaceExtractor}
- Extracts an iso-surface of a 3D image and creates a vtkProp3D object to insert into a 3D scene (e.g. a Viewer3D)
- Receives : \\
- - In : an image (vtkImageData*)\\
- - Isovalue : the isosurface value (double)\\
- - Colour : Surface colour (vector of 3 doubles)
- Outputs : \\
- - Out : the isosurface (vtkProp3D**)
-
- \paragraph{MarchingCubes}
- Extracts an iso-surface of an image using the marching cubes algorithm (bbfication of vtkMarchingCubes)\\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - Value : the isosurface value (double)\\
- Outputs : \\
- - Out : the isosurface mesh (vtkPolyData*)
-
- \paragraph{MIPCreator}
- Creates a Maximum Intensity Projection (MIP) view of a 3D image.\\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - Scale : the Gray scale scaling (float) \\
- - Shift : the Gray scale shift (float) \\
- Ouputs : \\
- - Out : The MIP object (vtkProp3D*) to be plugged into a 3D Viever
-
- \paragraph{MetaImageReader}
- Reads .mhd / .mhd image formats (bbfication of vtkMetaImageReader) \\
- Receives : \\
- - In : the name of the file to be read (std::string)
- Outputs :
- - Out : The image (vtkImageData*)
-
- \paragraph{SegmentationConnectivity}
- Segmentation with min max threshold and connectivity \\
- Receives : \\
- - In : an image (vtkImageData*)\\
- - PositionXYZ : initial position (std::vector<int>) \\
- - ThresholdMinMax : min, max threshold values (std::vector<int>) \\
- Outputs : \\
- - Out : The image (vtkImageData*)
-
- \paragraph{SphereSource}
- Creates a Sphere
-% \end{enumerate}
-
\item{itk} \\
-It contains some itk based image processing filters :
-
- \paragraph{BinaryThresholdImageFilter}
- Binarizes an image by thresholding (generic bbification of itk::BinaryThresholdImageFilter)
-
- \paragraph{DICOMSeriesFileNames}
- Reads a series from a DICOM directory as a 3D itk image
-
- \paragraph{ExtractImageFilter}
- Decrease the image size by cropping the image to the selected region bounds (bbification of itk::ExtractImageFilter)
-
- \paragraph{ImageProperties}
- Outputs different properties of an image (type, dimension, size, spacing, ...)
-
- \paragraph{ImageRegion}
-Creates a generic ImageRegion (bbtk::any) from two vectors providing the index and size of the region.
-The dimension D of the actual itk::ImageRegion created is the max of the sizes of Index and Size
-(the smallest vector is padded by zeros)
-
- \paragraph{ImageReader}
-Generic itk image reader
-
- \paragraph{ImageWriter}
-Generic itk image writer
-
- \paragraph{ImageSeriesReader}
-Generic itk image series reader.
-
- \paragraph{ResampleImageFilter}
-Resamples an image
-
-\item{itkvtk} \\
-It doesn't contain any end user intended box, only adaptors : to convert a generic itkImage to a vtkImageData, and vtkImageData* to a generic itkImage pointer
-
-Sorry nothing is done, right now for meshes.
-
-\item{wxvtk} \\
-
-It contains two atomic black boxes.
-
- \paragraph{Viewer2D}
- Receives : \\
- - a \textless vtkImageData* \textgreater (In),\\
- - an Orientation(0:yz / 1:xz / 2:xy),\\
- - an initial slice number (Slice).\\
- Outputs :\\
- - a \textless vtkRenderer* \textgreater (Renderer)
-
- \paragraph{Viewer3D}
- Receives :\\
- - up to 5 Input Actors (\textless vtkProp3D* \textgreater),\\
- - up to 5 Input Observers (\textless vtkInteractorObserver* \textgreater), \\
- - a boolean 'Stereo' option, to use Red-Blue filter
- Outputs :\\
- - an Interactor (\textless wxVTKRenderWindowInteractor* \textgreater) with which vtk widgets can interact, \\
- - a Renderer (\textless vtkRenderer* \textgreater) to which actors can be added.
-
-It contains too some sophisticated complex black boxes :
-
- \paragraph{IsoSurfaceWithControls}
- Image iso-surface extractor (vtk::IsoSurfaceExtractor) with associated control panel (isovalue, opacity and colour)\\
- Receives :\\
- - an initial isovalue (Isovalue)
- - an initial opacity (Opacity)
- - an initial colour (Colour)
- Outputs :\\
- \textless vtkProp3D* \textgreater (In)\\
-
- \paragraph{MIPWithControls}
- Maximum Intensity Projection (MIP) creator (vtk::MIPCreator) with associated control panel (shift and scale) \\
- Receives :\\
- - an initial scale (Scale)
- - an initial shift (Shift)
- Outputs :\\
- \textless vtkProp3D* \textgreater (In)\\
-
-\item{wx} \\
-
-Some boxes are the bbfication of usefull xwWidgets, some other ones are more
-sophisticated.
-
- \paragraph{ColourSelector} Colour Selector dialog (bbfication of wxColourSelector) \\
- %\begin{verbatim}
- \texttt{Out} : Colour choosen in format '[0,1] [0,1] [0,1]'
- %\end{verbatim}
-
- \paragraph{ColourSelectorButton} A button which displays a colour picker dialog when clicked \\
- %\begin{verbatim}
- \texttt{In} :Initial colour \\
- \texttt{Out} : Colour choosen in format '[0,1] [0,1] [0,1]'
- %\end{verbatim} \\
-
- \paragraph{CommandButton} Button which executes bbi commands \\
- %\begin{verbatim}
- \texttt{In} : Commands to be executed separated by commas (;). Each single quote (') is replaced by a double quote ("). \\
- \texttt{Label} : Label of the button \\
- \texttt{Widget} : Output widget \\
- %\end{verbatim}
-
- \paragraph{DirectorySelector} Pops up a directory selection dialog (wxDirDialog)\\
- %\begin{verbatim}
- \texttt{DefaultDir} : The default directory\\
- \texttt{Message} : Message to show on the dialog \\
- \texttt{Title} : Title of the dialog \\
- \texttt{Out} : The directory selected by the user\\
- %\end{verbatim}
-
- \paragraph{FileSelector} Pops up a file selection dialog for reading or saving (wxFileDialog)\\
- %\begin{verbatim}
- \texttt{DefaultDir} : The default directory \\
- \texttt{DefaultFile} : The default filename \\
- \texttt{Message} : Message to show on the dialog \\
- \texttt{OpenSave} : Open for an open dialog (default) / Save for a save dialog\\
- \texttt{Title} : Title of the dialog \\
- \texttt{Wildcard} : A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" \\
- \texttt{Out} : The file selected by the user \\
- %\end{verbatim}
-
- \paragraph{InputText} A zone in which the user can enter a text (wxTextCtrl)\\
- %\begin{verbatim}
- \texttt{In} : Initial text (default '')\\
- \texttt{Title} : Title of the input zone (default '')\\
- \texttt{WinTitle} : Title of the window (*)\\
- \texttt{Out} :Current text\\
- %\end{verbatim}
-
- \paragraph{LayoutLine} LayoutLine widget (wxBoxSizer)\\
- %\begin{verbatim}
- \texttt{Orientation} Orientation (default V), 0=H=HORIZONTAL , 1=V=VERTICAL \\
- \texttt{Widget}1 widget 1 \\
- \texttt{Widget2} widget 2 \\
- \texttt{Widget3} widget 3 \\
- \texttt{Widget4} widget 4 \\
- \texttt{Widget5} widget 5 \\
- \texttt{Widget6} widget 6 \\
- \texttt{Widget7} widget 7 \\
- \texttt{Widget8} widget 8 \\
- \texttt{Widget9} widget 9\\
- %\end{verbatim}
-
- \paragraph{LayoutSplit} Widget which splits a window in two fixed size parts (wxSplitterWindow)\\
- %\begin{verbatim}
- \texttt{Orientation} : Orientation (default H), 0=H=HORIZONTAL , 1=V=VERTICAL\\
- \texttt{Proportion} : Proportion (in percent) of the first children in the window\\
- \texttt{Widget1} : Upper or left widget\\
- \texttt{Widget2} : Lower or right widget\\
- %\end{verbatim}
-
- \paragraph{LayoutTDown} Creates a 'T like' complex container : Down {UpLeft, UpRight} \\
- %\begin{verbatim}
- \texttt{Widget1} : UpLeft container\\
- \texttt{Widget2} : UpRight container\\
- \texttt{Widget3} : Down container\\
- \begin{verbatim}
-// ---------------
-// | | |
-// | W1 | W2 |
-// |-------------|
-// | |
-// | W3 |
-// ---------------
- \end{verbatim}
-
- \paragraph{LayoutTLeft} Creates a 'T like' complex container : Left {RigthUp, RightDown}\\
- %\begin{verbatim}
- \texttt{input} Widget1 : "UpLeft container"\\
- \texttt{input} Widget2 : "UpRight container"\\
- \texttt{input} Wigdet3 : "Down container"\\
- \begin{verbatim}
-// ---------------
-// | | W2 |
-// | W1 | |
-// | |------|
-// | | W3 |
-// | | |
-// ---------------
- \end{verbatim}
-
- \paragraph{LayoutTRight} Creates a 'T like' complex container : Right {LeftUp, LeftDown}\\
- %\begin{verbatim}
- \texttt{input} Widget1 currentBox.Widget1 "Up container"\\
- \texttt{input} Widget2 down.Widget1 "DownLeft container"\\
- \texttt{input} Widget3 down.Widget2 "DownRight container"\\
- \begin{verbatim}
-// ---------------
-// | | |
-// | W1 | |
-// |------| W2 |
-// | W3 | |
-// | | |
-// ---------------
- \end{verbatim}
-
- \paragraph{LayoutTUp} Creates a 'T like' complex container : Up {DownLeft, DownRight} as w1{w2,w3}\\
- \begin{verbatim}
- \texttt{ input} Widget1 currentBox.Widget1 "Up"\\
- \texttt{input} Widget2 down.Widget1 "DownLeft"\\
- \texttt{input} Widget3 down.Widget2 "DownRight"\\
-
-// ----------------
-// | W1 |
-// | |
-// |------|-------|
-// | W3 | W2 |
-// | | |
-// ----------------
- \end{verbatim}
-
- \paragraph{LayoutTab} LayoutTab widget (wxNotebook)\\
- %\begin{verbatim}
- \texttt{Orientation} Orientation (default T), 0=T=TOP , 1=R=RIGHT , 2=B=BOTTON , 3=L=LEFT \\
- \texttt{Widget1} widget 1 \\
- \texttt{Widget2} widget 2 \\
- \texttt{Widget3} widget 3 \\
- \texttt{Widget4} widget 4 \\
- \texttt{Widget5} widget 5 \\
- \texttt{Widget6} widget 6 \\
- \texttt{Widget7} widget 7 \\
- \texttt{Widget8} widget 8 \\
- \texttt{Widget9} widget 9 \\
-%\end{verbatim}
-
- \paragraph{OutputText} Text zone to be inserted into a window (wxStaticText)\\
- %\begin{verbatim}
- \texttt{In} Text \\
- \texttt{Title} Title prepended to the text\\
- %\end{verbatim}
-
- \paragraph{RadioButton} RadioButton group widget 0-9 entries\\
- %\begin{verbatim}
- \texttt{In} Set initial item \\
- \texttt{In0} option 0\\
- \texttt{In1} option 1\\
- \texttt{In2} option 2\\
- \texttt{In3} option 3\\
- \texttt{In4} option 4\\
- \texttt{In5} option 5 \\
- \texttt{In6} option 6 \\
- \texttt{In7} option 7 \\
- \texttt{In8} option 8 \\
- \texttt{In9} option 9 \\
- \texttt{Title} Title of the widget (default '')\\
- \texttt{Out} Number of the selected Item
- %\end{verbatim}
-
- \paragraph{Slider} Slider widget (wxSlider)\\
- %\begin{verbatim}
- \texttt{ChangeResolution} Enables the user to change the slider resolution (default FALSE) \\
- \texttt{In} Initial slider position(default 0) \\
- \texttt{Label} Show slider labels ? (default FALSE) \\
- \texttt{Max} Maximum value of the slider (default 500)\\
- \texttt{Min} Minimum value of the slider (default 0)\\
- \texttt{Orientation} Orientation : (default H) 0=H=HORIZONTAL, 1=V=VERTICAL\\
- \texttt{ReactiveOnTrack} Slider sends info when track moves (default 0 = no)\\
- \texttt{Title} Title shown above the slider (default '')\\
- %\end{verbatim}
+\item{...} \\
\end{itemize}
% ==========================================
\subsubsection{Pipeline processing}
\label{bbi-more-on-pipeline-processing}
% ==========================================
\begin{itemize}
-\item the ``control'' mechanism in bbi (switch exec commands, e.g. Button)
+\item the ``control'' mechanism in bbi.
+
+When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
+In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
+
+(switch exec commands, e.g. Button)
\item the role of ProcessMode to update widgets.
\end{itemize}
% ==========================================
\subsubsection{Errors}
\label{bbi-more-on-errors}
+% ==========================================
+\subsubsection{Creating and using your own uninstalled version of bbStudio}
+\label{bbi-more-on-your_own_version}
+
+Suppose 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 :
+\begin{itemize}
+\item cvs checkout the sources :
+\begin{verbatim}
+cvs checkout bbtk
+\end{verbatim}
+\item
+create a build directory
+\begin{verbatim}
+mkdir buildBBTK
+\end{verbatim}
+\item cd in the build directory:
+\begin{verbatim}
+cd buildBBTK
+\end{verbatim}
+\item run ccmake.
+\begin{verbatim}
+ccmake ../bbtk
+\end{verbatim}
+
+Don't forget to switch ON the flag \textttBBTK\_COMPILE\_DEBUG\_MESSAGE \\
+(see figure : \ref{bb-ccmake})
+
+\begin{figure}[!ht]
+\caption{\label{bb-ccmake}\Running ccmake}
+\begin{center}
+\includegraphics[width=0.6\textwidth]{ccmake.png}
+\end{center}
+\end{figure}
+
+\item As usual, type \texttt{c} untill there is no longer any area quoted with a * (or enlighted in red)\\
+Ask for generation (type \texttt{g} -once is always enough-)
+
+\item Ask for compilation and link.
+\begin{verbatim}
+make
+\end{verbatim}
+For some strange reasons (?!?), you may be warned that an error occured while documentation generation.\\
+Take it easy, \texttt{make} again!\\
+
+The dynamic libraries (\texttt{.dll} or {.so} ans the executable programs will be created in the \testtt{bin}
+directory of the built tree.
+
+\item choose to install or not your own version.
+\begin{verbatim}
+make install
+\end{verbatim}
+Linux users : Don't forget to \texttt{sudo} before.
+\end{itemize}
% ==========================================
\subsubsection{\bbtk configuration file and search pathes}
\label{bbi-more-on-configuration}
\end{enumerate}
Once created, you can edit the \texttt{bbtk\_config.xml} file located
-in your \texttt{.bbtk} directory. It contains:
+in your \texttt{.bbtk} directory. It contains :
\begin{file}{bbtk\_config.xml}
\begin{verbatim}
<?xml version="1.0" encoding="iso-8859-1"?>
<config>
- <bbtk_url> http://www.creatis.insa-lyon.fr/software/bbtk </bbtk_url>
- <bbs_path> </bbs_path>
- <package_path> </package_path>
- <data_path> </data_path>
+ <description> </description>
+ <bbs_path> </bbs_path>
+ <package_path>
+ /usr/local/lib
+ </package_path>
+ <data_path> </data_path>
+ <default_temp_dir>$</default_temp_dir>
</config>
\end{verbatim}
\end{file}
You can add pathes to
\begin{itemize}
-\item A custom folder in which to search for \texttt{.bbs} scripts (\texttt{include} command of \bbi) by adding an \texttt{xml} tag:
+\item A custom folder in which to search for \texttt{.bbs} scripts (\texttt{include} command of \bbi) by adding an \texttt{xml} tag :
\texttt{<bbs\_path>complete\_path\_to\_folder<\/bbs\_path>}.
-\item A custom folder in which to search for packages (\texttt{load} command of \bbi) by adding an \texttt{xml} tag:
+\item A custom folder in which to search for packages (\texttt{load} command of \bbi) by adding an \texttt{xml} tag :
\texttt{<package\_path>complete\_path\_to\_folder<\/package\_path>}.
\end{itemize}
+
+\newpage
+
% ==========================================
\subsection{Language reference}
\label{bbi-reference}
% ==========================================
-
+% ==========================================
+\subsubsection{pipeline creation and execution related commands}
+\label{bbi-reference-creation-execution}
+% ==========================================
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-box}
-\bbi pipeline creation and execution related commands.}
+\caption{\label{bbi-reference-box} \bbi pipeline creation and execution related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
\texttt{new} & \texttt{<boxtype>} \texttt{<box-name>}&
Creates a box of type \texttt{boxtype} and name
-\texttt{box-name}.
-\\ \hline
+\texttt{box-name}.\\ \hline
\texttt{delete} & \texttt{<box-name>} &
-Destroys the box named \texttt{box-name}.
-\\ \hline
+Destroys the box named \texttt{box-name}.\\ \hline
\texttt{connect} & \texttt{<box1.output>} \texttt{<box2.input>} &
Connects the output
the box named \texttt{box} to the value \texttt{value}.
There must exist an \texttt{adaptor}
in the packages loaded which converts a \texttt{std::string}
-to the type of the input \texttt{input}.
- \\ \hline
+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
\end{table}
% ==========================================
+\newpage
+% ==========================================
+\subsubsection{Interpreter related commands}
+\label{bbi-reference-interpreter}
+% ==========================================
% ==========================================
\begin{table}[!ht]
\hline
Command & Parameters & Effect \\ \hline
+\texttt{author} & - &
+Adds the string <string> 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{help} & - &
Prints help on available commands \\ \hline
& \texttt{<package-name>} &
Prints help on the package \texttt{package-name} and its boxes
(with brief description).
-The package must have been previously loaded
-\\ \hline
+The package must have been previously loaded \\ \hline
& \texttt{<box-type>} &
Prints help (with full description) on the type of box
\texttt{box-type}.
-The box type must belong to a package which has been previously loaded
-\\ \hline
+The box type must belong to a package which has been previously loaded \\ \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{include} command is. \\ \hline
\texttt{load} & \texttt{<package-name>} &
Loads the package \texttt{package-name}\\ \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.
-No box of a type defined in this package must still exist.
-\\ \hline
+No box of a type defined in this package must still exist.\\ \hline
\texttt{message} & \texttt{<category>} \texttt{<level>} &
Sets the level of verbosity of \bbi for the category of messages
-\texttt{category} to \texttt{level}.
-%See \ref{verbosity}.
-\\ \hline
+\texttt{category} to \texttt{level}.\\ \hline
+%See \ref{verbosity}.
\texttt{config} & - & Displays the Configuration parameters\\ \hline
-
+% ==========================================
+\subsubsection{complex black box definition related commands}
+\label{bbi-reference-black-box-definition}
+% ==========================================
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-complex-box}
-\bbi complex black box definition related commands.}
+\caption{\label{bbi-reference-complex-box} \bbi complex black box definition related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Sets the author(s) of the complex black box currently being defined \\ \hline
\texttt{description} & \texttt{<string>} &
-Sets the description 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,
\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
+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,
It is defined as corresponding to
the output \texttt{output} of the box \texttt{box}.
\texttt{<help>} is the help string for the new output.
-The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}.
-\\ \hline
+The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}. \\ \hline
\end{tabular}
\end{table}
% ==========================================
+\newpage
+% ==========================================
+\vspace{0.5cm}\hrule \\
+\section{The Package Browser}
+\label{Package_Browser}
+% ==========================================
+\begin{figure}[!ht]
+\caption{\label{Package_Browser}The Package Browser}
+\begin{center}
+\includegraphics[width=0.6\textwidth]{Package_Browser.png}
+\end{center}
+\end{figure}
% ==========================================
-\vspace{0.5cm}\hrule
+\vspace{0.5cm}\hrule \\
+\section{Using third party Package}
+\label{Third_Party_Package}
+% ==========================================
+
+
+% ==========================================
+\vspace{0.5cm}\hrule \\
\section{Using black boxes in \CPP programs}
\label{cpp}
% ==========================================
+A very usefull feature is that you may use any black box within a \CPP program witout worrying about wxWigets main window.\\
+
+Let's look a the following bbs script :
+
+\begin{verbatim}
+# Load the packages
+load std
+load wx
+
+# Create the Objects
+new Slider slider
+new OutputText text
+new LayoutLine layout
+
+# Graphical pipeline
+connect slider.Widget layout.Widget1
+connect text.Widget layout.Widget2
+# Execution pipeline
+connect slider.BoxChange text.BoxExecute
+connect slider.Out text.In
+
+# Go!
+exec layout
+\end{verbatim}
+User wants to create a slider and an output text, within a layoutline, and display the slider value in the output text.\\
+Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.\\
+
+Using \bbtk you just 'convert' the script :
+\begin{verbatim}
+
+#include <bbwxSlider.h>
+#include <bbwxOutputText.h>
+#include <bbtkFactory.h>
+#include <bbwxLayoutLine.h>
+
+int main(int argv, char* argc[])
+{
+ // we need to intanciate a bbtk::Factory to be aware of the adaptors
+ bbtk::Factory::Pointer factory = bbtk::Factory::New();
+
+ // Load the packages
+ // ----------------
+ factory->LoadPackage("std");
+ factory->LoadPackage("wx");
+
+ // Create the Objects
+ // ------------------
+ bbwx::Slider::Pointer slider = bbwx::Slider::New("slider");
+ bbwx::OutputText::Pointer text = bbwx::OutputText::New("text");
+ bbwx::LayoutLine::Pointer layout = bbwx::LayoutLine::New("layout");
+
+ // Graphical pipeline
+ bbtk::Connection::Pointer c1 = bbtk::Connection::New(slider,"Widget",
+ layout,"Widget1");
+
+ bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
+ layout,"Widget2");
+
+ // Execution pipeline
+ // ------------------
+
+ // 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);
+ bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
+ text,"BoxExecute");
+ layout->bbSetInputWinDialog(true);
+
+ // Go!
+ // ---
+ layout->bbExecute();
+
+ }
+ catch (bbtk::Exception e)
+ {
+ bbtk::MessageManager::SetMessageLevel("Error",1);
+ e.Print();
+ }
+}
+\end{verbatim}
%\bibliography{all}
%\section{Conclusion}
+
+
\end{document}
git://git.creatis.insa-lyon.fr / bbtk.git / commitdiff
