\begin{center}
CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
INSA Lyon\\
-Universit\'e Claude-Bernard Lyon 1
+Universit\'e Claude-Bernard Lyon 1\\
+
+http://www.creatis.insa-lyon.fr/creatools/bbtk
+
\end{center}
% ==========================================
of elementary processing \emph{units}, called {\bf black boxes},
and the definition and execution of processing \emph{chains}
made up of these black boxes. \\
-It's a part of the \texttt{Creatools suite} composed mainly of :
-\begin{verbatim}
- bbtk
- creaContours
- creaImageIO
- creaLib
+
+%It's a part of the \texttt{Creatools suite} composed mainly of :
+%\begin{verbatim}
+% bbtk
+% creaContours
+% creaImageIO
+% creaLib
-\end{verbatim}
-which depend on the OpenSource libraries:
-\begin{verbatim}
- gdcm
- itk
- vtk
- wxWidgets
-\end{verbatim}
+%\end{verbatim}
+%which depend on the OpenSource libraries:
+%\begin{verbatim}
+% gdcm
+% itk
+% vtk
+% wxWidgets
+%\end{verbatim}
% ==========================================
\subsection{The black box philosophy}
\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''}. \\
-We should merge theese definitions. :
+We should merge these 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}
+Hence, we 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}
\begin{itemize}
\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 : \bbs (the Black Box Script language) and its interpreter
+\bbi (the Black Box Interpreter).
\item {\bf Automatic documentation} of existing packages.
\texttt{html} documentation of packages is proposed by
\bbStudions.
\item A \CPP {\bf\emph{library}} - called \bbtk - which defines a framework
(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{"core" 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{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
interaction).
%\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
- \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development..
+ \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development.
\end{itemize}
\item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
\begin{itemize}
\end{itemize}
\end{itemize}
\item An standalone {\bf\emph{interpreter}}, called \bbins, which allows to
- load black box packages and to define and execute
- processing chains by connecting various black boxes.
+ execute \bbs scripts or commands.
\item {\bf\emph{Various Development Utilities}} :
\begin{itemize}
\item \bbfy generates the \CPP code of a black box from a
%\item \bbdoc generates the html documentation of a black box package
%(author, description, description of its black boxes :
%author, description, inputs, outputs, and so on).
- \item \bbCreatePackage allows to create the basic file architecture
+ \item \bbCreatePackage allows to create the basic file architecture.
to start the development of a new black box package.
- \item \text{bbCreateBlackbox} allows to create the basic file architecture
+ \item \bbCreateBlackBox allows to create the basic file architecture.
to start the development of a new black box, that will be included in an already existing package.
- \item \texttt{bbs2cpp} translates a \texttt{.bbs} script into a \CPP file.
- \item \texttt{bbc} that interprets (i.e. : executes) a \texttt{.bbs} script.
+ \item \bbs2cpp translates a \texttt{.bbs} script into a \CPP file.
+ \item \bbc (sorry : Linux Only, for the moment) that compiles \texttt{.bbs} scripts into executables.
+ \item \bbRegeneratePackageDoc which creates the html documentation of the Package.
+ \item \bbRegenerateBoxesLists which creates the html pages of the various lists of all the currenly installed boxes.
+ \item \bbPlugPackage which automatically incorporates a new package.
\end{itemize}
\item A full {\bf\emph{documentation}} printable (pdf), browsable (html),
queryable throught keywords.
\section{Getting started with bbStudio}
% ==========================================
-% ==========================================
-% ==========================================
-% ==========================================
-% ==========================================
-% ==========================================
-% ==========================================
% ==========================================
\subsection{The interface}
Just run it, typing in a console \bbStudio
or clicking on its icon or its menu entry.
-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-start}
(the exact appearance of \bbStudio is Operating System and \bbtk version dependent)
+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. \
+
\newpage
\subsubsection{'Command' part}
\label{bbi-CommandPart}
-This is where user will type his requirements.
+This is where user will type \bbs commands which are executed on the fly..
-\subsubsection{'Help Contents' part}
+\subsubsection{'Help' part}
\label{bbi-HelpContentsPart}
-The 'Help Contents' part of \bbStudio is used to browse the html help of \BBTK.
+The 'Help' 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{Help Contents}}
\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{User's Guide}} : This Guide.
\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. .
- \item {\bf\emph{Reference Manual}} :
- \item {\bf\emph{Booklet}} : Vade mecum.
+ % \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers. .
+ %\item {\bf\emph{Reference Manual}} :
+ % \item {\bf\emph{Booklet}} : Vade mecum.
\item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.
\end{itemize}
- \item {\bf\emph{Boxes}} : Box retrieving on various criterions :
+ \item {\bf\emph{Boxes}} : Lists of currently available Boxes :
\begin{itemize}
- \item {\bf\emph{ \texttt{By name}}} (Alphabetical list),
- \item {\bf\emph{ \texttt{By package}}},
- \item {\bf\emph{ \texttt{By category}}}.
+ \item {\bf\emph{ Alphabetical list}},
+ \item {\bf\emph{ List by package}},
+ \item {\bf\emph{ List by category}} : Each box is indexed by a list of keywords, called 'categrories', such as 'read/write',
+ 'filter' 'viewer', ...
+ \item {\bf\emph{ List of adaptors}} : A special hidden Box category, called \texttt{{Adaptors}} exists. \\
+ They are used internaly to perform type conversions. Thought there are not end user intended, you may see them.
\end{itemize}
- A special hidden Box category, called \texttt{{Adaptors}} exists. \\
- They are used internaly to perform type conversions. Thought there are not end user intended, you may query them.
-
+
\end{itemize}
\subsection{Running Demo and Examples}
% ==============================================
-Run \bbStudio the way you need. \\
-In the part 'Help contents' (See figure \ref{HelpContents}), select \texttt{Examples} link.
+In the part 'Help' (See figure \ref{HelpContents}), select \texttt{Examples} link.
\begin{figure}[!ht]
-\caption{\label{HelpContents}Help Contents}
+\caption{\label{HelpContents}Help}
\begin{center}
\includegraphics[width=0.7\textwidth]{HelpContents.png}
\end{center}
\newpage
-You will be asked to select a Box category (See figure \ref{BoxCategories}); \\
-Select \texttt{example}.
+You will get a list of examples (See figure \ref{example}).
+Due to an unfixed bug in Linux, you will have to click on 'reload' to get it. \\
-\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}
\end{figure}
+%\begin{figure}[!ht]
+%\caption{\label{BoxCategories}Box Categories}
+%\begin{center}
+%\includegraphics[width=0.7\textwidth]{BoxCategories.png}
+%\end{center}
+%\end{figure}
+
Select \texttt{wx::exampleSlider} (See figure \ref{exampleSlider});
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,
+Click on \texttt{source}, it will be loaded
in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
\begin{figure}[!ht]
\begin{itemize}
\item{in the File part} \\
The source code of the script
+\begin{verbatim}
+ load std
+ load wx
+\end{verbatim}
+We load the packages std and wx
\begin{verbatim}
new Slider slider
set slider.ReactiveOnTrack 1
\end{verbatim}
We create a \texttt{Slider} called \emph{slider}\\
We tell it to inform anybody that's interested in, that the cursor moved, each time it moved. \\
-The deafuault behaviour is to inform, only when cursor is released.
+The default behaviour is to inform, only when cursor is released.
\begin{verbatim}
new OutputText text
\end{verbatim}
-We create a \texttt{OutputText} called \emph{text}
+We create an \texttt{OutputText} called \emph{text}
(in which slider value will be displayed)
\begin{verbatim}
new LayoutLine layout
\end{verbatim}
We create a \texttt{LayoutLine} called \emph{layout},
-a \emph{container} widget, designed to embed other wigets (say, a main window)
+a widget designed to embed other wigets (say, a main window)
\begin{verbatim}
connect slider.Widget layout.Widget1
connect text.Widget layout.Widget2
connect slider.Out text.In
\end{verbatim}
We tell \emph{slider} to inform \emph{text} every time it's modified.\\
-We tell \emph{slider} to pass its output value (\texttt{Out} to \emph{text} input value (\texttt{In})
+We tell \emph{slider} to pass its output value (\texttt{Out}) to \emph{text} input value (\texttt{In})
\begin{verbatim}
exec layout
\end{verbatim}
We tell \emph{layout} to process itself (it will do it only if it's warned
-that one of its entries was modified since its (own) last processing.
+that one of its entries was modified since its (own) last processing).
\item{in the Help part}
-You can see the graphical representation of the script, as in figure \ref{SmallGraph}.
+You can see the graphical representation of the workflow (pipeline) of the script, as in figure \ref{SmallGraph}.
\begin{figure}[!ht]
-\caption{\label{SmallGraph}Graphical representation of a script}
+\caption{\label{SmallGraph}Graphical representation of a pipeline}
\begin{center}
\includegraphics[width=0.7\textwidth]{SmallGraph.png}
\end{center}
\end{figure}
-Both graphical pipe line (\emph{slider} and \emph{text} are embedded into \emph{layout})
- and processing pipe line (\emph{slider} warns \emph{text} immedialtely when it's modified, \emph{slider} passed \emph{text} its new value).\\
- Yes, we know : all the arrows (pipe line arrows and processing arrows) are blue; we are sorry about that...\\
+Both graphical interface pipeline (\emph{slider} and \emph{text} are embedded into \emph{layout})
+ and processing pipeline (\emph{slider} warns \emph{text} immedialtely when it's modified, \emph{slider} passed \emph{text} its new value).\\
+ Yes, we know : all the arrows (graphical interface pipeline arrows and processing arrows) are blue; we are sorry about that...\\
- You could get a much more detailled graph, just clicking on the button \\ \texttt{graph (detailled)} in the toolbar of the \texttt{Command} part, like in
+ You can get a much more detailled graph, just clicking on the button \\ \texttt{graph (detailled)} in the toolbar of the \texttt{Command} part, like in
figure \ref{LargeGraph}.
\begin{figure}[!ht]
-\caption{\label{LargeGraph}Detailled graphical representation of a script}
+\caption{\label{LargeGraph}Detailled graphical representation of a pipeline}
\begin{center}
\includegraphics[width=0.75\textwidth]{LargeGraph.png}
\end{center}
The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of :
-one single line area (\texttt{Command}), at the bottom in which you can enter your commands and
+one single line area (\texttt{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
\end{verbatim}
The \texttt{help} command has multiple usages.
-It is used to get help about almost anything in the interpretor!
+It is used to get help about almost anything in the interpreter!
Type \texttt{'help help'} to get help on the \texttt{help} command itself :
\begin{verbatim}
> help help
of a black box instance.
\end{verbatim}
-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 :
-\begin{verbatim}
-> help packages
-user
- workspace
-\end{verbatim}
-
-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 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 \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 :
-\begin{verbatim}
-> help workspace
- 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,
-the \texttt{user::} prepended to the name \texttt{workspace}
-means that the box \texttt{workspace}
-belongs to the \texttt{user} package.
-Then comes a description and three lines which
-tell that \texttt{workspace} does not have any input
-nor output nor boxes yet.
-
-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 :
-\begin{verbatim}
-> include std
-\end{verbatim}
-
-Then if you type :
-\begin{verbatim}
-> help packages
-\end{verbatim}
-
-you get something like :
-
-\begin{verbatim}
-
- 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 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 :
-\begin{verbatim}
-> help Add
-\end{verbatim}
-
-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)
- 'In1' <Double> [] : First number to add
- 'In2' <Double> [] : Second number to add
- * Outputs :
- 'BoxChange' <bbtk::VoidS> [signal] : Signals modifications of the box
- 'Out' <Double> [] : Result
-\end{verbatim}
More information about what is a 'box' will be given in the 'Scripting' part of this manual.
application, just using already existing boxes.
\item {\bf\emph{Package Developper's Guide}} : Step to step How-to for programmer who wants to create his own
black boxes/packages.
- \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probably not very much
- up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
- \item {\bf\emph{Reference Manual}} : Contains a exaustive description of all the features for all the commands.
- \item {\bf\emph{Booklet}} : Vade mecum.
+ % \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probably not very much
+ % up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
+ % \item {\bf\emph{Reference Manual}} : Contains a exaustive description of all the features for all the commands.
+ %\item {\bf\emph{Booklet}} : Vade mecum.
\item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source file
headers. Should concern only the kernel developpers (i.e. : us).
\end{itemize}
\item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
interaction).
%\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
- \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development, such as :
- \begin{itemize}
- \item{\texttt{GUICreateBlackBox}} For creating the XML or C++ code for a new black box
- \item{\texttt{GUICreatePackage}} For creating a new bbtk package file structure on disk (Graphical user interface for the shell script bbCreatePackage)
- \item{\texttt{MakePackageDoc}} For creating the html documentation of a package. The doc is generated at the 'canonical' location. Works both for a build tree or an installed toolkit.
- \end{itemize}
+ \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development:
+ % \begin{itemize}
+ % \item{\texttt{GUICreateBlackBox}} For creating the XML or C++ code for a new black box
+ % \item{\texttt{GUICreatePackage}} For creating a new bbtk package file structure on disk (Graphical user interface for the shell script bbCreatePackage)
+ % \item{\texttt{MakePackageDoc}} For creating the html documentation of a package. The doc is generated at the 'canonical' location. Works both for a build tree or an installed toolkit.
+ % \end{itemize}
\end{itemize}
\item {\bf\emph{List by category}}.
\label{Package_Browser}
% ==========================================
-
You can run it using the tool bar of the 'Command' part. See figure \ref{imPackage_Browser}.
\begin{figure}[!ht]
Provides a graphical interface to help Package developper to create a new empty package.
\item{\texttt{Create black box}}
Provides a graphical interface to help Package developper to create a new empty black box, and add it to an already existing package.
- \item{\texttt{Show last image graph}}
+ \item{\texttt{Plug Package}}
+ Incorporates a package into the list of known packages. Updates the html documentation.
\item{\texttt{Regenerate package doc}} :
if user was supplied new black boxes, and added them to an already existing package, he can update the package documentation, in order to benefit all the features of the Help mechanisms.
\item{\texttt{Regenerate boxes list}} :
if user wants to update only boxes list (quicker)
\item{\texttt{Regenerate all}}
+
+ \item{\texttt{Show last image graph}}
User wants to rebuild the whole documentation.
\end {itemize}
\item{\texttt{Options}}
\begin {itemize}
- \item{\texttt{Reset before running}} Before running, all the already boxes are destroyed, all the already loaded packages are unloaded (this is the recomended option).
+ \item{\texttt{Reset before running}} Before running a script, all the already created boxes are destroyed,
+ all the already loaded packages are unloaded (this is the recomended option).
\end {itemize}
\item{\texttt{Windows}}
User may decide, for any reason of his own, to hide one or more pannels:
\subsection{Using an already existing script}
% ==========================================
-Using the lower toolbar (see figure : \ref{lowertoolbarsmall}), open the file
+Using the lower toolbar (see figure : \ref{lowertoolbar}), open the file
holding the script.
-\begin{figure}[!ht]
-\caption{\label{lowertoolbarsmall}The lower tool bar}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{lowertoolbar.png}
-\end{center}
-\end{figure}
-
You'll see it, in the '\texttt{Files}' part.\\ \\
You may run it, using the lower toolbar. \\
%\texttt{WARNING :} if the script contains one or more \texttt{LayoutSplit}
\subsection{Inside black boxes}
% ==========================================
-After loading the package it belongs to, you can You can create an \emph{instance} of an \texttt{Add} box by
+At start the interpreter does not know any black box.
+If you type \texttt{'help packages'}, which is
+the third form of the \texttt{help} command, you get :
+\begin{verbatim}
+> help packages
+user
+ workspace
+\end{verbatim}
+
+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 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 \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 :
+\begin{verbatim}
+> help workspace
+ 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,
+the \texttt{user::} prepended to the name \texttt{workspace}
+means that the box \texttt{workspace}
+belongs to the \texttt{user} package.
+Then comes a description and three lines which
+tell that \texttt{workspace} does not have any input
+nor output nor boxes yet.
+
+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 :
+\begin{verbatim}
+> include std
+\end{verbatim}
+
+Then if you type :
+\begin{verbatim}
+> help packages
+\end{verbatim}
+
+you get something like :
+
+\begin{verbatim}
+
+ 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 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 :
+\begin{verbatim}
+> help Add
+\end{verbatim}
+
+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)
+ 'In1' <Double> [] : First number to add
+ 'In2' <Double> [] : Second number to add
+ * Outputs :
+ 'BoxChange' <bbtk::VoidS> [signal] : Signals modifications of the box
+ 'Out' <Double> [] : Result
+\end{verbatim}
+
+After loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box by
the command \texttt{new} :
\begin{verbatim}
a \emph{box type} , like \texttt{int} is a data type
in \texttt{C} langage. The \texttt{new} command allows to create
an instance of a box type, exactly like \texttt{int i;} in
-a \texttt{C} code, it declares a variable of type \texttt{int} whose
+a \texttt{C} code declares a variable of type \texttt{int} whose
name is \texttt{i}.
Of course, like in \texttt{C} Language, you can declare multiple boxes of the
same type in \bbi. \\
-You can ask information about a given black box :\\
-In the \texttt{Command part}, type \texttt{help} + black box name, e.g. \\
+After the creation of the box \texttt{a}, type :
+\begin{verbatim}
+> help workspace
+\end{verbatim}
+you get :
\begin{verbatim}
-> help Add a
+Complex Black Box <user::workspace>
+ User's workspace
+ By : bbtk
+ Category(s) : complex box;
+ * No inputs
+ * No outputs
+ * Boxes :
+ 'a' <std::Add>
\end{verbatim}
-Have a look to the 'Help' Part (see figure : \ref{HelpAdd}) :
+which means that \bbi workspace now contains a black box named \texttt{a},
+of type \texttt{std::Add}.
+
+
+Type
+\begin{verbatim}
+Help Add
+\end{verbatim}
+ and have a look to the 'Help' Part (see figure : \ref{HelpAdd})
+
\begin{figure}[!ht]
\caption{\label{HelpAdd}The html Help}
\begin{center}
\end{center}
\end{figure}
-The \texttt{std::} prepended to the name \texttt{Add}
-means that the box \texttt{Add}
-belongs to the \texttt{std} package.
-Then comes a description
+
+You can see 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 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{name} ,
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.
-
-After the creation of the box \texttt{a}, type :
-\begin{verbatim}
-> help workspace
-\end{verbatim}
-
-you get :
-\begin{verbatim}
-Complex Black Box <user::workspace>
- User's workspace
- By : bbtk
- Category(s) : complex box;
- * No inputs
- * No outputs
- * Boxes :
- 'a' <std::Add>
-\end{verbatim}
+include a pipeline graph.
-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 :
-you can see that this type of box has two inputs,
+You can see that \texttt{Add} boxes have two inputs,
with name \texttt{In1} and \texttt{In2},
and an output, with name \texttt{Out}.
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 box output (the pipeline is executed before printing, because the interpretor 'knows' the box \texttt{b},
-whose output is requested, is not up to date.
+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
Some explainations : the \texttt{include} instructions load the necessary packages. \\
-\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 Viewer2D} display a plane, whose number id specified by an integer.\\
+\texttt{FileSelector} will pop a File Selector, at run time, that will out the user chosen file name. \\
+\texttt{Slider} will pop a Slider, at run time, that will out an integer, used later as a slice number.\\
+\texttt{ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a pointer on an itk image.\\
+\texttt{Viewer2D} displays a plane, whose number is 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).\\
-\texttt{connect reader.Out viewer.In} plugs the output of the reader (an itk::ImagePointer) to the input of the Viewer (a vtkImageData *)\\
+\texttt{connect reader.Out viewer.In} plugs the output of the reader (an bbtk::any<bbitk::ImagePointer> which is a type defined by the
+itk package which can hold any itk image pointer) to the input of the Viewer (a vtkImageData *)\\
\texttt{connect slider.Out viewer.Slice} plugs the output of the slider (an int) to an other output (named Slide) of the viewer.\\
\texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer that it must re process itself any time the slider is modified.\\
\\
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 may be done.\\
-\texttt{WARNING} : these adaptors are \texttt{C++ static cast}, i.e., there is, right now',
+\texttt{WARNING} : these adaptors are \texttt{C++ static cast}, i.e., there is, right now,
no 'intelligent' conversion (only truncation) e.g. think to \texttt{CastDoubleToUChar}!
%\begin{verbatim}
\end{file}
+The inner boxes have they own entries (In1, In2, In3 for box a, In1, In2 for box b )\\
+Only the inputs In1, In2, In3 of box a and the input In2 of box b is of interest for the end user, but he dosn't want to have to
+care neither about the inner boxes name, nor about the names of their Inputs.\\
+The writer of the complex box has the ability to give these inputs a meaningfull name !
+\begin{verbatim}
+ input In3 a.In3 "third double to add"
+ input In4 b.In2 "fourth double to add"
+\end{verbatim}
+
\subsubsection{Naming Conventions}
\label{bbi-Naming Conventions}
can be defined in the \texttt{bbAdd3.bbs} file.
\item
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}
+For consistency reasons, the names of dynamic libraries holding the packages start by \texttt{bb}.
+For instance, the package \texttt{wx} will be in the library \texttt{bbwx.dll} (Windows) or \texttt{libbbwx.so}
(Linux).
\begin{itemize}
\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.
+\item Lines between a line starting with a \texttt{\//*} an a line ending with a \texttt{*\//} are considered as comments by the interpreter.
\end{itemize}
\hrule
% ==========================================
% ==========================================
-\subsubsection{Overwiew}
+\subsubsection{Overview}
\label{bbi-overview}
% ==========================================
-
-\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},
+.
+Basic graphical interface 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 :
\end{verbatim}
You can reproduce the same experiment as above using a
-\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}.
-See the files \texttt{test*.bbs} in the \texttt{scripts/test} directory.
+\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}..
%There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
The size of the two parts can be adjusted by the user thanks
to a ``handle''.
-The script \texttt{scripts/test/testSplit.bbs} demonstrate its use.
+The example \texttt{exampleLayoutSplit} demonstrates its use.
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 look at the source file to see how this is done :
\begin{file}{scripts/test/testSplit.bbs}
\begin{verbatim}
connect s1.Widget s.Widget1
connect s2.Widget s.Widget2
-print s1=$s1.Out$\\n
-print s2=$s2.Out$\\n
+exec s
\end{verbatim}
\end{file}
First, the two sliders \texttt{s1} and \texttt{s2} are created.
A \texttt{LayoutSplit} box \texttt{s} is also created.
The \texttt{connect} commands then ``includes'' the sliders in the
-split ``container''.
+split widget.
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}
+The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{layout}
widgets
(in \bbi type \texttt{help Slider} :
you will see the output \texttt{Widget};
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
-to the \texttt{Widget}i input of a widget,
-you order to include the widget in the container.
+When you connect the \texttt{Widget} output of a box
+to the \texttt{Widget}i input of a layout widget,
+you order to include the widget in the layout.
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
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 :
+Right now, there are only \emph{three} layout widgets in the \texttt{wx} package :
\begin{itemize}
\item {the \texttt{LayoutSplit} widget} we just described, the \texttt{LayoutLine} , and the \texttt{LayoutTab}
widget.
-\item {the \texttt{LayoutLine} widget} can have multiple children and
+\item {the \texttt{LayoutLine} widget} can have multiple children (Widgeti inputs) 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). \\
-See the script \texttt{bbtk/share/bbtk/bbs/wx/appli/ExampleLayoutSplit.bbs} for an example.
+%See the example \texttt{example}.
+With only those two layout widgets you can already create
+complex dialog boxes (of course layouts can be nested, which leads to tree-like structures of widgets). \\
+See the script \texttt{exampleComplexLayoutSplit\_In\_LayoutSplit} for an example.
\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.
\label{bbi-deep-box}
% ==========================================
-Any widget box has two mandatory Inputs :
+Any box has three mandatory Inputs :
\begin{itemize}
\item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
+ \item {\bf\emph{Boxchange}} : Signals any modification of the box. This output may be connected if necessary to the \emph{BoxExecute}
+ input of an other box, further within the execution pipeline.
\item {\bf\emph{BoxProcessMode}} : Sets the processing mode of the box :
\begin{itemize}
- \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.\\
+ \item {\bf\emph{Pipeline}} :% bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
+ The box executes itself only when an input was changed (normal pipeline processing).
+ \item {\bf\emph{Reactive}} : %bbSetModifiedStatus() calls bbUpdate() \\
+ Re-processes immediately when \emph{any input} changes.\\
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)\\
+ \item {\bf\emph{Always}} :% bbUpdate() always calls Process. \\
+ Usefull for 'sources', that must be processed, even when no input changed (e.g. : FileSelector, ColorSelector)\\
This one is not end user intended (for Package developer only)
\end{itemize}
\end{itemize}
\end{itemize}
-Any \emph{Layout box} (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has at one or more mandatory Inputs :
+Any \emph{Layout box} (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has 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 resizeable parts)
has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.\\
\end{itemize}
-Any widget box has two mandatory Outputs :
+Any widget box has one mandatory Output :
\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.
+ 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.
+
\end{itemize}
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)
+%(switch exec commands, e.g. Button)
\item the role of ProcessMode to update widgets.
\end{itemize}
-% ==========================================
-\subsubsection{Complex black boxes}
-\label{bbi-more-on-complex-black-boxes}
-Creation of complex widgets (containers, contained...)
-
-You can include script files in other script files,
-like in the following example :
-
-
-\begin{verbatim}
-# Defines the Add4 black box which adds 4 doubles
-include Add3
-define Add4
- author "myself"
- description "adds 4 doubles"
- new Add3 a
- new Add b
- connect a.Out b.In1
- input In1 a.In1 "first double to add"
- input In2 a.In2 "second double to add"
- input In3 a.In3 "third double to add"
- input In4 b.In2 "fourth double to add"
- output Out b.Out "output"
-endefine
-\end{verbatim}
-
-The inner boxes have they own entries (In1, In2, In3 for box a, In1, In2 for box b )\\
-Only the inputs In1, In2, In3 of box a and the input In2 of box b is of interest for the end user, but he dosn't want to have to
-care neither about the inner boxes name, nor about the names of their Inputs.\\
-The writer of the complex box has the ability to give these inputs a meaningfull name !
-\begin{verbatim}
- input In3 a.In3 "third double to add"
- input In4 b.In2 "fourth double to add"
-\end{verbatim}
%\subsubsection{Advanced issues}
%\paragraph{Reducing the number of inputs of a box}
git://git.creatis.insa-lyon.fr / bbtk.git / commitdiff