% ==========================================
\documentclass[11pt,final,a4paper]{article}
\input{config.tex}
+
+
+
\begin{document}
-\title{The Black Box Toolkit\\User's Guide}
-\date{\today}
-\author{Laurent Guigues}
-\maketitle
+
+\begin{center}
+
+{\Large \BBTK}
+\vspace{1cm}
+
+{\Huge User's Guide}
+\vspace{1cm}
+
+\bbtk version \bbtkVersion
+\vspace{0.5cm}
+
+
+Last modified on : October 16, 2008 \\
+Generated on : \today
+\vspace{0.5cm}
+\end{center}
+\begin{center}
+Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
+\end{center}
+\begin{center}
+CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
+INSA Lyon\\
+Universit\'e Claude-Bernard Lyon 1\\
+
+http://www.creatis.insa-lyon.fr/creatools/bbtk
+
+\end{center}
+
% ==========================================
\tableofcontents
% ==========================================
+\listoftables
+
+\listoffigures
+
+
% ==========================================
%\section*{Abstract}
\newpage
% ==========================================
\hrule
-\section{What is {\bf bbtk} ?}
+\section{What is bbtk ?}
% ==========================================
\BBTK(\bbtkns) is a set of tools
(\CPP libraries and executables)
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
+% creaImageIO
+% creaLib
+
+%\end{verbatim}
+%which depend on the OpenSource libraries:
+%\begin{verbatim}
+% 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 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}
-component of a system, letting know the user
+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}
-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
\item{\bf symbolic} means that a particular
input or output is referenced by a 'name', that is by a symbol
which identifies the input or output.
-It also means that symbolic information (text!) is
+It also means that symbolic information (text) is
attached to a box: description of the box, author,
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 : \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
-\bbi.
+\bbStudions.
\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
-dynamic libraries, called black box \emph{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.
-\end{itemize}
-\item An {\bf\emph{interpreter}}, called \bbi, 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}}:
-\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, 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{itemize}
+ \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{"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{itk}} : the basic image processing package, based on the \itk library.
+ \item {\bf\emph{vtk}} : the basic images and surfaces processing and visualization 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{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
+ \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development.
+ \end{itemize}
+ \item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
+ \begin{itemize}
+ \item An online {\bf\emph{script editor and interpretor}}
+ \item A powerful html {\bf\emph{Help environment}}, integrating :
+ \begin{itemize}
+ \item Online documentation scaning
+ \item Retreiving boxes on various criterions
+ \item Checking Demo and examples
+ \end{itemize}
+ \end{itemize}
+ \item An standalone {\bf\emph{interpreter}}, called \bbins, which allows to
+ 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
+ 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, inputs, outputs, and so on).
+ \item \bbCreatePackage allows to create the basic file architecture.
+ to start the development of a new black box package.
+ \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 \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.
\end{itemize}
The general architecture of \BBTK
\end{center}
\end{figure}
+\newpage
+
+% ==========================================
+\section{Getting started with bbStudio}
% ==========================================
-\subsection{Structure of this guide}
+
+
% ==========================================
+\subsection{The interface}
+% ==========================================
+
+
+%\vspace{0.5cm}\hrule
+%\section{The Development environment (bbStudio)}
+%\label{bbStudio}
+
+Just run it, typing in a console \bbStudio
+or clicking on its icon or its menu entry.
+
+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
+
+
+\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}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+\end{center}
+\end{figure}
+
+You can see four parts : \texttt{Files}, \texttt{Messages},
+ \texttt{Command}, \texttt{Help}.\\
+
+The stuff is written using the Advanced User Interface library of wxWidgets
+(a.k.a. AUI),
+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 ...)
-This guide is divided into two parts.
+\subsubsection{'Files' part}
+\label{bbi-FilesPart}
-The first part (\ref{bbi})
-is devoted to the use of the \emph{black box interpreter} \bbi.
-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.
+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 (see figure : \ref{lowertoolbar})
-The second part (\ref{cpp}) explains how to
-use the black box toolkit framework in \CPP code,
-typically to develop large applications which
-involve complex graphical interfaces.
+\begin{figure}[!ht]
+\caption{\label{lowertoolbar}The lower tool bar}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
+\end{center}
+\end{figure}
+
+
+% \begin{itemize}
+% \item {\bf\emph{New file}} : Create a new file to hold a script
+% \item {\bf\emph{Open file}} : Open an 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
+% \item {\bf\emph{cursor position}} : column number : line number
+% \end{itemize}
+
+
+\subsubsection{'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
+
+\subsubsection{'Command' part}
+\label{bbi-CommandPart}
+
+This is where user will type \bbs commands which are executed on the fly..
+
+\subsubsection{'Help' part}
+\label{bbi-HelpContentsPart}
+
+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}}
+ \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}} : 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{Doxygen Documentation}} : Doxygen source browser.
+ \end{itemize}
+
+ \item {\bf\emph{Boxes}} : Lists of currently available Boxes :
+ \begin{itemize}
+ \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}
+
+
+ \end{itemize}
+
% ==========================================
+
+
+
+
% ==========================================
% ==========================================
% ==========================================
% ==========================================
% ==========================================
-\vspace{0.5cm}\hrule
-\section{The black box interpreter (bbi)}
-\label{bbi}
-% ==========================================
-% ==========================================
-%\subsection{Structure of this part}
+
+
+
% ==========================================
-Using the black box interpreter is very simple.
-Everything is done with only a few commands.
-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,
-to see how it works in practice.
-At the end of this section,
-you will be able to use \bbi and write
-own black box processing scripts.
+\newpage
-After this tutorial,
-the section \ref{bbi-more-on}
-(called \emph{more on...})
-goes deeper into various issues of \bbi.
-Read it at your convenience,
-either linearly to learn more about \bbi,
-or in random order to get an answer
-to a particular question.
+% ==============================================
+\subsection{Running Demo and Examples}
+% ==============================================
-Finally, the section \ref{bbi-reference}
-summarizes all the commands of \bbi,
-their parameters and effect.
-Use it as a reference.
+In the part 'Help' (See figure \ref{HelpContents}), select \texttt{Examples} link.
-% ==========================================
-\subsection{Getting started}
-\label{bbi-getting-started}
-% ==========================================
-\subsubsection{Creating and executing black boxes}
-% ==========================================
+\begin{figure}[!ht]
+\caption{\label{HelpContents}Help}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{HelpContents.png}
+\end{center}
+\end{figure}
+
+\newpage
+
+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. \\
-To run the black box interpreter,
-open a console and type \texttt{bbi}
-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}.
\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbi-gui}The black box interpreter interface}
+\caption{\label{example}example list}
\begin{center}
-\includegraphics[width=0.7\textwidth]{bbi-gui.png}
+\includegraphics[width=0.7\textwidth]{example.png}
\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.
+%\begin{figure}[!ht]
+%\caption{\label{BoxCategories}Box Categories}
+%\begin{center}
+%\includegraphics[width=0.7\textwidth]{BoxCategories.png}
+%\end{center}
+%\end{figure}
-Try typing in the input zone (in this manual,
-the commands entered by the user will be preceded by a prompt '(>)') :
+
+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}, it will be loaded
+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 figure \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
+
+Just a few words on what you saw :
+\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 default behaviour is to inform, only when cursor is released.
+\begin{verbatim}
+ new OutputText text
+\end{verbatim}
+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 widget designed to embed other wigets (say, a main window)
+\begin{verbatim}
+ connect slider.Widget layout.Widget1
+ connect text.Widget layout.Widget2
+\end{verbatim}
+We embed \emph{slider} and \emph{text} into \emph{layout}.
+\begin{verbatim}
+ connect slider.BoxChange text.BoxExecute
+ 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})
+\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).
+
+\item{in the Help part}
+
+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 pipeline}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{SmallGraph.png}
+\end{center}
+\end{figure}
+
+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 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 pipeline}
+\begin{center}
+\includegraphics[width=0.75\textwidth]{LargeGraph.png}
+\end{center}
+\end{figure}
+
+\end{itemize}
+\newpage
+
+% ==============================================
+\subsection{Online Help}
+% ==============================================
+
+Various levels or help are suplied by \bbStudions.
+
+% ==========================================
+\subsubsection{Command line help}
+% ==========================================
+
+
+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
+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 \texttt{Command} area (in this manual,
+the commands entered by the user will be preceded by a prompt \textgreater) :
\begin{verbatim}
> 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
quit
reset
set
- unload
+ unload
\end{verbatim}
To get help on a particular command type \texttt{help <command-name>},
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 interpreter!
+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.
+
+More information about what is a 'box' will be given in the 'Scripting' part of this manual.
+
+% ==========================================
+\subsubsection{Guides}
+% ==========================================
+
+An html version of all the guides is browsable in the \texttt{Help} part of \bbStudions.
+ \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 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{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source file
+ headers. Should concern only the kernel developpers (i.e. : us).
+ \end{itemize}
+
+
+
+% ==========================================
+\subsubsection{Boxes Help}
+% ==========================================
+ Box retrieving on various criteria :
+ \begin{itemize}
+ \item {\bf\emph{Alphabetical list}} \\ This is the 'zero-level' of retrieving.
+ \item {\bf\emph{List by package}} \\ Several packages are supplied with bbtk :
+ \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 \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{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
+ \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}}.
+
+
+ A given box may belong to more than one \texttt{category}.\\
+ You have to consider categories like keywords to index black boxes.\\
+ Some of them are mutually exclusive.
+ A black box may be :
+ \begin {itemize}
+ \item{atomic box / complex box}\\
+ Whether it's written is C++ or it's an assembly of several black boxes (atomic or complex).\\
+ Any box is either atomic ou complex.
+ \item{example / demo / application}\\
+ These ones are always complex black boxes.
+ \begin {itemize}
+ \item{example}\\
+ It's just a (simple) example, for programmers, on how to use a given feature.
+ \item{demo}\\
+ It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work, done only by using \texttt{bbtk}
+ boxes.
+ \item{application}\\
+ It's a Final application, end user intended (e.g. Subscale a huge volume witout loading it in memory, Crop a DICOM image, etc)
+ \end {itemize}
+ \item{widget}\\
+ Piece of graphical interface (based on \texttt{wxWidgets})
+ \item{Dicom}\\
+ Dicom medical image related box.
+ \item{viewer}
+ \item{read/write}
+ \item{mesh}
+ \item{3D Object creator}
+ \item{math}
+ \item{misc}
+ \end {itemize}
+ \end {itemize}
+
+% ==========================================
+\subsubsection{The Package Browser}
+\label{Package_Browser}
+% ==========================================
+
+You can run it using the tool bar of the 'Command' part. See figure \ref{imPackage_Browser}.
+
+\begin{figure}[!ht]
+\caption{\label{imPackage_Browser}The Package Browser}
+\begin{center}
+\includegraphics[width=0.6\textwidth]{Package_Browser.png}
+\end{center}
+\end{figure}
+
+It allows you to query informations about what you can find in the packages (boxes and applications), using several criterions
+(warning : it's case sensitive, i.e '\texttt{Button}' will give different results than '\texttt{button}' ...)
+\begin {itemize}
+\item Packages :\\
+All the boxes and applications held in a given package (e.g. \texttt{wxvtk}, \texttt{std}, ...)
+\item Name :\\
+You can query on a subpart of the name of a box or an application (e.g. \texttt{DICOM})
+\item Description :\\
+You can query on a substring of the description of a box or an application (e.g. \texttt{utton} : user wants to get all
+the\texttt{Button} as well as the \texttt{button} )
+\item Category :\\
+You can query on a sub part of the category name of a box or an application (e.g. \texttt{3D})
+\item Input Type :\\
+You can query all the boxes or applications that have at least one Input entry of the given type (e.g. \texttt{int})
+\item Output Type :\\
+You can query all the boxes or applications that have at least one Output entry of the given type (e.g. \texttt{int})
+\item Input Nature :\\
+You can query all the boxes or applications that have at least one Input entry of the given nature (e.g. \texttt{signal})
+\item Output Nature :\\
+You can query all the boxes or applications that have at least one Output entry of the given nature (e.g.
+\texttt{signal},\texttt{file name})
+\end {itemize}
+
+
+All these criterions are \emph{AND}ed while the query process.\\
+You can get the whole description of a given box or application clicking on its name.
+
+\newpage
+
+% ==============================================
+\subsection{The Menu}
+% ==============================================
+
+At last, let's have a look at \bbStudio menu.(See figure \ref{themenu})
+
+\begin{figure}[!ht]
+\caption{\label{themenu}The bbStudio menu}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{themenu.png}
+\end{center}
+\end{figure}
+
+\begin {itemize}
+ \item{\texttt{File}}
+ \begin {itemize}
+ \item{\texttt{Open the bbtk configuration file}}
+ \item{\texttt{Quit}}
+ \end {itemize}
+ \item{\texttt{Tools}}
+ \begin {itemize}
+ \item{\texttt{Create package}} :
+ 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{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 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:
+ \begin {itemize}
+ \item{\texttt{Show 'Files' panel}}
+ \item{\texttt{Show 'Help' panel}}
+ \item{\texttt{Show 'Command' panel}}
+ \item{\texttt{Show 'Messages' panel}}
+ \item{\texttt{Launch Package browser}} The package browser is a stand alone application. This can be achieved, too,
+ using the lower tool bar : button \texttt{Start Package Browser}.
+ \item{}
+ \end {itemize}
+ \item{\texttt{About}}
+ \begin {itemize}
+ \item{\texttt{About}} : Info about \texttt{bbStudio}.
+ \end {itemize}
+\end {itemize}
+% ==========================================
+\section{bbs scripting}
+% ==========================================
+
+% ==========================================
+\subsection{Using an already existing script}
+% ==========================================
+
+Using the lower toolbar (see figure : \ref{lowertoolbar}), open the file
+holding the script.
+
+ 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}
+% object, you will have to resize the sub windows. \\ \\
+ You may modify, save or save-as the current script, using the lower toolbar.\\ \\
+ You may have a look at the graphical representation of the pipeline (sorry,
+ right now, to modify the pipeline, you have to modify the script;
+ you cannot modify grapically the pipeline; Work in progress...)
+
+
+% ==========================================
+\subsection{Inside black boxes}
+% ==========================================
+
+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:
+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 :
+
\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 :
- 'BoxChange' <bbtk::Void> [signal] : Signals modifications of the box
+ 'BoxChange' <bbtk::VoidS> [signal] : Signals modifications of the box
'Out' <Double> [] : Result
\end{verbatim}
-Like previously,
-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
-(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.
-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>})
-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 loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box by
+the command \texttt{new} :
-You can create an \emph{instance} of an \texttt{Add} box by
-the command \texttt{new}:
\begin{verbatim}
> new Add a
\end{verbatim}
The \texttt{'a'} at the end is the \emph{name} of the instance,
which will be used to reference it later.
-It is important to distinguish a box \emph{types}
+It is important to distinguish a box \emph{type}
and an \emph{instance} of a box type.
The \texttt{Add} box of the package \texttt{std} is actually
a \emph{box type} , like \texttt{int} is a data type
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.
+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:
-you can see that this type of box has two inputs,
+
+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}
+\includegraphics[width=0.7\textwidth]{HelpAdd.png}
+\end{center}
+\end{figure}
+
+
+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} ,
+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
+include a pipeline graph.
+
+You can see that \texttt{Add} boxes have 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}
-Box processing is needed if:
+%\paragraph
+
+Box processing is needed if :
+
\begin{itemize}
-\item at least input has changed since last processing or
-\item the input \texttt{'BoxProcessMode'} of the box is set to
+\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. \newline
+
+%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.
-\item \texttt{help} gives help on:
+\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 :
\begin{itemize}
\item Available commands if you just type \texttt{help}.
\item A particular command if you type \texttt{help <command-name>}.
\item A particular black box type (with full description) if you type \texttt{help <box-type-name>}. In particular, \texttt{help workspace} displays information on the content of the \texttt{'workspace'} black box, which stores the boxes created by the user (by \texttt{new}).
\end{itemize}
%\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 \texttt{new} : creates an instance of a black box.
+\item \texttt{set} : sets the value of an input of a black box.
+\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
+\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} :
+
+%\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}
+
% ==========================================
% ==========================================
\label{bbi-connecting-black-boxes}
% ==========================================
-LG : THE GUIDE IS UP TO DATE UNTIL HERE
-
\BBTK allows to create
and execute processing chains,
also called \emph{pipelines},
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
> set a.In2 2
> set b.In2 3
> print $b.Out$
+\end{verbatim}
+
+You will see the (very expected) result :
+\begin{verbatim}
6
\end{verbatim}
The first three commands build the pipeline,
-the next three set its inputs and the last one
-executes it and prints its output.
+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).
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 are 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
chains of boxes (see \ref{bbi-more-on-pipeline-processing}
for details).
+
+Lets' consider an other, more image oriented, example :
+
+\begin{verbatim}
+> include vtk
+> include wx
+> include itk
+> include wxvtk
+
+> new FileSelector fileDialog
+> new ImageReader reader
+> new Slider slider
+> new Viewer2D viewer
+
+> connect fileDialog.Out reader.In
+> connect reader.Out viewer.In
+> connect slider.Out viewer.Slice
+> connect slider.BoxChange viewer.BoxExecute
+
+> exec viewer
+\end{verbatim}
+
+Some explainations : the \texttt{include} instructions load the necessary packages. \\
+
+\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 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.\\
+\\
+\texttt{exec viewer} processes the viewer.
+
+
+This would correspond to the graph in figure \ref{bbi-simplegraph}
+
+
+\begin{figure}[!ht]
+\caption{\label{bbi-simplegraph}(Very) simple Graph of a (very) simple pipeline}
+\begin{center}
+\includegraphics[width=0.8\textwidth]{bbi-simplegraph.png}
+\end{center}
+\end{figure}
+
Of course, to be able to connect two boxes,
the output and the input must be compatibles.
You can always connect an output to an input of the \emph{same} type,
-but you can do more, thanks to particular black boxes called {\bf adaptors}.
+but you can do more, thanks to particular (hidden) black boxes called {\bf adaptors}.
An adaptor is a black box which has at least one input, called \texttt{In},
and at least one ouput called \texttt{Out} and whose role is to convert
a data of the type of \texttt{In}
into a data of the type of \texttt{Out} (other inputs or outputs may serve
-to parameter the adaptor or retreive other usefull information).
+to parameter the adaptor or retreive other useful 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.
-
-Question:
-if two adaptors with the same input and output types exist
-in the packages loaded,
-which one is chosen by \bbi at connection ?
--> Role of default adaptors
-
-Note that the \texttt{set} and \texttt{print} commands of \bbi
+however arbitrarily complex type conversion may be done.\\
+\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}
+%Question (for info-dev):
+%if two adaptors with the same input and output types exist
+%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 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
\end{verbatim}
+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}\emph{x} if there are more than one 'natural
+entry'
+.
+\newline
% ==========================================
\hrule
\paragraph{Summary}
%\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
Once you have defined a new type of complex box, you
may like to reuse it. To do this, you can simply
write the \bbi commands defining the new box
-into a text file and afterwards include that file in \bbi.
+into a text file and afterwards include that file in \bbins.
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{Add3.bbs} file:
+can be defined in the \texttt{bbAdd3.bbs} file :
-\begin{file}{Add3.bbs}
+\begin{file}{bbAdd3.bbs}
\begin{verbatim}
# Defines the Add3 black box which adds 3 doubles
load std
\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 Add3.bbs
+> 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}{Add4.bbs}
+\begin{file}{bbAdd4.bbs}
\begin{verbatim}
# Defines the Add4 black box which adds 4 doubles
include Add3
\end{verbatim}
\end{file}
-TO DO:
-- naming conventions: one cbb per file with the same name
-- search paths
+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}
+
+
+% ==========================================
+%\hrule
+%\paragraph{Naming Conventions}
+%\hrule
+
+%\hrule
+% ==========================================
+\begin{itemize}
+\item
+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 :
+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).
+
+\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{\#} 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 ending 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-widget}
% ==========================================
-If \bbi is compiled in graphical mode
-(option \texttt{BUILD\_bbi\_GRAPHICAL} of \cmake, requires \wx),
-then you can use special black boxes which are
-graphical interface components (widgets).
-Basic components are provided in the package \texttt{wx},
+% ==========================================
+\subsubsection{Overview}
+\label{bbi-overview}
+% ==========================================
+.
+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:
+As first example, type the following commands in \bbi :
\begin{verbatim}
> load wx
-> new TextCtrl t
+> new InputText t
> print $t.Out$\n
\end{verbatim}
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 (slider, button ...) based on wxWidgets
- Black boxes:
- Button : Button that gives a string
- ColourSelectorButton :
- ColourSelector : Colour Selector widget (wxColourDialog)
- CommandButton :
- DirectorySelector :
- FileSelector : FileDialog widget (wxFileDialog)
- InputText : TextCtrl widget (wxTextCtrl)
- LayoutLine : Sizer widget (wxSizer)
- LayoutSplit : Split widget (wxSplitterWindow)
- NoteBook :
- OutputText : wxWidget Static text
- RadioButton : RadioButton group widget (wxRadioButton) 0-9 entries
- Slider : Slider widget (wxSlider)
-
+ Package wx v1.0.0- info-dev@creatis.insa-lyon.fr
+ Basic graphical interface elements (sliders, buttons ...) based on wxWidgets
+ Black boxes :
+ ColourSelector : Colour Selector dialog (bbfication of wxColourSele...
+ ColourSelectorButton : A button which displays a colour picker dialog whe...
+ CommandButton : Button which executes bbi commands
+ DirectorySelector : Pops up a directory selection dialog (wxDirDialog)
+ FileSelector : Pops up a file selection dialog for reading or sav...
+ InputText : A zone in which the user can enter a text (wxTextC...
+ LayoutLine : LayoutLine widget (wxBoxSizer)
+ LayoutSplit : Widget which splits a window in two fixed size par...
+ LayoutTab : LayoutTab widget (wxNotebook)
+ OutputText : Text zone to be inserted into a window (wxStaticTe...
+ RadioButton : RadioButton group widget 0-9 entries
+ Slider : Slider widget (wxSlider)
\end{verbatim}
You can reproduce the same experiment as above using a
-\texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{TextCtrl}.
-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 kind of widgets: ``terminal'' widgets and ``container'' widgets.
-The \texttt{TextCtrl}, \texttt{FileDialog} or \texttt{Slider} widgets
-are ``terminal'' widgets.
-``container'' widgets are of another kind: they are made to
+
+%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
+There is a special kind of widget, called '\texttt{Layout}', designed to
contain other widgets in order to build larger dialog boxes.
-For example, the \texttt{Split} widget is a container which
+For example, the \texttt{LayoutSplit} widget is a container which
``splits'' horizontally a window into two parts,
each part including another widget.
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.
-Run it: it displays a window with two sliders.
+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}
new Slider s1
new Slider s2
-new Split s
-connect s.Child s1.Parent
-connect s.Child s2.Parent
+new LayoutSplit s
+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{Split} box \texttt{s} is also created.
+A \texttt{LayoutSplit} box \texttt{s} is also created.
The \texttt{connect} commands then ``includes'' the sliders in the
-split ``container''.
-The input \texttt{Parent} is common to all widget boxes:
+split widget.
+The input \texttt{Widget} is common to all widget boxes :
every widget can be inserted into another widget.
-The output \texttt{Child} is 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 input \texttt{Parent};
-type \texttt{help Split}:
-you will see the input \texttt{Parent}
-and the output \texttt{Child}).
-When you connect the \texttt{Child} output of a container
-to the \texttt{Parent} input of a widget,
-you order to include the widget in the container.
+(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 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{Split} box is
+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).
-For the moment, there are only \emph{two} container widgets in the \texttt{wx} package:
-the \texttt{Split} widget we just described and the \texttt{Sizer}
-widget, which can have multiple children and
+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 (Widgeti inputs) and
divides its window into as much parts as children,
each part of equal size.
-The orientation of the sizer 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{test/testSizerSplit.bbs} for an example.
+The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
+%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.
+\end{itemize}
-One word about a special widget in the package \texttt{wx}:
-the \texttt{Button}... to be continued.
+%=====> TODO \\
+
+
+%One word about a special widget in the package \texttt{wx} :
+%the \texttt{Button}... to be continued.
+
+% ==========================================
+\subsubsection{Deeper in the boxes}
+\label{bbi-deep-box}
+% ==========================================
+
+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 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 input changed (e.g. : FileSelector, ColorSelector)\\
+ This one is not end user intended (for Package developer only)
+ \end{itemize}
+\end{itemize}
+
+Any widget box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout box} :
+\begin{itemize}
+ \item {\bf\emph{WinHeight}} : Height of the window
+ \item {\bf\emph{WinWidth}} : Width of the window
+ \item {\bf\emph{WinTitle}} : Title of the window
+ \item {\bf\emph{WinClose}} : Any received signal closes the window
+ \item {\bf\emph{WinHide}} : Any received signal hides the window
+ \item {\bf\emph{WinDialog}} : When set to 'true', creates a \emph{dialog window}, that blocks the pipeline until it is closed (\emph{modal})
+\end{itemize}
+
+
+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.\\
+ 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 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.
+
+\end{itemize}
-TO DO:
-\begin{enumerate}
-\item Make a tour of ``complex'' widgets of wxvtk
-\item Explain the role of ProcessMode to update widgets
-\item Explain the creation of complex widgets (containers, contained...)
-\item Explain the ``control'' mechanism in bbi (switch exec commands, e.g. Button)
-\end{enumerate}
% ==========================================
% ==========================================
% ==========================================
-\subsubsection{Black box packages}
-\label{bbi-more-on-packages}
+%\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} \\
+%\item{itk} \\
+%\item{...} \\
+%\end{itemize}
% ==========================================
\subsubsection{Pipeline processing}
\label{bbi-more-on-pipeline-processing}
% ==========================================
+\begin{itemize}
+\item the ``control'' mechanism in bbi.
-% ==========================================
-\subsubsection{Complex black boxes}
-\label{bbi-more-on-complex-black-boxes}
+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{Advanced issues}
%\paragraph{Reducing the number of inputs of a box}
% ==========================================
-\subsubsection{Errors}
-\label{bbi-more-on-errors}
+%\subsubsection{Errors}
+%\label{bbi-more-on-errors}
% ==========================================
-\subsubsection{\bbtk configuration file and search pathes}
-\label{bbi-more-on-configuration}
+\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 \texttt{BBTK\_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} until there is no longer any area quoted with a * (or highlighted in red)\\
+Ask for generation (type \texttt{g} -once is always enough-)
+
+\item Ask for compilation and link.
+\begin{verbatim}
+make
+\end{verbatim}
+
+
+The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \texttt{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}
+% ==========================================
+
+
+\newpage
+
+
+
+% ==========================================
+%\vspace{0.5cm}\hrule \\
+
+\section{Using third party Package}
+\label{Third_Party_Package}
+% ==========================================
+% ==========================================
+\subsection{Plugging in a Package}
+\label{Plugging_in_a_Package}
+% ==========================================
+
+\bbStudio makes it easy for you : in the menu \texttt{Tools} just click on the
+option \texttt{Plug Package}. You will be asked to to '\texttt{Select
+package directory}'. Browse untill you find the the install tree, or the the build tree,
+depending whether you installed the package or not.\\
+
+\bbStudio will update the Configuration file, generate the 'Package
+documentaion', and update the 'Box List'.\\
+You will be able to use the new package just as you did for any other \bbtk
+canonical Package.
+
+% ==========================================
+\subsection{Hard incorporating of a Package}
+\label{Hard_incorporating_of_a_Package}
+% ==========================================
+
+If the Package you want to use is supplied in a non standard way (e.g. : you
+where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and
+one or more directories containing \bbtk scripts (\texttt{.bbs}), you will have
+to proceed to some (simple) manual operations.\\
+\texttt{Nota bene} : This way is hightly discouraged !
+
+% ==========================================
+\subsubsection{More on the configuration file}
+\label{The_configuration_file}
+% ==========================================
+
+First, have a glance at the Configuration, just clicking on \texttt{Config} button of the \texttt{Command} part toolbar.
+
+You'll get something like :
+
+\begin{verbatim}
+=============
+ Configuration
+ =============
+ bbtk_config.xml : [/home/jpr/Creatis/bbtk/binLIN/bin/bbtk_config.xml]
+ Documentation Path : [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/doc]
+ Data Path : [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/data]
+ Temp Directory : [/home/jpr/Creatis/bbtk/binLIN]
+ File Separator : [/]
+ BBS Paths
+ --- [.]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/bbs]
+ --- [/home/jpr/Creatis/bbtk/binLIN/share/bbtk/bbs]
+ PACKAGE Paths :
+ --- [.]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin/../lib]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin\Debug]
+ --- [/home/jpr/Creatis/bbtk/binLIN/bin\Release]
+\end{verbatim}
+
+(depending on who you are, and whether \texttt{bbStudio} is installed or not.)\\
+
+Note the two main parts : \texttt{BBS Paths} and \texttt{PACKAGE Paths}
+\subsubsection{How bbStudio uses the Configuration file}
+\label{How_bbStudio_uses_the_Configuration_file}
+
At start, \bbi tries to open an \texttt{xml}
configuration file named \texttt{bbtk\_config.xml}.
variable \texttt{USERPROFILE},
typically \texttt{C:\\...}.
\end{itemize}
-\item If none of these two pathes contains the file then it creates
+\item If none of these two paths contains the file then it creates
a new one in the \texttt{.bbtk} directory.
\end{enumerate}
-Once created, you can edit the \texttt{bbtk\_config.xml} file located
-in your \texttt{.bbtk} directory. It contains:
-\begin{file}{bbtk\_config.xml}
+To use a third party Package, you will have to update it.\\
+
+\subsubsection{Modifying the Configuration file}
+\label{Modifying_the_Configuration_file}
+
+Just use the \texttt{Open bbtk Config file} option of the \texttt{Files} of the \bbStudio menu.
+
+You will get something like :
\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>
+ <description> Sets the search directories in the build tree </description>
+ <url> </url>
+ <bbs_path> /home/jpr/Creatis/bbtk/binLIN/share/bbtk/bbs </bbs_path>
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin </package_path>
+# For windows
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Debug </package_path>
+ <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Release </package_path>
+#
<data_path> </data_path>
+#
+ <default_temp_dir> /home/jpr/Creatis/bbtk/binLIN </default_temp_dir>
</config>
\end{verbatim}
-\end{file}
-You can add pathes to
+To use a new Package :
+\begin{itemize}
+\item {}
+After the already existing \texttt{xml} tags
+\texttt{bbs\_path}
+ (i.e. the lines begining by
+ \texttt{<bbs\_path>}
+ %bbs_path
+and ending by
+\texttt{</bbs\_path>}),
+you can add paths to :
+\begin{itemize}
+\item A custom folder in which to search for \texttt{.bbs} scripts (\texttt{include} command of \bbins) by adding
+ an \texttt{xml} tag:\\
+ \texttt{<bbs\_path>}
+\emph{complete\_path\_to\_scripts\_folder}
+\texttt{<\/bbs\_path>}.
+\end{itemize}
+
+\item {}
+After the already existing tags
+\texttt{package\_path}
+ (i.e. the lines begining by
+ \texttt{package\_path}
+ %bbs_path
+and ending by
+\texttt{/package\_path}),
+you can add paths 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:
-\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:
-\texttt{<package\_path>complete\_path\_to\_folder<\/package\_path>}.
+\item A custom folder in which to search for packages (the dynamic libraries
+ (\texttt{.dll} or \texttt{.so}, called with the \texttt{load} command of \bbins) by adding an \texttt{xml} tag :\\
+\texttt{<package\_path>}
+\emph{complete\_path\_to\_dynamic\_library\_folder}
+\texttt{<\/package\_path>}.
\end{itemize}
+\end{itemize}
+
+%\end{itemize}
% ==========================================
-\subsection{Language reference}
-\label{bbi-reference}
+\subsection{Updating the documentation}
+\label{Updating_the_documentation}
% ==========================================
+You may add your own boxes (simple boxes, if you are aware enough in \CPP
+language), or complex boxes if you are aware enough in bbtk scripting).
+
+To be able to use the Help tools as well as the features provided by this package,
+ you must use the
+option \texttt{Regenerate package doc} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+You'll be prompted for the Package name. Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
+
+To benefit the features of Box indexing you must use the
+option \texttt{Regenerate Boxes Lists} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+
+
+% ==========================================
+\subsection{Using the package}
+\label{Using_the_package}
+% ==========================================
+
+The only thing you have to do is to \texttt{load} the package, within the script, or from the
+\texttt{Command} part, and enjoy the black boxes it contains.
+
+% ==========================================
+\subsection{Packages you'll probably want to use }
+\label{Packages_you_ll_want_to_use}
+% ==========================================
+\begin {itemize}
+\item{\texttt{creaLib}} \\
+a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
+packages (an, sure, useful as well for people that doesn't use bbtkns.
+
+\item{\texttt{creaContours}} \\
+Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
+\item{\texttt{creaImageIO}} \\
+Allows browsing, selectionning, ordering directories containing images of almost any type
+(including DICOM)
+\end {itemize}
+
+\newpage
+
+% ==========================================
+%\vspace{0.5cm}\hrule \\
+\section{Using black boxes in \CPP programs}
+\label{cpp}
+% ==========================================
+
+A very useful feature is that you may use any black box within a \CPP program without worrying about \texttt{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 the standalone application \texttt{bbc} 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{Language reference}
+\label{bbi-reference}
+% ==========================================
+% ==========================================
+\subsection{Pipeline creation and execution related commands}
+\label{bbi-reference-creation-execution}
+% ==========================================
+ See table \ref{bbi-reference-box}
% ==========================================
\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
\texttt{set} & \texttt{<box.input>} \texttt{<value>} &
Sets the input \texttt{input} of
the box named \texttt{box} to the value \texttt{value}.
-There must exist an \texttt{adaptor}
+An \texttt{adaptor} must exist
in the packages loaded which converts a \texttt{std::string}
-to the type of the input \texttt{input}.
- \\ \hline
+to the type of the input \texttt{input}. \\ \hline
\texttt{print} & \texttt{<string>} &
Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
output \texttt{output} of the box named \texttt{box}.
-There must exist an \texttt{adaptor}
+An \texttt{adaptor} must exist
in the packages loaded which converts
the type of the output \texttt{output}
to a \texttt{std::string}.
If needed the boxes
connected to its inputs
are also processed recursively (pipeline processing).\\ \hline
+\texttt{exec} & \texttt{freeze} &
+ Allows to block execution commands while keeping definition commands active.(This one is not for end user)\\ \hline
+\texttt{exec} & \texttt{unfreeze} &
+ Turns back to 'normal' mode (This one is not for end user).\\ \hline
\end{tabular}
\end{table}
% ==========================================
+\newpage
-
+% ==========================================
+\subsection{Interpreter related commands}
+\label{bbi-reference-interpreter}
+% ==========================================
+See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-interpreter}\bbi intepreter related commands.}
+\caption{\label{tabbbi-reference-interpreter_1}\bbi intepreter related commands (part 1).}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
+\texttt{author} & \texttt{<author-name>} &
+Adds the string \texttt{<author-name>} to the author information of the black box being defined \\ \hline
+
+\texttt{category} & \texttt{<category-name>} &
+ Adds the string \texttt{<category-name>} to the category information of the black box being defined \\ \hline
\texttt{help} & - &
Prints help on available commands \\ \hline
& \texttt{<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{<debug-directive>} &
+[expr|-C|-D]
+ Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
+ \texttt{-C} checks the factory integrity.
+ \texttt{-D} turns on objects debug info after main ends\\ \hline
\texttt{include} & \texttt{<file-name>} &
Includes and executes the content of the file named \texttt{file-name}
exactly like if you were typing its content at the place were the
-\texttt{include} command is.
-\\ \hline
+\texttt{include} command is. \\ \hline
\texttt{load} & \texttt{<package-name>} &
-Loads the package \texttt{package-name}\\ \hline
+Loads the package \texttt{package-name} (use it only if you know that you won't work with complex black boxes) \\ \hline
+
+\texttt{include} & \texttt{<package-name>} &
+Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline
+
+\texttt{kind} & \texttt{<box kind>} &
+Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline
+\end{tabular}
+\end{table}
+%
+% This arbitrary part1/part2 is to avoid to have all the tables at the end of the docoment ...
+%
+
+\begin{table}[!ht]
+\caption{\label{tabbbi-reference-interpreter_2}\bbi intepreter related commands (part 2).}
+\small
+\begin{tabular}{|lcm{6cm}|}
+\hline
+Command & Parameters & Effect \\ \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}.
+\texttt{category} to \texttt{level}.\\ \hline
%See \ref{verbosity}.
-\\ \hline
\texttt{config} & - & Displays the Configuration parameters\\ \hline
\texttt{reset} & - & Deletes all boxes and unloads all packages so
that \bbi gets back to its initial state \\ \hline
-\texttt{quit} & - & Exits the interpreter\\ \hline
+\texttt{quit} & - & Exits the interpreter (Don't use it under \bbStudions)\\ \hline
\end{tabular}
\end{table}
% ==========================================
+\newpage
+% ==========================================
+\subsection{Complex black box definition related commands}
+\label{bbi-reference-black-box-definition}
+% ==========================================
-
-
+See table \ref{bbi-reference-complex-box}
% ==========================================
\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
\texttt{endefine} & - &
Ends the definition of a complex black box type\\ \hline
-
\texttt{author} & \texttt{<string>} &
Sets the author(s) of the complex black box currently being defined \\ \hline
\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,
named \texttt{name}.
It is defined as corresponding to
-the input \texttt{input} of the box \texttt{box}.
+the input \texttt{input} of the box \texttt{box}.
+
\texttt{<help>} is the help string for the new input.
The box \texttt{box} must already have been created in the complex box
-and of course have an input named \texttt{input}.
-\\ \hline
-
+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
+\section{Install and run time issues}
+\begin {itemize}
+\item{make} \\
+For some strange reasons (?!?), at \texttt{cmake} time, you may be warned that an error occured while documentation generation.\\
+Take it easy, \texttt{make} again!\\
-% ==========================================
-\vspace{0.5cm}\hrule
-\section{Using black boxes in \CPP programs}
-\label{cpp}
-% ==========================================
-
-
-
+\item{\bbStudio} is written using the Advanced User Interface library of wxWidgets.
+If, after some hazardous floating/docking operations onto the frame, you feel
+very unhappy with the result, just remove from the hidden directory
+\texttt{.bbtk} the file named \texttt{bbStudio.aui}. \\
-%\bibliography{all}
+
+\end {itemize}
+%\section{Conclusion}
-%\section{Conclusion}
\end{document}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff