+% # ---------------------------------------------------------------------
+% #
+% # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+% # pour la SantÈ)
+% # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+% # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+% # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+% #
+% # This software is governed by the CeCILL-B license under French law and
+% # abiding by the rules of distribution of free software. You can use,
+% # modify and/ or redistribute the software under the terms of the CeCILL-B
+% # license as circulated by CEA, CNRS and INRIA at the following URL
+% # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+% # or in the file LICENSE.txt.
+% #
+% # As a counterpart to the access to the source code and rights to copy,
+% # modify and redistribute granted by the license, users are provided only
+% # with a limited warranty and the software's author, the holder of the
+% # economic rights, and the successive licensors have only limited
+% # liability.
+% #
+% # The fact that you are presently reading this means that you have had
+% # knowledge of the CeCILL-B license and that you accept its terms.
+% # ------------------------------------------------------------------------ */
+%
+
+
% ==========================================
\documentclass[11pt,final,a4paper]{article}
-\input{config.tex}
+\input config.tex
\begin{document}
\bbtkGuide[User's Guide]
% ==========================================
\hrule
\section{Introduction}
Note: pdf version of this User's Guide can be retrieved from the following URL:\\
-\url{http://www.creatis.insa-lyon.fr/creatools/documentation}
+\url{http://www.creatis.insa-lyon.fr/site/en/CreatoolsDocumentation}
% ==========================================
\subsection{What is bbtk?}
% ==========================================
% ==========================================
% ==========================================
-\subsubsection{\bbtk components}
+\subsubsection{{\bbtk} components}
% ==========================================
\BBTK includes:
\begin{itemize}
Command-line help for the black box scripting language \bbs (see section \ref{Scripting}) can be obtained in this zone. \par
As mentioned above, the command (or button) \texttt{help} permits to print in the \texttt{Message} zone the list of all recognized commands, while the command \texttt{help} \emph{command\_name} displays in this zone the help about the selected command.\par
The command \texttt{help} \emph{package\_name} displays in the \texttt{Message} zone a short information about the selected package, provided that this package was previously loaded (Note that you can know which packages were loaded by executing the command \texttt{help packages}). Furthermore, it simultaneously displays in the right zone (\texttt{Help}) the corresponding full html help available.\par
-In a similar way, one can obtain the information about any box from the loaded packages, by executing the command \texttt{help} \emph{box\_name}. Note that some boxes may be unavailable if the command \texttt{load} was used to load the package, since this command only loads the boxes in binary. Some boxes are defined in script files. To be sure that all the boxes from the package are loaded the command \texttt{include} is to be preferred.\par
-You can also get the list of the objects currently present in the workspace, by executing the command \texttt{help workspace}.
+In a similar way, one can obtain the information about any box from the loaded packages, by executing the command \texttt{help} \emph{box\_name}. Note that some boxes may be unavailable if the command \texttt{load} was used to load the package, since this command only loads the boxes defined in binary files (dynamic libraries). Some boxes are defined in script files. To be sure that all the boxes from the package are loaded the command \texttt{include} is to be preferred.\par
+
+It is important to note that the black boxes are implemented and have to be used according to the {\bf\emph{object-oriented}} programming principles. This means that you have to make difference between a black box {\bf\emph{type}} and an {\bf\emph{instance}} of the given black box type. The former defines a ``pattern'' (a mold), according to which are formed the actual objects. If you query for help on a black box type, you learn about its purpose, its author, the boxes it contains (if it is a complex black box) and the types of its inputs/outputs. The user-defined black box types belong to the package \texttt{user} and can be listed by use of the command \texttt{help user}. If you query for help on a black box instance, you learn about the values and the state of its inputs/outputs. The currently existing black box instances belong to the complex black box \texttt{workspace} and can be listed by use of the command \texttt{help workspace}.
% ==========================================
\subsubsection{Guides}
% ==========================================
All the guides can be browsed in html version in the \texttt{Help} part of \bbStudions. Their pdf versions (except Doxygen documentation) can be retrieved from:\\
-\url{http://www.creatis.insa-lyon.fr/creatools/documentation}
+\url{http://www.creatis.insa-lyon.fr/site/en/CreatoolsDocumentation}
\begin{itemize}
\item {\bf\emph{User's Guide}}: This guide!
\item\texttt{misc}: Miscellaneous...
\end {itemize}
Remark that the list of categories is 'auto-extensible': each time a new box is created which belongs to a new category and the boxes list is regenerated, the new category appears in the list, holding the new box. The above list only contains the categories used in the packages provided with current \bbtk release.
- \item {\bf\emph{ List of adaptors}}: The adaptors are a special type of black boxes that are used internally to perform type conversions. Although they are not end user intended, you may see their list. Adaptors belong to the \texttt{adaptor} category.
+ \item {\bf\emph{List of adaptors}}: The adaptors are a special type of black boxes that are used internally to perform type conversions. Although they are not end user intended, you may see their list. Adaptors belong to the \texttt{adaptor} category.
\end {itemize}
- For each box, the html \texttt{Help} provides the informations necessary to use it: its name, its purpose, the descriptions of its inputs/outputs and the name of the package (or script file) that is to be loaded. Additionally, for all boxes but the atomic ones (i.e. for all boxes defined in \bbs script language), the corresponding script is available via [\texttt{source}] link. Actually, by clicking on this link, one loads the script into the \texttt{Files} area where it can be analyzed, edited and executed.
+ For each box, the html \texttt{Help} provides the informations necessary to use it: its name, its purpose, the descriptions of its inputs/outputs and the name of the package (or script file) that is to be loaded. Note that for a given box only the inputs/outputs listed in white cells are of actual interest. The remaining ones, grouped after them in colored cells, are standard (have the same names and purpose) in all atomic boxes. Additionally, for all boxes but the atomic ones (i.e. for all boxes defined in \bbs script language), the corresponding script is available via [\texttt{source}] link. Actually, by clicking on this link, one loads the script into the \texttt{Files} area where it can be analyzed, edited and executed.
% ==========================================
\subsubsection{The Package Browser}
\item \texttt{Name}: The name of a box or an application (e.g. \texttt{Reader}, \texttt{example}).
\item \texttt{Description}: A part of the description of a box (e.g. \texttt{3D}, \texttt{image}).
\item \texttt{Category}: The categories of the box (e.g. \texttt{demo}).
-\item \texttt{Input/Output Type}: The \CPP type of an input or output (e.g. \texttt{vtkImageData*}, \texttt{std::string}).
+\item \texttt{Input/Output Type}: The \CPP type of an input/output (e.g. \texttt{vtkImageData*}, \texttt{std::string}).
\item \texttt{Input/Output Nature}: The \texttt{nature} of an input or output (e.g. \texttt{file name}, \texttt{signal}).
\end {itemize}
% ==========================================
-\subsection{Creating and executing black boxes}
+\subsection{Creating and executing black box instances}
% ==========================================
At start the interpreter does not know any black box.
which is a special type of black box,
called complex black box, the purpose of which is
to store other black boxes.
-Any black box you create in \bbStudio is stored
+Any black box instance you create in \bbStudio is stored
in \texttt{workspace}
(see also section \ref{bbi-command-line-app}).
\end{verbatim}
In the text displayed,
-the \texttt{user::} prepended to the name \texttt{workspace}
+the \texttt{user::} prefixed to the name \texttt{workspace}
means that the box \texttt{workspace}
belongs to the \texttt{user} package.
Then comes a description and three lines which
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.
+which contains basic useful black box types.
To load it, type:
\begin{verbatim}
workspace
\end{verbatim}
-Now the interpreter knows the package \texttt{std} and the black boxes it provides,
+Now the interpreter knows the package \texttt{std} and the black box types 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. Note that you will get a more detailed information about the package loaded (here \texttt{std}) if you type:
+as new black box types might be added to it. Note that you will get a more detailed information about the package loaded (here \texttt{std}) if you type:
\begin{verbatim}
> help std
\end{verbatim}
By : laurent.guigues@creatis.insa-lyon.fr
Categories : atomic box;math;
* Inputs :
- 'BoxExecute' <bbtk::Void> [signal] : Any signal received...
+ 'BoxExecute' <bbtk::Void> [signal] : Any signal received ...
executes the box
- 'BoxProcessMode' <String> [] : Sets the processing mode...
- (Pipeline | Always |...
+ 'BoxProcessMode' <String> [] : Sets the processing ...
+ (Pipeline | Always...
'In1' <Double> [] : First number to add
'In2' <Double> [] : Second number to add
* Outputs :
Here \texttt{'a'} is the \emph{name} of the instance,
which will be used to reference it later.
-It is important to distinguish a box \emph{type}
+Remind that 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
Of course, like in \texttt{C} Language, you can declare multiple boxes of the
same type in \bbs.
-After the creation of the box \texttt{a}, type:
+After the creation of the box instance \texttt{a} the command:
\begin{verbatim}
> help workspace
\end{verbatim}
-you get :
+gives the following result:
\begin{verbatim}
Complex Black Box <user::workspace>
User's workspace
\item Converts the output of the box to a string if possible
(see below)
\item Substitutes the result in the string to print
-\item Postpones an implicit 'new line' character to the string
+\item Places an implicit 'new line' character after the string
\end{enumerate}
%\paragraph
> 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}
\item The \texttt{include} instructions load the necessary packages.
\item \texttt{FileSelector} will pop, at run time, a File Selector dialog box that will output the user-selected file name.
\item \texttt{ImageReader} will read any itk readable file, the name of which is passed as a std::string, and return a pointer on an itk image.
- \item \texttt{Slider} will pop, at run time, a Slider widget that will output an integer number, used later as a slice number.
- \item \texttt{Viewer2D} displays a plane, the number of which is specified by an integer.
- \item \texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a \texttt{std::string}) to the input of the reader (a \texttt{std::string}, too).
- \item \texttt{connect reader.Out viewer.In} plugs the output of the reader \\(a \texttt{bbtk::any<bbitk::ImagePointer>} which is a type defined by the
+ \item \texttt{Viewer2D} will display a two-dimensional image.
+ \item \texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a \texttt{std::string}) to the input of the Image Reader (a \texttt{std::string}, too).
+ \item \texttt{connect reader.Out viewer.In} plugs the output of the Image Reader \\(a \texttt{bbtk::any<bbitk::ImagePointer>} which is a type defined by the
itk package, and which can hold any itk image pointer) to the input of the Viewer (a \texttt{vtkImageData *})
-\item \texttt{connect slider.Out viewer.Slice} plugs the output of the slider (an \texttt{int}) to an other output (named Slide) of the viewer.
- \item \texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer that it must re process itself any time the slider is modified.
-\item \texttt{exec viewer} processes the viewer.
+ \item \texttt{exec viewer} processes the Viewer.
\end{itemize}
-This would correspond to the graph in figure \ref{bbi-simplegraph}
-
+This would correspond to the graph in figure \ref{bbi-verysimplegraph}.
\begin{figure}[!ht]
-\caption{\label{bbi-simplegraph}(Very) simple Graph of a (very) simple pipeline}
+\caption{\label{bbi-verysimplegraph}(Very) simple Graph of a (very) simple pipeline}
\begin{center}
-\includegraphics[width=0.8\textwidth]{bbi-simplegraph.png}
+\includegraphics[width=0.8\textwidth]{bbi-verysimplegraph.png}
\end{center}
\end{figure}
and at least one output called \texttt{Out} and the role of which 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 retrieve other useful information).
+to parameter the adaptor or retrieve other useful information). In the example above the appropriate adaptor that converts \texttt{bbtk::any<bbitk::ImagePointer>} into \texttt{vtkImageData *} is provided in the package \texttt{itkvtk}.
-Under \bbStudions, if you type :
+Most of the useful standard adaptors are provided in the package \texttt{std}. Under \bbStudions, if you type :
\begin{verbatim}
> load std
> help std all
% ==========================================
% ==========================================
-\subsection{Creating complex black boxes}
+\subsection{Writing scripts files}
+\label{bbi-writing-scripts}
+% ==========================================
+
+Now that you know how to connect the existing black boxes, you will soon realize that you want to save and reuse some sequences of commands that you are particularly glad of. In the following subsections you will learn how to write ``simple'' pipeline applications and new complex black boxes built of existing black boxes.
+
+% ==========================================
+\subsubsection{Stand-alone pipeline applications}
+\label{sec:pipeline-appli}
+% ==========================================
+
+Let us take an example similar to that from section \ref{bbi-connecting-black-boxes}:
+
+\begin{verbatim}
+> include vtk
+> include wx
+> include itk
+> include wxvtk
+> include itkvtk
+
+> new DirectorySelector dirSelect
+> new DICOMDirReader reader
+> new Slider slider
+> new Viewer2D viewer
+
+> connect dirSelect.Out reader.In
+> connect reader.Out viewer.In
+> connect slider.Out viewer.Slice
+> connect slider.BoxChange viewer.BoxExecute
+> set slider.ReactiveOnTrack 1
+
+> exec viewer
+\end{verbatim}
+
+This is an elementary DICOM-image slicer (fig.~\ref{fig:simpleslicer}) designed to view 3D medical images slice-by-slice. The image is to be composed of a series of DICOM files contained in a separate directory. The index of the slice to be displayed is selected by means of a slider. The command \texttt{connect slider.BoxChange viewer.BoxExecute} permits the Viewer to update the display every time the output of the Slider changes. The command \texttt{set slider.ReactiveOnTrack 1} on its turn makes that the output of the Slider changes every time its cursor is moved, while the default behavior is to change only when the mouse-button is released after moving the cursor.\\
+
+\begin{figure}[!ht]
+\caption{ Graph of a (very) simple 3D slicer}
+\begin{center}
+\includegraphics[width=0.8\textwidth]{bbi-simplegraph.png}
+\end{center}
+\label{fig:simpleslicer}
+\end{figure}
+
+Despite its simplicity, this application may already be useful. If you want to reuse it, you have to save the \bbs commands in a text file. The conventional (and mandatory) extension for such script files is \texttt{bbs}
+(black box script). For example, our elementary 3D DICOM-image slicer
+can be defined in the following file:
+
+\begin{file}{my\_slicer.bbs}
+\begin{verbatim}
+# my_slicer.bbs: elementary 3D image slicer"
+/*
+ the 3D image has to be stored in a separate directory
+ as a series of DICOM files representing the 2D slices
+*/
+
+include vtk
+include wx
+include itk
+include wxvtk
+include itkvtk
+
+new DirectorySelector dirSelect
+new DICOMDirReader reader
+new Slider slider
+new Viewer2D viewer
+
+connect dirSelect.Out reader.In
+connect reader.Out viewer.In
+connect slider.Out viewer.Slice
+connect slider.BoxChange viewer.BoxExecute
+set slider.ReactiveOnTrack 1
+
+exec viewer
+\end{verbatim}
+\end{file}
+
+Lines starting with a \texttt{\#} character or with double slash (\texttt{\//\//}) are ignored, they
+are considered as comments by the interpreter. A longer comment can be placed between the marks \texttt{\//*} and \texttt{*\//}. Each of this mark is to be placed alone in a separate line, like in the example.\par
+
+To use this file in \bbStudions, click on the \texttt{include} button, and browse your filestore to find the file. You can also type the command:
+
+\begin{verbatim}
+> include my_slicer.bbs
+\end{verbatim}
+
+provided that \bbStudio knows the path to the desired \texttt{bbs} file.
+See the section \ref{The_configuration_file} to learn about the configuration file and the way to add a new path to it. Note that, if you modify the configuration file, you will have to close \bbStudio and run it again, so that the new configuration be taken into account.
+
+Actually, since the file has the \texttt{bbs} extension, you can omit it and just type:
+\begin{verbatim}
+> include my_slicer
+\end{verbatim}
+
+% ==========================================
+\hrule
+
+\paragraph{Summary}
+%\hrule
+\begin{itemize}
+\item The \texttt{include} command tells the interpreter to include a script file.
+\item Lines starting with \texttt{\#} or \texttt{\//\//} are considered as comments by the interpreter.
+\item A longer comment can be written between two empty lines only containing \texttt{\//*} and \texttt{*\//} respectively.
+\end{itemize}
+
+\hrule
+% ==========================================
+
+% ==========================================
+\subsubsection{Creating complex black boxes}
\label{bbi-complex-black-boxes}
% ==========================================
\end{center}
\end{figure}
-The \bbs commands to define this complex black box are
-the following:
+The \bbs script file defining this complex black box will be as follows:
\begin{verbatim}
-> load std
-> define Add3
-> new Add a
-> new Add b
-> connect a.Out b.In1
-> author "myself"
-> description "adds 3 doubles"
-> input x a.In1 "first double to add"
-> input y a.In2 "second double to add"
-> input z b.In2 "third double to add"
-> output result b.Out "output"
-> endefine
+# bbAdd3.bbs: defines the Add3 black box which adds 3 doubles
+load std
+
+define Add3
+ author "myself"
+ description "adds 3 doubles"
+ category "example"
+ category "misc"
+ # Pipeline creation
+ new Add a
+ new Add b
+ connect a.Out b.In1
+ # Inputs definition
+ input x a.In1 "first double to add
+ input y a.In2 "second double to add
+ input z b.In2 "third double to add"
+ # Output definition
+ output result b.Out "output"
+endefine
\end{verbatim}
Explanations:
\item The command \texttt{define} then starts the definition
of the complex box type that will be called \texttt{Add3}.
\item The next three lines define the pipeline,
-exactly in the same way as outside a complex box definition.
+exactly in the same way as outside of a complex box definition.
\item The commands \texttt{author}, \texttt{description}, \texttt{input}
and \texttt{output} are specific to complex boxes definition:
\begin{itemize}
- \item \texttt{author} and \texttt{description} are used for the documentation
-of the new box. You can provide multiple \texttt{author} or
-\texttt{description} commands, the arguments of the commands will
-be concatenated to produce the final author and description strings.
+ \item \texttt{author}, \texttt{description} and \texttt{category} are used for the documentation of the new box. You can provide multiple \texttt{author} or \texttt{description} commands, the arguments of the commands will be concatenated to produce the final author and description strings. As for multiple \texttt{category} commands, each of them produces a separate entry for the documentation.
\item \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
to which internal input/output it corresponds and to provide
new box type.
\end{itemize}
-After this definition, if you ask for help
-on packages, you get:
+If you type the command \texttt{include bbAdd3} and then you ask for help
+on the contents of the \texttt{user} package, you get:
+
\begin{verbatim}
-> help packages
-std
- Add
- ...
-user
- Add3
- workspace
+> help user
+ Package user - internal
+ User defined black boxes
+ Black boxes :
+ Add3 : adds three numbers
+ workspace : User's workspace
\end{verbatim}
The \texttt{user} package now contains a new black box type, called
Complex Black Box <user::Add3>
adds 3 doubles
By : myself
+ Category(s) : complex box;example;misc;
* Inputs :
'x' <double> [] : first double to add
'y' <double> [] : second double to add
\paragraph{Summary}
%\hrule
\begin{itemize}
-\item The \texttt{define/endefine} commands allow to define complex black box types, i.e. types of black boxes made up of other black boxes.
-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
+ \item The \texttt{define/endefine} commands allow to define complex black box types, i.e. types of black boxes made up of other black boxes.
+Inside a \texttt{define/endefine} block:
+ \begin{itemize}
+ \item the \texttt{author}, \texttt{description} and \texttt{category} 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
of internal boxes they correspond.
-\end{itemize}
+ \end{itemize}
\end{itemize}
\hrule
% ==========================================
% ==========================================
-\subsection{Writing scripts files}
-\label{bbi-writing-scripts}
-% ==========================================
-
-Once you have defined a new type of complex box, you
-may like to reuse it. To do this, you can simply
-write the \bbs commands defining the new box
-into a text file and afterwards include that file anywhere you need.
-Doing this, you start writing \bbs scripts.
-The conventional (and mandatory) extension for such scripts is \texttt{bbs}
-(black box script).
-For consistency reasons, you are requested to prepend \texttt{bb} to the name.
-
-For example, the \texttt{Add3} complex box we previously worked on
-can be defined in the \texttt{bbAdd3.bbs} file:
-
-\begin{file}{bbAdd3.bbs}
-\begin{verbatim}
-# Defines the Add3 black box which adds 3 doubles
-load std
-
-define Add3
- # I am the author
- author "myself"
- description "adds 3 doubles"
- # Pipeline creation
- new Add a
- new Add b
- connect a.Out b.In1
- # Inputs definition
- input x a.In1 "first double to add
- input y a.In2 "second double to add
- input z b.In2 "third double to add"
- # Output definition
- output result b.Out "output"
-endefine
-\end{verbatim}
-\end{file}
-
-Lines starting with a \texttt{\#} character or a \texttt{\//\//} character are ignored, they
-are considered as comments by the interpreter.
-To use this file in \bbStudions, click on the \texttt{include} button, and browse your filestore to find the file.
-
-\begin{verbatim}
-> include bbAdd3.bbs
-> help Add3
-Complex Black Box <user::Add3>
- adds 3 doubles
- By : myself
- * Inputs :
- 'x' <double> [] : first double to add
- 'y' <double> [] : second double to add
- 'z' <double> [] : third double to add
- * Outputs :
- 'result' <double> [] : output
- * Boxes :
- 'a' <std::Add>
- 'b' <std::Add>
-\end{verbatim}
-
-If the file has the \texttt{bbs} extension, you can omit it and just type:
-\begin{verbatim}
-> include bbAdd3
-\end{verbatim}
-provided that \bbStudio knows the path to the desired \texttt{bbs} file.
-See the section \ref{The_configuration_file} to learn about the configuration file and the way to add a new path to it. Note that, if you modify the configuration file, you will have to close \bbStudio and run it again, so that the new configuration be taken into account.
-
-\subsection{Creating complex black boxes that use complex black boxes}
+\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:
\begin{file}{bbAdd4.bbs}
\begin{verbatim}
# Defines the Add4 black box which adds 4 doubles
-include Add3
+include bbAdd3
define Add4
author "myself"
Only the inputs \texttt{x, y, z} of box the \texttt{a} and the input \texttt{In2} of the box \texttt{b} are of interest for the end user, but he/she does not need to care neither about the inner boxes name, nor about the names of their inputs.\\
The author of the complex box has the ability to give these inputs meaningful names (here \texttt{In1, In2, In3, In4}) and to properly document them.
-\subsection{Naming Conventions}
+\subsubsection{Naming Conventions}
\label{bbi-Naming Conventions}
\begin{itemize}
\item
File names :
-For consistency reasons, you are requested to prepend \texttt{bb}, and postpone an extention \texttt{.bbs},
+For consistency reasons, you are requested to prefix \texttt{bb} and place an extension \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
\end{itemize}
-% ==========================================
-\hrule
-\paragraph{Summary}
-%\hrule
-\begin{itemize}
-\item The \texttt{include} command tells the interpreter to include a script file.
-\item Lines starting with a \texttt{\#} or with a \texttt{\//\//} are considered as comments by the interpreter.
-\item Lines between a line starting with a \texttt{\//*} an a line ending with a \texttt{*\//} are considered as comments by the interpreter.
-\end{itemize}
-
-\hrule
% ==========================================
-
-% ==========================================
-\subsection{Creating and using command-line applications}
+\subsubsection{Creating and using command-line applications}
\label{bbi-command-line-app}
% ==========================================
Command-line applications are those that can be executed by typing, in a console, the name of the application and the values of its parameters. The Linux users are very familiar with this way of working, while the Windows users are not, since they are used to execute the applications by clicking on the corresponding icons. Nevertheless, the command-line execution of the applications is feasible (although not very useful) in Windows. You just need to invoke the black ``console'' available either via \texttt{Start > Execute > cmd}, or via \texttt{Start > Programs > Accessories > Invoke commands}. Furthermore, command-line execution of applications is very useful in both environments in such cases as batches.
-So, you already know how to write script files that define complex black boxes
-(with \texttt{define/endefine}), and how to include them in (more) complex black boxes. You can imagine these definitions as though they were a kind of ``functions'' that can be ``called'' by a program (actually, these are rather ``classes'' that can be instanciated, according to the object-oriented programming concepts). The question now is how to write the ``main program'' to be executed directly from the console by typing:
+You already know how to write script files that define stand-alone pipeline applications.
+In fact, these applications \emph{can} be executed directly from the console by typing:
\begin{verbatim}
> bbi <application-name>
\end{verbatim}
Note that this execution mode invokes the interpreter \texttt{bbi} and passes the name of the application to the interpreter.
-Let us think back of the \texttt{workspace} object.
+So, what more do you need to know? A command-line application may need some inputs. In order to define them, you need to use the (already known) command \texttt{input}.
+
+To understand the underlying mechanism let us think back of the \texttt{workspace} object.
Remember that it is also
a \texttt{complex black box}.
Actually, when you write \bbs commands
'y' <double> : second number to add
\end{verbatim}
-This is particularly useful to learn about the usage of the application, namely about the inputs that are to be set at execution. To improve the help provided, use the \texttt{description}
-and \texttt{author} commands in the script file defining the application:
+This is particularly useful to learn about the usage of the application, namely about the inputs that are to be set at execution. To improve the help provided, use the \texttt{description}, \texttt{author} and \texttt{category} commands at the beginning of the script file defining the application:
\\
\\
\begin{file}{add.bbs}
\begin{verbatim}
description "Adds two numbers"
author "foo@bar.com"
+category "example;math"
load std
new Add a
input x a.In1 "first number to add"
\end{verbatim}
\end{file}
-Now if you ask for help on the \texttt{add} script, you get :
+Note that (at least for the moment and contrary to the definition of complex black boxes) you cannot use here multiple \texttt{description}, \texttt{author} and \texttt{author} commands. If the application belongs to several categories, you have to write a single string listing the categories separated by semi-colons, like in the example above. 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
+ Category(s) : example;math;
* Inputs :
'x' <double> : first number to add
'y' <double> : second number to add
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{LayoutSplit} widget is a container which
+For example, the \texttt{LayoutSplit} widget is a container that
``splits'' a window into two parts, either horizontally or vertically,
each part including another widget.
The initial size of the two parts can be fixed by the input 'Proportion'
Move the sliders and close the window.
Now look at the source file to see how this is done:
-\begin{file}{scripts/test/testSplit.bbs}
+\begin{file}{CreaTools/bbtk-0.9.1/bbs/wx/appli/exampleLayoutSplit.bbs}
\begin{verbatim}
load wx
First, the two sliders \texttt{s1} and \texttt{s2} are created.
A \texttt{LayoutSplit} box \texttt{s} is also created.
-The \texttt{connect} commands then ``include'' the sliders in the
+The \texttt{connect} commands then ``insert'' the sliders in the
split widget.
-The input \texttt{Widget} is common to all widget boxes:
-every widget can be inserted into another widget.
-The outputs \texttt{Widget1}, \texttt{Widget2} are specific of \emph{layout}
-widgets
-(in \bbStudio type \texttt{help Slider}:
+The output \texttt{Widget} is common to all widget boxes: in this way
+every widget can be inserted into another widget, provided that the latter has an appropriate input permitting this insertion.
+The inputs \texttt{Widget1}, \texttt{Widget2} of \emph{layout}
+widgets are precisely such special inputs used to ``host'' other widgets.
+In \bbStudio 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}).
+and the output \texttt{Widget}. \\
+\emph{Note that the information about the inputs/outputs of widget boxes in html help is displayed in tables having 3 different color cells. From top to bottom you first find the inputs/outputs specific for the given box, then those that are common for all widget boxes, finally those that are common for all black boxes.}\\
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.
+to the \texttt{Widget}\textit{i} input of a layout widget,
+you order to insert the widget in the layout via its \textit{i}-th special input.
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
+In our case, the slider \texttt{s1} is inserted first,
+then the slider \texttt{s2}. So, \texttt{s1} will be placed
on top of \texttt{s2} (the \texttt{LayoutSplit} box is
-implemented that way, but this is arbitrary choice).
+implemented that way, but this is an arbitrary choice).
Right now, there are only \emph{three} layout widgets in the \texttt{wx} package :
\begin{itemize}
\item {the \texttt{LayoutSplit} widget} we just described
\item {the \texttt{LayoutLine} widget} can have multiple children
-(\texttt{Widget1}, \texttt{Widget2},\dots \texttt{Widget9} inputs) and
+(\texttt{Widget1}, \texttt{Widget2},{\dots} \texttt{Widget9} inputs) and
divides its window into as much parts as children,
each part of equal size.
-The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
+The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
With only those two layout widgets you can already create
complex dialog boxes
(of course layouts can be nested, which leads to tree-like
See the script \texttt{exampleComplexLayoutSplit\_In\_LayoutSplit} for an example.
\item {The \texttt{LayoutTab} widget} arranges its children
-in different pages or 'tabs' (\texttt{wxNotebook}-based).
+in different pages or 'tabs' (based on \texttt{wxNotebook}).
The label of each page is the name of the widget it contains.
\end{itemize}
%the \texttt{Button}... to be continued.
% ==========================================
-\subsection{Deeper in the boxes}
+%\subsection{Deeper into the boxes}
+%\label{bbi-deep-box}
+% ==========================================
+% ==========================================
+\subsection{Default and mandatory inputs and outputs}
\label{bbi-deep-box}
% ==========================================
-\subsubsection{Default and mandatory inputs and outputs}
-\begin{itemize}
-\item Any \texttt{atomic} black box has two default Inputs, which are created by the system :
+%\subsubsection{Default and mandatory inputs and outputs}
+Any {\bf\emph{atomic}} black box has two default inputs and one default output (listed below) that are created by the system. If you create a complex boxes, it is a good idea to also define these two inputs and one output for this new box, in order to be able to use your complex box in the same way as the atomic boxes.
\begin{itemize}
- \item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
- \item {\bf\emph{BoxProcessMode}}: Sets the processing mode of the box :
- \begin{itemize}
- \item {\bf\emph{Pipeline}}:% 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 B.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}
-\item And one default output :
-\begin{itemize}
- \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 : each time the boxes changes (e.g. a Slider is moved) the box it is connected to will be forced to update.
+ \item Inputs:
+ \begin{itemize}
+ \item {\bf\emph{BoxExecute}}: any signal received by this input executes the box.
+ \item {\bf\emph{BoxProcessMode}}: sets the processing mode of the box:
+ \begin{itemize}
+ \item {\bf\emph{Pipeline}}: % bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
+ This is the normal pipeline processing mode, i.e. when an execution of \emph{my\_box} is requested (either by the command '\texttt{exec my\_box}' or because another box dependent on \emph{my\_box}'es output is to be executed), \emph{my\_box} actually executes itself only if at least one of its inputs was changed.
+ \item {\bf\emph{Reactive}}: %bbSetModifiedStatus() calls bbUpdate() \\
+ \emph{my\_box} re-executes itself immediately when \emph{any input} changes.
+ To be more selective, i.e. if you want to re-execute immediately only when one specific input changes, dependent on the change of a particular \emph{other\_box}, better use
+ '\texttt{connect other\_box.BoxChange my\_box.BoxExecute}'.
+ \item {\bf\emph{Always}}: % bbUpdate() always calls Process. \\
+ Useful for 'sources', that must be processed in the pipeline mode despite no input change (e.g.: FileSelector, ColorSelector).
+ This one is not end user intended (for Package developers only).
+ \end{itemize}
+ \end{itemize}
+ \item Output:
+ \begin{itemize}
+ \item {\bf\emph{BoxChange}}: signals any modification of the box. This output may be connected if necessary to the \texttt{BoxExecute}
+ input of another box: each time the box changes (e.g. a Slider is moved) the box it is connected to will be forced to update.
+ \end{itemize}
\end{itemize}
-If you create complex boxes, it is a good idea to define those inputs and outputs to be able
-to force the execution of your complex box or be aware of its changes...
-
-\item Any {\bf 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 :
+Any {\bf\emph{widget}} box has five \emph{inputs}, that will be dealt with only if the box is not connected to the \texttt{Widget} input of any {\bf\emph{layout}} box. If you define a complex widget box, it is a good idea to define these inputs to be able to customize your window settings. It has also one mandatory \emph{output}. If you define a complex widget box, it is a good idea to use the same standard name for your window output.
\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})
+ \item Inputs:
+ \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 signal received by this input closes the window.
+ \item {\bf\emph{WinHide}}: Any signal received by this input hides the window.
+ \item {\bf\emph{WinDialog}}: When set to \texttt{true} or $1$, the widget behaves as a \emph{dialog window} that blocks the pipeline until it is closed (\emph{modal}).
+ \end{itemize}
+ \item Output:
+ \begin{itemize}
+ \item {\bf\emph{Widget}}: Represents the \texttt{wxWindow} itself. If it is not connected to the \texttt{Widget}\emph{i} of any {\bf\emph{layout}} box, then the box will create its own window (frame or dialog) on execution. If it is connected to the \texttt{Widget}\emph{i} of a {\bf\emph{layout}} box, it will be embedded in its parent window.
+ \end{itemize}
\end{itemize}
-If you define a complex widget box, it is a good idea to define these inputs to be able
-to customize your window settings.
+Any {\bf\emph{layout}} box (i.e. \texttt{LayoutLine}, \texttt{LayoutSplit} or \texttt{LayoutTab}) has one or more mandatory inputs {\bf\emph{Widget}}\texttt{i} indexed by their number \emph{i}, e.g.: a \texttt{LayoutSplit} box (widget that splits a window in two resizable parts) has two inputs \texttt{Widget1} and \texttt{Widget2}, used to embed the child windows. If you define a complex layout box, it is a good idea to use these standard names for your
+sub-windows inputs.
-\item Any {\bf 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}, then the box will create its own window (frame or dialog) on execution. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of a \texttt{Layout box},
- it will be embedded in its parent window.
-\end{itemize}
-
-If you define a complex widget box, it is a good idea to use this standard name for your window output
-
-\item Any {\bf 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}
-
-If you define a complex layout box, it is a good idea to use these standard names for your
-sub-windows inputs.
-
-\end{itemize}
% ==========================================
% ==========================================
-%\vspace{0.5cm}
+\vspace{0.5cm}
\hrule
\newpage
-\section{Using third party Package}
+\section{Using third party Packages}
\label{Third_Party_Package}
% ==========================================
% ==========================================
\subsubsection{Linux users}
\label{Installing_a_Package_for_Linux_users}
-After compiling a Package, at install time, think of using :
+After compiling a Package, at install time, use:
\begin {verbatim}
su -
make install
\end{verbatim}
-and neither :
+and neither:
\begin {verbatim}
su
make install
\end{verbatim}
-nor :
+nor:
\begin {verbatim}
sudo make install
\end{verbatim}
otherwise package documentation will not be generated. \\
-Think of updating your environment variable LD\_LIBRARY\_PATH (in .bashrc in
-you're using bash), to add the path to the shared library
-libbb\emph{YourNewPackageName}.so
+Then update your environment variable LD\_LIBRARY\_PATH (in .bashrc if
+you are using bash), to add the path to the shared library
+\texttt{libbb\emph{YourNewPackageName}.so}
% ==========================================
\label{Installing_a_Package_for_Windows_users}
% ==========================================
Think of updating your environment variable LD\_LIBRARY\_PATH to add the path to the dynamic library
-bb\emph{YourNewPackageName}.dll
+\texttt{bb\emph{YourNewPackageName}.dll}
% ==========================================
\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
+\bbStudio makes it easy for you: in the menu \texttt{Tools} just click on the
option \texttt{Plug Package}. You will be asked to '\texttt{Select
-package directory}'. Browse untill you find the install or the build directory,
-depending whether you installed the package or not.
+package directory}'. Browse until you find the install or the build directory,
+depending on whether you installed the package or not.
\bbStudio will update the configuration file, generate the 'Package
documentation', and update the 'Boxes Lists'.
\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).
+You may add your own boxes (simple boxes, if you are aware enough of \CPP
+language, or complex boxes if you are aware enough in \bbtk scripting).
To update the html help of this package,
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.
+Avoid using the \texttt{-a} option (Regenerate all), since it's time consuming.
To update html boxes lists with the new boxes,
use the option \texttt{Regenerate Boxes Lists}
%\newpage
% ==========================================
-%\vspace{0.5cm}
+\vspace{0.5cm}
\hrule
\newpage
\section{Using black boxes in \CPP programs}
black box within a \CPP program
without worrying about writing a \wx main application.\\
-Let's look a the following bbs script :
+Let us have a look at the following \bbs script:
\begin{verbatim}
# Load the packages
and display the slider value in the output text.
Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.
-The following \CPP code does the same :
+The following \CPP code does the same:
\begin{verbatim}
#include <bbtkFactory.h>
{
try
{
- // we need to intanciate a bbtk::Factory to be aware of the adaptors
+ /* we need to instanciate a bbtk::Factory
+ to be aware of the adaptors*/
+
bbtk::Factory::Pointer factory = bbtk::Factory::New();
// Load the packages
// 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");
+ 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 c1 =
+ bbtk::Connection::New(slider,"Widget",layout,"Widget1");
- bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
- layout,"Widget2");
+ 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");
+ // 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!
e.Print();
}
}
+\end{verbatim}
In this code, we use the headers of the \texttt{bbwx} \CPP library,
which define the black boxes of the \texttt{wx} package.
+\vspace{0.5cm}
to be continued ...
-\end{verbatim}
% ==========================================
+\vspace{0.5cm}
\hrule
\newpage
\section{\bbs language reference}
Sets the input \texttt{input} of
the box named \texttt{box} to the value \texttt{value}.
An \texttt{adaptor} must exist
-in the packages loaded which converts a \texttt{std::string}
+in the packages loaded, which converts a \texttt{std::string}
to the type of the input \texttt{input}. \\ \hline
\texttt{exec} & \texttt{<box-name>} &
\label{bbi-reference-package}
\begin{table}[!ht]
-\caption{\label{tabbbi-reference-interpreter_1}\bbs package related commands. }% (part 1).}
+\caption{\label{tabbbi-reference-package_1}\bbs package related commands. }% (part 1).}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
%See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
% ==========================================
\begin{table}[!ht]
-\caption{\label{tabbbi-reference-interpreter_1}\bbs intepreter related commands. }% (part 1).}
+\caption{\label{tabbbi-reference-interpreter_1}\bbs interpreter related commands. }% (part 1).}
\small
-\begin{tabular}{|lcm{6cm}|}
+\begin{tabular}{|lcm{7cm}|}
\hline
Command & Parameters & Effect \\ \hline
\texttt{box-type}.
The box type must belong to a package which has been previously loaded \\ \hline
+& \texttt{<box-name>} &
+Prints help on the existing box instance named
+\texttt{box-name} (i.e. created by \texttt{new} command), including the state of its inputs/outputs \\ \hline
+
\texttt{message}
& - &
Prints information on available kinds of messages and their current level\\ \hline
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}.
An \texttt{adaptor} must exist
-in the packages loaded which converts
+in the packages loaded, which converts
the type of the output \texttt{output}
to a \texttt{std::string}.
\\ \hline
\texttt{define} & \texttt{<box-type>} [\texttt{<package-name>}] &
Starts the definition of a complex black box of type
-\texttt{box-type}. If \texttt{<package-name>} is provided then includes the
-box in the given package (otherwise it is defined in the current package,
-i.e. \texttt{user} if outside a \texttt{package/endpackage} block). \\ \hline
+\texttt{box-type}, and includes it either in the given package (if \texttt{<package-name>} is provided) or in the current package,
+i.e. \texttt{user} if outside a \texttt{package/endpackage} block. \\ \hline
\texttt{endefine} & - &
Ends the definition of a complex black box type\\ \hline
\texttt{author} & \texttt{<string>} &
-Concatenate the string to the author string
+Concatenates the string to the author string
of the current complex black box.\\ \hline
\texttt{description} & \texttt{<string>} &
-Concatenate the string to the description of the current complex black box.
+Concatenates the string to the description of the current complex black box.
\\ \hline
\texttt{category} & \texttt{<string>} &
The categories must be separated by semicolons, e.g. "\texttt{widget;image}"\\ \hline
\texttt{kind} & \texttt{<box kind>} &
-Specifies the \texttt{kind} of the current complex black box
-( ADAPTOR, DEFAULT\_ADAPTOR, WIDGET\_ADAPTOR, DEFAULT\_WIDGET\_ADAPTOR )\\ \hline
+The following \texttt{kind}s are defined:
+
+DEFAULT\_ADAPTOR,
+ADAPTOR, DEFAULT\_WIDGET\_ADAPTOR, WIDGET\_ADAPTOR\\ \hline
\texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} &
Defines a new input for the current complex black box,
obtained in \bbStudio by clicking on the
\texttt{Config} button of the \texttt{Command} part toolbar.
-If you did not installed other packages than the ones
+If you did not install other packages than the ones
provided by \bbtk, you get something like :
\begin{verbatim}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff