have been written by different persons, using different libraries, etc.
\end{itemize}
+
+% ==========================================
+\hrule
+\paragraph{Summary}
+%\hrule
+A \texttt{black box}:
+\begin{itemize}
+ \item has a name (this is actually a type name),
+ \item has a description and an author,
+ \item belongs to categories (keywords that allow to index it
+into automated documentation, and that are specified in the box definition),
+ \item has inputs and outputs that in turn have their:
+ \begin{itemize}
+ \item names,
+ \item types (any C++ type),
+ \item descriptions,
+ \end{itemize}
+ \item does something and can be executed, i.e. outputs are updated according to inputs.
+\end{itemize}
+A \texttt{package}:
+\begin{itemize}
+ \item is a ``plug-in'' in the \bbtk framework,
+ \item has a name
+ \item has a description and an author.
+ \item contains:
+ \begin{itemize}
+ \item a dynamic library (dll/so/dylib) that contains compiled
+black boxes (e.g.: dynamic library name of the package `std' is `bbstd.dll', `libbbstd.so' or `libbbstd.dylib' depending on the platform),
+ \item bbs scripts: script-defined boxes, examples, applications,
+ \item data: test data, resources.
+ \end{itemize}
+ \item is automatically documented.
+\end{itemize}
+\hrule
+% ==========================================
+
% ==========================================
-\subsubsection{\bbtk components}
+\subsubsection{{\bbtk} components}
% ==========================================
\BBTK includes:
\begin{itemize}
\item {\bf\emph{wxvtk}}: widget boxes based on the \vtk library (2D and 3D visualization and
interaction).
%\item {\bf\emph{creaImageIO}}: Provides hight level widgets to read images, including DICOM.
- \item {\bf\emph{toolsbbtk}}: Tools for bbtk administration and package development.
+ \item {\bf\emph{itkvtk}}: adaptors permitting to connect \itk boxes to \vtk boxes and conversely.
+ \item {\bf\emph{kw}}: widgets based on \texttt{KWWidgets} library (medical-image oriented:
+slicer, transfer function editors, etc.).
+ \item {\bf\emph{demo}}: some black-box based demos.
+ \item {\bf\emph{appli}}: some black-box based standalone applications.
+ \item {\bf\emph{toolsbbtk}}: tools for bbtk administration and package development.
\end{itemize}
\item A {\bf\emph{development environment}}, called \bbStudio, which provides:
\begin{itemize}
\end{itemize}
\end{itemize}
\item A standalone {\bf\emph{interpreter}}, called \bbins, which allows to
- execute \bbs scripts or commands.
+ execute \bbs scripts.
\item {\bf\emph{Various development utilities}}:
\begin{itemize}
\item \bbfy generates the \CPP code of a black box from a
% ==========================================
Read this \texttt{Users' Guide} if you want to learn how to use
-\bbtk development environnement (\bbStudions) and how to write black box scripts.\\
+\bbtk development environnement \bbStudio and how to write black box scripts.\\
If your aim is to write your own Packages and Black Boxes, you have to read the
\texttt{Package Developper's Guide}.
If you load a file holding a script, it will be displayed in this area, and you will be
able to modify it, to save it, to save-as it and to run it, using the respective
-lower-toolbar buttons (see figure \ref{lowertoolbar})
+lower-toolbar buttons (see figure \ref{lowertoolbar}).
\begin{figure}[!ht]
\caption{The 'Files' lower toolbar}
one single line area (\texttt{Command}), at the bottom, in which you can enter your commands, and
a multiple line zone (\texttt{Messages}) 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.
-Command-line help for the black box scripting language \bbsns (see \ref{Scripting}) can be obtained in this zone. \par
+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}
\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}
% ==========================================
-\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}
-(this will be explained in details in sections
-\ref{bbi-writing-scripts} and
-\ref{bbi-command-line-app}).
+(see also section \ref{bbi-command-line-app}).
If you type \texttt{'help workspace'}, you get:
\begin{verbatim}
\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}
> help Add
\end{verbatim}
-{\bbStudions} displays the appropriate html page in the 'Help' part (see figure : \ref{HelpAdd}), and the following text in the 'Message' part:
+\bbStudio displays the appropriate html page in the 'Help' part (see figure : \ref{HelpAdd}), and the following text in the 'Message' part:
\begin{verbatim}
Black Box <std::Add>
Adds its inputs
the author(s) of the box (usually e-mail address(es)) and
the categories to which the box belongs,
the lists of inputs and outputs of the box.
-For each input or output, \bbi provides
-its \emph{name} ,
+For each input or output, the help 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
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
a \texttt{C} code declares a variable of type \texttt{int}, the
name of which is \texttt{i}.
Of course, like in \texttt{C} Language, you can declare multiple boxes of the
-same type in \bbi.
+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
'a' <std::Add>
\end{verbatim}
-This means that \bbi workspace now contains a black box named \texttt{a},
+This means that the user's workspace now contains a black box named \texttt{a},
of type \texttt{std::Add}. If you type:
\begin{verbatim}
> help 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
\label{bbi-fig-connecting-black-boxes-1}
\end{figure}
-The \bbi instructions to create and execute this pipeline are :
+The \bbs instructions to create and execute this pipeline are :
\begin{verbatim}
> new Add a
> new Add b
> 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 \texttt{a} and \texttt{b} black boxes' inputs and the last one
prints the output of the black box \texttt{b}. The pipeline is executed before printing, because the interpreter 'knows' that the box \texttt{b}, the output of which is requested, is not up to date.
> include wx
> include itk
> include wxvtk
+> include itkvtk
> 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
Package std v1.0.0 - laurent.guigues@creatis.insa-lyon.fr
Basic useful black boxes
Black boxes :
- ...
+ ASCII : ascii codes sequence to string - ...
+ Add : Adds its inputs
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...
+ CastBoolToChar [DA] : Static cast from Bool (bool) to ...
+ CastBoolToDouble [DA] : Static cast from Bool (bool) to ...
...
- CastBoolToUChar [DA] : Static cast from Bool (bool) to UChar (unsigne...
- CastBoolToUInt [DA] : Static cast from Bool (bool) to UInt (unsigned...
+ CastBoolToUChar [DA] : Static cast from Bool (bool) to ...
+ CastBoolToUInt [DA] : Static cast from Bool (bool) to ...
...
- 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...
+ CastUIntToBool [DA] : Static cast from UInt (unsigned ...
+ CastUIntToChar [DA] : Static cast from UInt (unsigned ...
+ CastUIntToDouble [DA] : Static cast from UInt (unsigned ...
...
\end{verbatim}
-\texttt{[DA]} stands for \emph{default adaptor}.
+In this long list you find many items marked \texttt{[DA]}, which 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}.
it looks for an adequate \emph{adaptor} in the loaded packages.
In our case, as the package \texttt{std} provides the
\texttt{CastUCharToDouble} adaptor, the interpreter automatically creates an
-instance of this adaptor and place it \emph{between}
+instance of this adaptor and places it \emph{between}
the output and the input you want to connect
(however this adaptor is hidden to you,
it is embedded into the created connection and does not appear
would simply cast the value of the \texttt{char} into a \texttt{double},
however arbitrarily complex type conversion may be done.\\
\texttt{WARNING}: these adaptors are \texttt{C++ static cast}, i.e., there is, right now,
- no 'intelligent' conversion (only truncation) e.g. think to \texttt{CastDoubleToUChar}!
+ no 'intelligent' conversion (only truncation) e.g. think of \texttt{CastDoubleToUChar}!
%\begin{verbatim}
%Question (for info-dev):
\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}.
-including adaptors
+\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
% ==========================================
% ==========================================
-\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}
% ==========================================
-Remember the pipeline of figure
+Remind the pipeline of figure
\ref{bbi-fig-connecting-black-boxes-1}, which
computed the sum of three doubles.
You can consider it as a whole and define
\end{center}
\end{figure}
-The \bbi 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
-\end{verbatim}
-
-Explanations :
+# bbAdd3.bbs: defines the Add3 black box which adds 3 doubles
-As we will use \texttt{Add} boxes, we need to load the package \texttt{std}, which is done in first line.
+author "myself"
+description "adds 3 doubles"
-The command \texttt{define} then starts the definition
-of the complex box type, which will be called \texttt{Add3}.
-
-The next three lines define the pipeline,
-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 :
+load std
+define Add3
+ # 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}
-\texttt{author} and \texttt{description} are used for the documentation
-of the new box. You can provide multiple \texttt{author} or
+Explanations:
+\begin{itemize}
+ \item As we will use \texttt{Add} boxes, we need to load the package \texttt{std}, which is done in the first line.
+ \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 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. They have to be placed at the very beginning of the script file. 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.
-
-\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
+ \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
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}
The figure \ref{bbi-fig-complex-black-box-1}
illustrates the external to internal
input/output correspondence.
-
-Finally, the \texttt{endefine} command ends the definition of the
+ \end{itemize}
+ \item Finally, the \texttt{endefine} command ends the definition of the
new box type.
+\end{itemize}
+
+If you type the command \texttt{include bbAdd3} and then you ask for help
+on the contents of the \texttt{user} package, you get:
-After this definition, if you ask for help
-on packages, 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
-\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
+ 'x' <double> [] : first double to add
+ 'y' <double> [] : second double to add
+ 'z' <double> [] : third double to add
* Outputs :
- 'result' <double> : output
+ '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:
\begin{verbatim}
> new Add3 a
6
\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'
-.
+\texttt{In1}, \texttt{In2} and \texttt{In3} the inputs of the black box \texttt{Add3}. Indeed,
+by convention all the 'natural entries' of a box are named \texttt{In}, or \texttt{In}\emph{x} if there is 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.
+ \item The \texttt{author} and \texttt{description} commands, placed at the very beginning of a script file, allow to document the new type of box.
+ \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
+ \begin{itemize}
+ \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 in \bbins.
-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>
->
-and so on ...
-\end{verbatim}
-
-If the file has the \texttt{bbs} extension, you can ommit it and just type :
-\begin{verbatim}
-> include Add3
-\end{verbatim}
-
-\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 :
+like in the following example:
\begin{file}{bbAdd4.bbs}
\begin{verbatim}
# Defines the Add4 black box which adds 4 doubles
-include Add3
+author "myself"
+description "adds 4 doubles"
+include bbAdd3
define Add4
- author "myself"
- description "adds 4 doubles"
new Add3 a
new Add b
- connect a.Out b.In1
- input In1 a.In1 "first double to add
- input In2 a.In2 "second double to add
- input In3 a.In3 "third double to add"
+ connect a.result b.In1
+ input In1 a.x "first double to add
+ input In2 a.y "second double to add
+ input In3 a.z "third double to add"
input In4 b.In2 "fourth double to add"
output Out b.Out "output"
endefine
\end{verbatim}
\end{file}
+Here we kept the \texttt{bbAdd3.bbs} file unchanged, so the inner box of type \texttt{Add3} \texttt{a} has the entries \texttt{x, y, z}, while the entries of the inner box \texttt{b} of type \texttt{Add} are \texttt{In1, In2}.\\
+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.
-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 does not 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 meaningful name !
-\begin{verbatim}
- input In3 a.In3 "third double to add"
- input In4 b.In2 "fourth double to add"
-\end{verbatim}
-
-
-\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 command line applications}
+\subsubsection{Creating and using command-line applications}
\label{bbi-command-line-app}
% ==========================================
-Now that you know how to create complex black boxes
-(with \texttt{define/endefine}), think
-back to the \texttt{workspace} object.
+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.
+
+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.
+
+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 type interpreter commands
-outside a \texttt{define/endefine} block,
+Actually, when you write \bbs commands
+outside of a \texttt{define/}\texttt{endefine} block,
you progressively define the \texttt{workspace}
complex black box.
-You can think of it like if at start the interpreter
+You can think of it as though at start the interpreter
was issuing a command \texttt{'define workspace'}
and then letting you define the interior of the box
\texttt{workspace}.
-Remember that the command \texttt{inputs}
+Remember that the command \texttt{input}
allows to define an input of a complex box.
Now, if you use the command \texttt{input}
outside a \texttt{define/endefine} block then
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 :
+you can pass these two arguments in the command-line,
+like this:
\begin{verbatim}
> bbi add x=1 y=1
x+y=2
\end{verbatim}
-You can also invoke \bbi the option \texttt{-h},
-which gives help on the \texttt{workspace} box :
+You can also note that, in the command-line context, you can invoke \bbi with the option \texttt{-h},
+which gives help on the \texttt{workspace} box:
\begin{verbatim}
> bbi add -h
'y' <double> : second number to add
\end{verbatim}
-To get a better help, use the \texttt{description}
-and \texttt{author} commands :
-
+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:
+\\
+\\
\begin{file}{add.bbs}
\begin{verbatim}
description "Adds two numbers"
Note that for both \texttt{-t} and \texttt{-g} options,
the input from the user is a \texttt{string} and
\bbi converts it to the right input type using
-an \texttt{adaptor}, hence the right adaptors must be loaded.
+an \texttt{adaptor}, hence the right adaptors must be previously loaded.
% ==========================================
\hrule
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 \bbStudio :
\begin{verbatim}
-> load wx
-> new InputText t
-> print $t.Out$\n
+> include wx
+> new DirectorySelector d
+> print $d.Out$
\end{verbatim}
-When you type \texttt{enter} after the last line,
-a window pops up in which you can entrer a text.
-When you close the window, the text you entered is printed by
+When you hit the \texttt{enter} key after the last line,
+the usual directory-selection window pops up.
+When you validate your selection, the directory name you selected, preceded by the corresponding path, is printed by
the \texttt{print} command.
+Note that you can determine a default directory by setting the appropriate input as follows:
+\begin{verbatim}
+> set d.DefaultDir <directory-name>
+\end{verbatim}
-Type \texttt{help wx}, you get something like :
+Now, type \texttt{help wx}, you get something like:
\begin{verbatim}
Package wx v1.0.0- info-dev@creatis.insa-lyon.fr
- Basic graphical interface elements (sliders, buttons ...) based on wxWidgets
+ Basic graphical interface elements (sliders, buttons ...) based ...
Black boxes :
- ColourSelector : Colour Selector dialog (bbfication of wxColourSele...
- ColourSelectorButton : A button which displays a colour picker dialog whe...
+ ColourSelector : Colour Selector dialog (bbfication of ...
+ ColourSelectorButton : A button which displays a colour picke...
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...
+ DirectorySelector : Pops up a directory selection dialog (...
+ FileSelector : Pops up a file selection dialog for re...
+ InputText : A zone in which the user can enter a t...
LayoutLine : LayoutLine widget (wxBoxSizer)
- LayoutSplit : Widget which splits a window in two fixed size par...
+ LayoutSplit : Widget which splits a window in two fi...
LayoutTab : LayoutTab widget (wxNotebook)
- OutputText : Text zone to be inserted into a window (wxStaticTe...
+ OutputText : Text zone to be inserted into a window...
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{InputText}..
+You can reproduce the same experiment as above using for example
+a \texttt{FileDialog} rather than a \texttt{DirectorySelector}.
+
+If you choose to reproduce the experiment with:\\
+\texttt{> new InputText t} (or \texttt{new Slider s}),
+
+you will have to precede the command:\\
+\texttt{> print \$t.Out\$} (or \texttt{print \$s.Out\$})
+
+by the following command:\\
+\texttt{> set t.WinDialog true} (or \texttt{set s.WinDialog true} respectively).
+This blocks the pipeline until the widget is closed. Also note that the corresponding widgets do not have a validation button. Therefore, you will have to close them by clicking in the appropriate corner.
%There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
%The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
and be adjusted by the user thanks to a ``handle''.
The example \texttt{exampleLayoutSplit} demonstrates its use.
-Run it : it displays a window with two sliders.
+Run it: it displays a window with two sliders.
Move the sliders and close the window.
-Now look at the source 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}
First, the two sliders \texttt{s1} and \texttt{s2} are created.
A \texttt{LayoutSplit} box \texttt{s} is also created.
-The \texttt{connect} commands then ``includes'' the sliders in the
+The \texttt{connect} commands then ``include'' the sliders in the
split widget.
-The input \texttt{Widget} is common to all widget boxes :
+The input \texttt{Widget} is common to all widget boxes:
every widget can be inserted into another widget.
-The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{layout}
+The outputs \texttt{Widget1}, \texttt{Widget2} are specific of \emph{layout}
widgets
-(in \bbi type \texttt{help Slider}:
+(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}
\texttt{-C} checks the factory integrity.
\texttt{-D} turns on objects debug info after main ends\\ \hline
-\texttt{quit} & - & Exits the interpreter\\ \hline
+\texttt{quit} & - & Stops the interpretation of the current script\\ \hline
\end{tabular}
\end{table}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff