\newpage
\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}
% ==========================================
-\subsection{What is bbtk ?}
+\subsection{What is bbtk?}
% ==========================================
-\BBTK(\bbtkns) is a set of tools
-(\CPP libraries and executables)
-providing a \CPP framework for the definition
-of elementary processing \emph{units}, called {\bf black boxes},
-and the definition and execution of processing \emph{chains}
+\BBTK(\bbtkns) is a set of tools (\CPP libraries and executables)
+providing a \CPP framework for the definition of elementary processing \emph{units}, called {\bf black boxes}, and the definition and execution of processing \emph{chains}
made up of these black boxes. \\
%It's a part of the \texttt{Creatools suite} composed mainly of :
\emph{``any component in a system in which only the input and output
characteristics are of interest, without regard to its internal mechanism
or structure''}. \\
-We should merge these definitions. :
+We should merge these definitions:
not only the inputs and outputs are of interest but also
-\emph{what the box does} !
+\emph{what the box does!}
Hence, we would say that a black box is any \emph{\bf documented}
component of a system, letting the user know
\emph{\bf what} the box is supposed to do and
We let you think about this\dots)
Of course, symbolic data attached to a box may be
-{\bf queried} : what are the inputs/outputs of the box ?
-what are their type ? their description ? etc.
+{\bf queried}: what are the inputs/outputs of the box?
+what are their type? their description? etc.
This allows {\bf automatic documentation} of boxes.
The abstract definition of black boxes is the most basic
aspect of \BBTK architecture.
-Another key aspect is the groupement of black boxes into
+Another key aspect is the grouping of black boxes into
so called {\bf packages},
-which are \emph{dynamic libraries} which can also
+which are \emph{dynamic libraries} that can also
be queried, in particular about the boxes they provide.
-The package structure then offers a mechanism which
-is like a \emph{'plug-in'} mechanism.
+The package structure then offers a mechanism similar to \emph{'plug-in'} mechanism.
\BBTK provides the methods to load a package at run-time,
and create instances of the boxes it contains.
These two mechanisms (black boxes and packages)
-then gives the way to:
+then give the way to:
\begin{itemize}
\item The definition of an {\bf interpreted script language},
which allows to manipulate packages and boxes very easily in symbolic way.
-\BBTK provides one : \bbs (the Black Box Script language) and its interpreter
+\BBTK provides one: \bbs (the Black Box Script language) and its interpreter
\bbi (the Black Box Interpreter).
\item {\bf Automatic documentation} of existing packages.
\texttt{html} documentation of packages is proposed by
\bbStudions.
\end{itemize}
-Finally, these different components allow {\bf efficient} :
+Finally, these different components allow {\bf efficient}:
\begin{itemize}
\item {\bf capitalization and reuse} of existing processing units,
including {\bf documentation}
\item {\bf testing, prototyping} in a very simple script language
-\item {\bf inter-operability} between atomic processings which
+\item {\bf inter-operability} between atomic processings that
have been written by different persons, using different libraries, etc.
\end{itemize}
% ==========================================
\subsubsection{\bbtk components}
% ==========================================
-\BBTK includes :
+\BBTK includes:
\begin{itemize}
\item A \CPP {\bf\emph{library}} - called \bbtk - which defines a framework
(abstract classes) to develop black boxes and store them into
dynamic libraries, called black box \emph{packages}.
- \item Different {\bf\emph{"core" black box packages}} :
+ \item Different {\bf\emph{"core" black box packages}}:
\begin{itemize}
- \item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
- \item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).
- \item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
- \item {\bf\emph{vtk}} : the basic images and surfaces processing and visualization package, based on the \vtk library.
- \item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
+ \item {\bf\emph{std}}: the 'standard' package including basic useful boxes.
+ \item {\bf\emph{wx}}: basic graphical interface elements (widgets: sliders, buttons, etc. based on the \texttt{wxWidgets} library).
+ \item {\bf\emph{itk}}: the basic image processing package, based on the \itk library.
+ \item {\bf\emph{vtk}}: the basic images and surfaces processing and visualization package, based on the \vtk library.
+ \item {\bf\emph{wxvtk}}: widget boxes based on the \vtk library (2D and 3D 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{creaImageIO}}: Provides hight level widgets to read images, including DICOM.
+ \item {\bf\emph{toolsbbtk}}: Tools for bbtk administration and package development.
\end{itemize}
- \item A {\bf\emph{Developement environment}}, called \bbStudio, which provides
+ \item A {\bf\emph{development environment}}, called \bbStudio, which provides:
\begin{itemize}
- \item An online {\bf\emph{script editor and interpretor}}
- \item A powerful html {\bf\emph{Help environment}}, integrating :
+ \item An online {\bf\emph{script editor and interpreter}}
+ \item A powerful html {\bf\emph{help environment}}, integrating:
\begin{itemize}
- \item Online documentation scaning
- \item Retreiving boxes on various criterions
- \item Checking Demo and examples
+ \item Online documentation scanning
+ \item Retrieving boxes on various criteria
+ \item Checking demos and examples
\end{itemize}
\end{itemize}
- \item An standalone {\bf\emph{interpreter}}, called \bbins, which allows to
+ \item A standalone {\bf\emph{interpreter}}, called \bbins, which allows to
execute \bbs scripts or commands.
- \item {\bf\emph{Various Development Utilities}} :
+ \item {\bf\emph{Various development utilities}}:
\begin{itemize}
\item \bbfy generates the \CPP code of a black box from a
description file written in \texttt{xml}.
%\item \bbdoc generates the html documentation of a black box package
%(author, description, description of its black boxes :
%author, description, inputs, outputs, and so on).
- \item \bbCreatePackage allows to create the basic file architecture.
+ \item \bbCreatePackage allows to create the basic file architecture
to start the development of a new black box package.
- \item \bbCreateBlackBox allows to create the basic file architecture.
+ \item \bbCreateBlackBox allows to create the basic file architecture
to start the development of a new black box, that will be included in an already existing package.
- \item \bbs2cpp translates a \texttt{.bbs} script into a \CPP file.
- \item \bbc (sorry : Linux Only, for the moment) that compiles \texttt{.bbs} scripts into executables.
+ \item \texttt{bbs2cpp} translates a \texttt{.bbs} script into a \CPP file.
+ \item \bbc (sorry: Linux only, for the moment) that compiles \texttt{.bbs} scripts into executables.
\item \bbRegeneratePackageDoc which creates the html documentation of the Package.
\item \bbRegenerateBoxesLists which creates the html pages of the various lists of all the currenly installed boxes.
\item \bbPlugPackage which automatically incorporates a new package.
\end{itemize}
- \item A full {\bf\emph{documentation}} printable (pdf), browsable (html),
- queryable throught keywords.
+ \item A full {\bf\emph{documentation}} that can be printed (pdf), browsed (html) and
+ queried through keywords.
\end{itemize}
The general architecture of \BBTK
is shown in figure \ref{bb-architecture}.
\begin{figure}[!ht]
-\caption{\label{bb-architecture}\BBTK architecture}
+\caption{\BBTK architecture}
\begin{center}
\includegraphics[width=0.6\textwidth]{bb-architecture.png}
\end{center}
+\label{bb-architecture}
\end{figure}
%%\newpage
Read this \texttt{Users' Guide} if you want to learn how to use
\bbtk development environnement (\bbStudions) and how to write black box scripts.\\
-If you aim is to write your own Packages and Black Boxes, you have to read the
+If your aim is to write your own Packages and Black Boxes, you have to read the
\texttt{Package Developper's Guide}.
% ==========================================
Just run it, typing in a console \bbStudio
or clicking on its icon or its menu entry.
You'll get something like in figure
-\ref{bbi-fig-bbStudio-gui-start}
+\ref{bbi-fig-bbStudio-gui}
(the exact appearance of \bbStudio is Operating System and \bbtk version dependent).
-At start, \bbStudio opens with a very minimal 'How to use' in the middle.
-Don't forget to read it : it will vanish at the first mouse click.
+%At start, \bbStudio opens with a very minimal 'How to use' in the middle.
+%Don't forget to read it: it will vanish at the first mouse click.
-\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbStudio-gui-start}The bbStudio Development environment interface at start time}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png}
-\end{center}
-\end{figure}
-
-%Let's have a look at the resized window :
%\begin{figure}[!ht]
-%\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface}
+%\caption{The bbStudio Development environment interface at start time}
%\begin{center}
-%\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+%\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png}
%\end{center}
+%\label{bbi-fig-bbStudio-gui-start}
%\end{figure}
-The interface is divided into four parts : \texttt{Files}, \texttt{Messages},
+%Let's have a look at the resized window :
+\begin{figure}[!ht]
+\caption{The bbStudio Development environment interface}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+\end{center}
+\label{bbi-fig-bbStudio-gui}
+\end{figure}
+
+The interface is divided into four parts: \texttt{Files}, \texttt{Messages},
\texttt{Command}, \texttt{Help}.
It is written using the Advanced User Interface library of wxWidgets
(a.k.a. AUI),
\subsubsection{'Files' part}
\label{bbi-FilesPart}
-It's the \bbs script editor.
+It is the \bbs script editor (see section \ref{Scripting} to learn about scripting).
-If you load a file holding a script, it will be displayed here, and you'll be
-able to modify it, to save it, to save-as it, to run it, using the
-lower toolbar (see figure \ref{lowertoolbar})
+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})
\begin{figure}[!ht]
-\caption{\label{lowertoolbar}The 'Files' lower tool bar}
+\caption{The 'Files' lower toolbar}
\begin{center}
\includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
\end{center}
+\label{lowertoolbar}
\end{figure}
% \begin{itemize}
-% \item {\bf\emph{New file}} : Create a new file to hold a script
-% \item {\bf\emph{Open file}} : Open an already existing file holding a script
-% \item {\bf\emph{Close file}} : Close a file holding a script
-% \item {\bf\emph{Save file}} : Save he current file (if modified)
-% \item {\bf\emph{Save file as}} : Save he current file under a different name
-% \item {\bf\emph{Run file}} : Execute the script you just loaded/modified/written
-% \item {\bf\emph{cursor position}} : column number : line number
+% \item {\bf\emph{New file}}: Create a new file to hold a script
+% \item {\bf\emph{Open file}}: Open an already existing file holding a script
+% \item {\bf\emph{Close file}}: Close a file holding a script
+% \item {\bf\emph{Save file}}: Save he current file (if modified)
+% \item {\bf\emph{Save file as}}: Save he current file under a different name
+% \item {\bf\emph{Run file}}: Execute the script you just loaded/modified/written
+% \item {\bf\emph{cursor position}}: column number : line number
% \end{itemize}
\label{bbi-MessagesPart}
Two kinds of messages will be output here:\\
-System messages : produced by the kernel, in case of a user mistyping, or an execution error\\
-Script messages : produced by the \bbtk equivalent of \texttt{printf}
+\begin{itemize}
+\item {\bf\emph{System messages:}} produced by the kernel, in case of a user mistyping, or an execution error.\\
+\item {\bf\emph{Script messages:}} produced by the \bbtk equivalent of \texttt{printf}
or \texttt{std::cout} in user programs.
+\end{itemize}
+
\subsubsection{'Command' part}
\label{bbi-CommandPart}
You can type here \bbs commands which are executed on the fly.
-The buttons are shortcuts to usual commands.
+The buttons are shortcuts to the most frequently used commands.
+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} provides the help on the selected command.
\subsubsection{'Help' part}
\label{bbi-HelpContentsPart}
-The 'Help' part of \bbStudio is used to browse the html help of \BBTKns.
+The 'Help' part of \bbStudio is used to browse the html help of \BBTKns. You can find there various guides (see section~\ref{sec:guides}) and detailed information about each black box available (see section~\ref{sec:boxes_help}). They can be browsed alphabetically, by package and by category. Two special categories, demos and examples, are available via direct links (see section~\ref{sec:demos_examples}).
% ==========================================
+% ==============================================
+\subsection{Online Help}
+% ==============================================
+
+Various levels of help are supplied by \bbStudions.
+
+% ==========================================
+\subsubsection{Command-line help}
+% ==========================================
+
+
+The 'working' area (the left one, as opposed to the (\texttt{Help}) area, on the right side) is composed of:
+one single line area (\texttt{Command}), at the bottom, in which you can enter your commands, and
+a multiple line zone (\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
+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}.
+
+% ==========================================
+\subsubsection{Guides}
+\label{sec: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}
+
+ \begin{itemize}
+ \item {\bf\emph{User's Guide}}: This guide!
+ \item {\bf\emph{Package Developer's Guide}}: Step-by-step "How-to" for programmers who want to create their own
+ black boxes/packages.
+ % \item {\bf\emph{Developper's Guide}}: For bbtk kernel developpers only. (This one is probably not very much
+ % up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
+ % \item {\bf\emph{Reference Manual}}: Contains a exaustive description of all the features for all the commands.
+ %\item {\bf\emph{Booklet}}: Vade mecum.
+ \item {\bf\emph{Doxygen Documentation}}: Doxygen source browser.\\ Automatically generated from source files. Should only concern the kernel developers.
+ \end{itemize}
+
+
+
+
+% ==========================================
+\subsubsection{Boxes Help}
+\label{sec:boxes_help}
+% ==========================================
+ Lists of currently available boxes from installed packages, sorted according to the following criteria:
+ \begin{itemize}
+ \item {\bf\emph{Alphabetical list}}%: This is the 'zero-level' of retrieving.
+ \item {\bf\emph{List by package}}%: The boxes are indexed by package they belong to
+ \item {\bf\emph{List by category}}:
+ Each box is indexed by a list of keywords, called 'categories', such as '\texttt{read/write}',
+ '\texttt{filter}', '\texttt{viewer}', ...
+ A given box may belong to more than one \texttt{category}, however some categories are mutually exclusive.
+ Standard categories are:
+ \begin {itemize}
+ \item\texttt{atomic box}/\texttt{complex box}\\
+ Any box is either atomic or complex.\\
+ The former are 'atomic' units written in C++ and available in binary form.\\
+ Any pipeline built up as an assembly of several black boxes (atomic or complex), and described in \bbs script language is itself viewed as a complex black box, and hence tagged as belonging to the latter category.
+ \item\texttt{example} / \texttt{demo} / \texttt{application} (see \ref{sec:demos_examples})\\
+ These ones are scripts that produce a result when executed (i.e. they
+ execute a pipeline), as opposed to the scripts that only define complex boxes but do not instanciate and execute boxes.
+ \begin {itemize}
+ \item\texttt{example}: It is just a (simple) example, for programmers, of how to use a given feature. The \texttt{Examples} link on the starting page links to the list of the boxes of this category.
+ \item\texttt{demo}: It can be a 'good looking' (a.k.a 'sexy') example of some sophisticated work, done only by using \texttt{bbtk}. The \texttt{Demos} link on the starting page links to the list of the boxes of this category.
+ \item\texttt{application}: It is a final application, end-user intended (e.g. association of a DICOM image browser, reader, viewer with some interaction and processing)
+ \end {itemize}
+ \item\texttt{widget}: A piece of graphical interface (based on \texttt{wxWidgets}).
+ \item\texttt{dicom}: A box related to medical images in Dicom format.
+ \item\texttt{viewer}: A box allowing to view something (e.g. an image).
+ \item\texttt{read/write}: An I/O-related box.
+ \item\texttt{mesh}: A mesh-related box.
+ \item\texttt{filter}: A filter, mainly image filters.
+ \item\texttt{image}: An image-related box.
+ \item\texttt{3D object creator}: A box which creates a 3D object to be injected into a 3D view (e.g. a plane, a surface).
+ \item\texttt{math}: Maths of course.
+ \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.
+ \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.
+
+% ==========================================
+\subsubsection{The Package Browser}
+\label{Package_Browser}
+% ==========================================
+
+The package browser is a standalone application \texttt{bbPackageBrowser}, which
+dynamically loads and queries the available packages.
+It is thus a smarter tool than the static html documentation.
+You can run it independently or from \bbStudio using either the button labeled \texttt{Start Package Browser} of the 'Command' part or the corresponding entry in the menu 'Windows'.
+Note that it may take some time to start because it loads all available
+packages at start.
+Its appearance is reproduced in figure \ref{imPackage_Browser}.
+
+\begin{figure}[!ht]
+\caption{The Package Browser}
+\begin{center}
+\includegraphics[width=0.6\textwidth]{Package_Browser.png}
+\end{center}
+\label{imPackage_Browser}
+\end{figure}
+
+It allows you to find boxes by use of a multi-criteria filtering principle:
+the boxes listed are the ones the attributes of which match \emph{all} the
+words entered in the 'Filter' part.
+You can get the whole description of a given box by clicking on its name.
+\\
+Warnings:
+
+\begin{itemize}
+\item It is case sensitive, i.e '\texttt{Button}'
+will give different results than '\texttt{button}'.
+\item After typing a filtering string, you have to validate it by pressing the 'Enter' key, in order to update the display of the boxes list.
+\item A filtering string only needs to match a subpart of the related attribute of a box.
+For example, entering 'utt' in the 'Name' attribute will match a box called 'Button'.
+\end{itemize}
+
+Attributes:
+
+\begin {itemize}
+\item \texttt{Package}: The name of the package to which the box belongs (e.g. \texttt{wxvtk}, \texttt{std}).
+\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 Nature}: The \texttt{nature} of an input or output (e.g. \texttt{file name}, \texttt{signal}).
+\end {itemize}
+
+%If 'Show widgets' is selected then
+
+
+%%\newpage
+
+
% ==========================================
% ==============================================
\subsection{Running Demos and Examples}
+\label{sec:demos_examples}
% ==============================================
-In the 'Help' part (See figure \ref{HelpContents}), select \texttt{Examples} link.
+As previously mentioned, the links \texttt{Demos} and \texttt{Examples} in the 'Help' part (See figure \ref{HelpContents}), give access to special complex boxes from the respective categories. Here, we use an example, both to illustrate the use of this help and to explain a short \bbs script.\\
\begin{figure}[!ht]
-\caption{\label{HelpContents}\bbStudio 'Help' panel}
+\caption{\bbStudio 'Help' panel}
\begin{center}
\includegraphics[width=0.7\textwidth]{HelpContents.png}
\end{center}
+\label{HelpContents}
\end{figure}
%\newpage
+Select \texttt{Examples} link. You will get a list of examples (See figure \ref{example}).
-You will get a list of examples (See figure \ref{example}).
-
-Note : due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\
+Note: due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\
\begin{figure}[!ht]
-\caption{\label{example}Examples list}
+\caption{Examples list}
\begin{center}
\includegraphics[width=0.7\textwidth]{example.png}
\end{center}
+\label{example}
\end{figure}
Select \texttt{wx::exampleSlider}.
\begin{figure}[!ht]
-\caption{\label{exampleSlider}Html documentation of example 'exampleSlider'}
+\caption{Html documentation of example 'exampleSlider'}
\begin{center}
\includegraphics[width=0.7\textwidth]{exampleSlider.png}
\end{center}
+\label{exampleSlider}
\end{figure}
-You can see information on the example and
+You can see information about the example and
the graphical representation of the workflow defined by the script
(the elementary boxes that compose it, and their connections, see figure \ref{exampleSlider}).
in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
\begin{figure}[!ht]
-\caption{\label{exampleSliderSource}Source code of 'exampleSlider'}
+\caption{Source code of 'exampleSlider'}
\begin{center}
\includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
\end{center}
+\label{exampleSliderSource}
\end{figure}
Run it, using the 'Files' toolbar (see figure \ref{lowertoolbar})
%\newpage
-Just a few words on what you saw :
+Just a few words on what you saw:
\begin{itemize}
-\item{In the source code of the script} : \\
-\begin{verbatim}
+\item{In the source code of the script}:
+ \begin{verbatim}
load std
load wx
-\end{verbatim}
-These \bbs commands load the packages std and wx
-\begin{verbatim}
+ \end{verbatim}
+ These \bbs commands load the packages \texttt{std} and \texttt{wx}
+ \begin{verbatim}
new Slider slider
set slider.ReactiveOnTrack 1
-\end{verbatim}
-We create a \texttt{Slider} box called \emph{slider}.
+ \end{verbatim}
+ We create a \texttt{Slider} box called \emph{slider}.
-We tell it to inform anybody that's interested in, that the cursor moved, each time it moved.
-The default behaviour is to inform only when cursor is released.
-\begin{verbatim}
+ We tell it to inform anybody that's interested in, that the cursor moved, each time it moved.
+ The default behaviour is to inform only when cursor is released.
+ \begin{verbatim}
new OutputText text
-\end{verbatim}
-We create an \texttt{OutputText} box called \emph{text}
-(in which slider value will be displayed)
+ \end{verbatim}
+ We create an \texttt{OutputText} box called \emph{text}
+ (in which slider value will be displayed)
-\begin{verbatim}
+ \begin{verbatim}
new LayoutLine layout
-\end{verbatim}
-We create a \texttt{LayoutLine} box called \emph{layout},
-a widget box designed to embed other widgets (say, a main window)
-\begin{verbatim}
+ \end{verbatim}
+ We create a \texttt{LayoutLine} box called \emph{layout},
+ a widget box designed to embed other widgets (say, a main window)
+ \begin{verbatim}
connect slider.Widget layout.Widget1
connect text.Widget layout.Widget2
-\end{verbatim}
-We embed \emph{slider} and \emph{text} into \emph{layout}.
-\begin{verbatim}
+ \end{verbatim}
+ We embed \emph{slider} and \emph{text} into \emph{layout}.
+ \begin{verbatim}
connect slider.BoxChange text.BoxExecute
connect slider.Out text.In
-\end{verbatim}
-We tell \emph{slider} to inform \emph{text} every time it's modified.
+ \end{verbatim}
+ We tell \emph{slider} to inform \emph{text} every time it's modified.
-We tell \emph{slider} to pass its output value (\texttt{Out})
-to \emph{text} input value (\texttt{In})
-\begin{verbatim}
+ We tell \emph{slider} to pass its output value (\texttt{Out})
+ to \emph{text} input value (\texttt{In})
+ \begin{verbatim}
exec layout
-\end{verbatim}
-We tell \emph{layout} to process itself.
-This also produces the execution of the boxes connected to it (the slider, the text).
+ \end{verbatim}
+ We tell \emph{layout} to process itself.
+ This also produces the execution of the boxes connected to it (the slider, the text).
\item{In the Help part}
-You can see the graphical representation of the workflow (pipeline) created by the script,
-as in figure \ref{SmallGraph}.
-
-
-\begin{figure}[!ht]
-\caption{\label{SmallGraph}Graphical representation of a pipeline}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{SmallGraph.png}
-\end{center}
-\end{figure}
-
-The representation includes
-both the graphical interface-related pipeline
-(\emph{slider} and \emph{text} are embedded into \emph{layout})
- and the data processing-related pipeline
-(\emph{slider} warns \emph{text} immediately when it's modified,
-\emph{slider} passes \emph{text} its output value)\footnote{Yes, we know : all the arrows (graphical interface pipeline arrows and data processing arrows)
-are blue; using different colors is planned for next release...}.
+ You can see the graphical representation of the workflow (pipeline) created by the script,
+ as in figure \ref{SmallGraph}.
+
+
+ \begin{figure}[!ht]
+ \caption{Graphical representation of a pipeline}
+ \begin{center}
+ \includegraphics[width=0.7\textwidth]{SmallGraph.png}
+ \end{center}
+ \label{SmallGraph}
+ \end{figure}
+
+ The representation includes
+ both the graphical interface-related pipeline
+ (\emph{slider} and \emph{text} are embedded into \emph{layout})
+ and the data processing-related pipeline
+ (\emph{slider} warns \emph{text} immediately when it's modified,
+ \emph{slider} passes \emph{text} its output value)\footnote{Yes, we know : all the arrows (graphical interface pipeline arrows and data processing arrows)
+ are blue; using different colors is planned for next release...}.
-You can get a much more detailled graph,
-like in figure \ref{LargeGraph},
-just clicking on the button
-'\texttt{graph (detailled)}' in the toolbar of the \texttt{Command} part.
+ You can get a much more detailed graph,
+ like in figure \ref{LargeGraph},
+ just clicking on the button
+ '\texttt{graph (detailed)}' in the toolbar of the \texttt{Command} part.
-\begin{figure}[!ht]
-\caption{\label{LargeGraph}Detailled graphical representation of a pipeline}
-\begin{center}
-\includegraphics[width=0.75\textwidth]{LargeGraph.png}
-\end{center}
-\end{figure}
+ \begin{figure}[!ht]
+ \caption{Detailed graphical representation of a pipeline}
+ \begin{center}
+ \includegraphics[width=0.75\textwidth]{LargeGraph.png}
+ \end{center}
+ \label{LargeGraph}
+ \end{figure}
\end{itemize}
%\newpage
-% ==============================================
-\subsection{Online Help}
-% ==============================================
-
-Various levels or help are supplied by \bbStudions.
-
-% ==========================================
-\subsubsection{Command line help}
-% ==========================================
-
-
-The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of :
-one single line area (\texttt{Command}), at the bottom, in which you can enter your commands and
-a multiple line zone in which the Command interpreter prints out the result of your commands.
-%The upper part contains the script editor; we shall not use it right now, you may reduce it.
-Command line help for the black box scripting language (\bbsns) can be obtained
-in this zone (see \ref{Scripting}).
-
-% ==========================================
-\subsubsection{Guides}
-% ==========================================
-
-An html version of all the guides is browsable in the \texttt{Help} part of \bbStudions.
- \begin{itemize}
- \item {\bf\emph{User's Guide}} : This guide !
- \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for programmer who wants to create his own
- black boxes/packages.
- % \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probably not very much
- % up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
- % \item {\bf\emph{Reference Manual}} : Contains a exaustive description of all the features for all the commands.
- %\item {\bf\emph{Booklet}} : Vade mecum.
- \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source files. Should only concern the kernel developpers.
- \end{itemize}
-
-
-
-
-% ==========================================
-\subsubsection{Boxes Help}
-% ==========================================
- Lists of currently available boxes from installed packages
- \begin{itemize}
- \item {\bf\emph{Alphabetical list}} : %This is the 'zero-level' of retrieving.
- \item {\bf\emph{List by package}} Boxes indexed by package
- \item {\bf\emph{List by category}} :
- Each box is indexed by a list of keywords, called 'categories', such as '\texttt{read/write}',
- '\texttt{filter}', '\texttt{viewer}', ...
- A given box may belong to more than one \texttt{category}, however some categories are mutually exclusive.
- Standard categories are :
- \begin {itemize}
- \item\texttt{atomic box}/\texttt{complex box}\\
- Whether it's an 'atomic' unit written is C++ and available in binary form in a package or it's an assembly of several black boxes (atomic or complex) which is described in \bbs script language.\\
- Any box is either atomic ou complex.\\
- Any pipeline described in a \bbs script is itself viewed as a complex black box hence is tagged as belonging to this category.
- \item\texttt{example} / \texttt{demo} / \texttt{application}\\
- These ones are scripts which produce a result when executed (i.e. they
- execute a pipeline like \texttt{exampleSlider} above), as oposite to the scripts which only define complex boxes but do not instanciate and execute boxes.
- \begin {itemize}
- \item\texttt{example} : It's just a (simple) example, for programmers, on how to use a given feature. The \texttt{Examples} link on the starting page links to the list of the boxes of this category.
- \item\texttt{demo} : It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work, done only by using \texttt{bbtk}. The \texttt{Demos} link on the starting page links to the list of the boxes of this category.
- \item\texttt{application} : It's a final application, end user intended (e.g. Subscale a huge volume without loading it in memory, Crop a DICOM image, etc.)
- \end {itemize}
- \item\texttt{widget} : A piece of graphical interface (based on \texttt{wxWidgets})
- \item\texttt{dicom} : Dicom medical image-related box.
- \item\texttt{viewer} : A box allowing to view something (e.g. an image).
- \item\texttt{read/write} : An I/O-related box
- \item\texttt{mesh} : A mesh-related box
- \item\texttt{filter} : A filter, mainly image filters.
- \item\texttt{image} : An image-related box
- \item\texttt{3D object creator} : A box which creates a 3D object to be injected into a 3D view (e.g. a plane, a surface).
- \item\texttt{math} : Math
- \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, then 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 box which are used internaly to perform type conversions. Thought there are not end user intended, you may see their list. Adaptors belong to the \texttt{adaptor} category.
- \end {itemize}
-
-% ==========================================
-\subsubsection{The Package Browser}
-\label{Package_Browser}
-% ==========================================
-
-The package browser is a standalone application which
-dynamically loads and queries the available packages.
-It is thus a smarter tool than the static html documentation.
-You can run it with the command \texttt{bbPackageBrowser}
-or in \bbStudio using either the button of the 'Command' part
-or the menu entry 'Windows$>$Start Package Browser'.
-Remark that it may take some time to start because it loads all available
-packages at start.
-Its appearance is reproduced in figure \ref{imPackage_Browser}.
-
-\begin{figure}[!ht]
-\caption{\label{imPackage_Browser}The Package Browser}
-\begin{center}
-\includegraphics[width=0.6\textwidth]{Package_Browser.png}
-\end{center}
-\end{figure}
-
-It allows you to find boxes using a multi-criteria filtering principle :
-The boxes listed are the one whose attributes match \emph{all} the
-words entered in the 'Filter' part.
-You can get the whole description of a given box clicking on its name.
-
-Warnings :
-
-\begin{itemize}
-\item It's case sensitive, i.e '\texttt{Button}'
-will give different results than '\texttt{button}'
-\item You have to press enter in the filter zone to update the boxes list
-\item A filtering string only has to match a subpart of the related attribute of a box.
-For example, entering 'utt' in the 'Name' attribute will match a box called 'Button'.
-\end{itemize}
-
-Attributes :
-
-\begin {itemize}
-\item Package : The name of the package to which the box belongs (e.g. \texttt{wxvtk}, \texttt{std})
-\item Name : The name of a box or an application (e.g. \texttt{Reader}, \texttt{example})
-\item Description : A part of the description of a box (e.g. \texttt{3D}, \texttt{image})
-\item Category : The categories of the box (e.g. \texttt{demo})
-\item Input/Output Type : The \CPP type of an input or output (e.g. \texttt{int}, \texttt{vtkImageData*}, \texttt{std::string})
-\item Input/Output Nature : The \texttt{nature} of an input or output (e.g. \texttt{file name}, \texttt{signal})
-\end {itemize}
-
-%If 'Show widgets' is selected then
-
-
-%%\newpage
-
% ==============================================
\subsection{The Menu}
% ==============================================
-At last, let's have a look at \bbStudio menu.(See figure \ref{themenu})
+At last, let us have a look at \bbStudio menu (see figure \ref{themenu}).
\begin{figure}[!ht]
-\caption{\label{themenu}The bbStudio menu}
+\caption{The bbStudio menu}
\begin{center}
\includegraphics[width=0.7\textwidth]{themenu.png}
\end{center}
+\label{themenu}
\end{figure}
\begin {itemize}
\end {itemize}
\item{\texttt{Tools}}
\begin {itemize}
- \item{\texttt{Create package}} :
- Provides a graphical interface to help package developpers to create a new empty package.
- \item{\texttt{Create black box}}
- Provides a graphical interface to help package developpers to create a new empty black box, and add it to an already existing package.
- \item{\texttt{Plug Package}}
+ \item{\texttt{Create package}}:
+ Provides a graphical interface to help package developers to create a new empty package.
+ \item{\texttt{Create black box}}:
+ Provides a graphical interface to help package developers to create a new empty black box, and add it to an already existing package.
+ \item{\texttt{Plug Package}}:
Incorporates a package into the list of known packages. Updates the html documentation.
- \item{\texttt{Regenerate package doc}} :
+ \item{\texttt{Regenerate package doc}}:
If a package has changed (e.g. new boxes) this updates the package html documentation.
- \item{\texttt{Regenerate boxes list}} :
+ \item{\texttt{Regenerate boxes list}}:
Updates the boxes lists (alphabetical, by package, ...)
- \item{\texttt{Regenerate all}}
+ \item{\texttt{Regenerate all}}:
Regenerates all the packages documentations and the boxes lists (may be long...).
- \item{\texttt{Show last graph}}
+ \item{\texttt{Show last graph}}:
Shows the last pipeline graph that was generated
\end {itemize}
\item{\texttt{Options}}
\begin {itemize}
- \item{\texttt{Reset before running}} Before running a script, all the already created boxes are destroyed,
- all the already loaded packages are unloaded (this is the recomended option).
+ \item{\texttt{Reset before running}}: Before running a script, all the already created boxes are destroyed,
+ all the already loaded packages are unloaded (this is the recommended option).
\end {itemize}
\item{\texttt{Windows}}
User may decide, for any reason of his own, to hide one or more panels:
\item{\texttt{Show 'Help' panel}}
\item{\texttt{Show 'Command' panel}}
\item{\texttt{Show 'Messages' panel}}
- \item{\texttt{Start Package browser}} : starts the package browser (see \ref{Package_Browser}).
+ \item{\texttt{Start Package browser}}: starts the package browser (see \ref{Package_Browser}).
\end {itemize}
\item{\texttt{About}}
\begin {itemize}
- \item{\texttt{About}} : Info about \texttt{bbStudio}.
+ \item{\texttt{About}}: Info about \texttt{bbStudio}.
\end {itemize}
\end {itemize}
% ==========================================
\subsection{The commands}
% ==========================================
-In \bbStudio, try typing in the \texttt{Command} area (in what follows,
-the commands entered by the user will be preceded by a prompt \textgreater) :
+In the sequel the commands entered by the user will be preceded by a prompt (\texttt{>}).
+To get started, type in the \texttt{Command} area:
\begin{verbatim}
> help
\end{verbatim}
-you get the list of the commands of the interpreter :
+you get the following list of the commands recognized by the interpreter:
\begin{verbatim}
Available commands :
author
unload
\end{verbatim}
-To get help on a particular command type \texttt{help <command-name>},
-for example:
+To get the help on a particular command, type \texttt{help <command name>}, e.g.:
\begin{verbatim}
> help author
\end{verbatim}
-gives :
+gives:
\begin{verbatim}
usage : author <string>
- Adds the string <string> to the author information of the black box being defined
+ Adds the string <string> to the author information
+of the black box being defined
\end{verbatim}
The \texttt{help} command has multiple usages.
-It is used to get help about almost anything in the interpreter!
-Type \texttt{'help help'} to get help on the \texttt{help} command itself :
+It is used to get help about almost anything in the interpreter, including the \texttt{help} command itself! Indeed:
\begin{verbatim}
> help help
+\end{verbatim}
+
+gives:
+\begin{verbatim}
usage :
- (1) help
- (2) help <command name>
- (3) help packages [all]
-
(4) help <package name> [all]
- (5) help <black box type>
- (6) help <black box name>
+ (1) help
+ (2) help <command name>
+ (3) help packages [all]
+ (4) help <package name> [all]
+ (5) help <black box type>
+ (6) help <black box name>
Effect :
- (1) Lists all available commands;
- (2) Prints help on a particular command;
- (3) Lists the packages loaded and their black boxes.
- Add 'all' to list adaptors;
- (4) Prints short help on the black boxes of a package.
- Add 'all' to include adaptors;
- (5) Prints full help on a black box type;
- (6) Prints information on the inputs, outputs and connectionns
+ (1) Lists all available commands;
+ (2) Prints help on a particular command;
+ (3) Lists the packages loaded and their black boxes.
+ Add 'all' to list adaptors;
+ (4) Prints short help on the black boxes of a package.
+ Add 'all' to include adaptors;
+ (5) Prints full help on a black box type;
+ (6) Prints information on the inputs, outputs and connections
of a black box instance.
\end{verbatim}
At start the interpreter does not know any black box.
If you type \texttt{'help packages'}, which is
-the third form of the \texttt{help} command, you get :
+the third form of the \texttt{help} command, you get:
\begin{verbatim}
> help packages
user
workspace
\end{verbatim}
-which means that the interpretor only knows one package
+which means that the interpreter only knows one package
(library of black boxes) called \texttt{user}
and which contains a black box called \texttt{workspace}.
The \texttt{user} package is an internal package of the interpreter,
which stores user-defined black box types.
At start, it already contains
-one box, called \texttt{workspace}.
-\texttt{workspace} is a special type of black box,
-called complex black box, whose purpose is
+one box, called \texttt{workspace},
+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
in \texttt{workspace}
(this will be explained in details in sections
\ref{bbi-writing-scripts} and
-\ref{bbi-more-on-complex-black-boxes}).
+\ref{bbi-command-line-app}).
-If you type \texttt{'help workspace'}, you get :
+If you type \texttt{'help workspace'}, you get:
\begin{verbatim}
> help workspace
Complex Black Box <user::workspace>
User's workspace
By : bbtk
- Category(s) : complex box;
+ Category(s): complex box;
* No inputs
* No outputs
* No boxes
The \texttt{std} package is the ``standard'' package,
which contains basic useful black boxes.
-To load it, type :
+To load it, type:
\begin{verbatim}
> include std
\end{verbatim}
-Then if you type :
+Then if you type:
\begin{verbatim}
> help packages
\end{verbatim}
-you get something like :
+you get something like:
\begin{verbatim}
-
std
- ASCII : ascii codes sequence to string - string to ascii...
- Add : Adds its inputs
- ConcatStrings : String concatenation
- Configuration : Gets configuration informations
- Div : Divides its inputs
- ExecBbiCommand : Executes bbi commands
- ExecSystemCommand : Executes system (O.S.) commands
- GetVectorCharElement : Gets the i-th element from the input vector (std...
+ ASCII
+ Add
+ ConcatStrings
+ Configuration
+ Div
+ ExecBbiCommand
+ ExecSystemCommand
+ GetVectorCharElement
...
- MagicBox : Takes *any kind* of data and copies it to its ou...
- MakeFileName : Makes a kosher file name
- Mul : Multiplies its inputs
- MultipleInputs : This box has multiple Void inputs and one Void o...
- StringRelay : Just copies the value of its input to its output...
- StringSelect : Outputs the string set to the ith input Ini (In0...
+ MagicBox
+ MakeFileName
+ Mul
+ MultipleInputs
+ StringRelay
+ StringSelect
user
workspace
\end{verbatim}
Now the interpreter knows the package \texttt{std} and the black boxes it provides,
such as the \texttt{Add} box, the \texttt{ConcatStrings} box, and so on. Remark that the
content of \texttt{std} may vary from one version to another
-as new black boxes might be added to it.
-If you type :
+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:
+\begin{verbatim}
+> help std
+\end{verbatim}
+
+Indeed, each of the items listed is followed by its short description:
+\begin{verbatim}
+ Package std v1.0.0- laurent.guigues at creatis.insa-lyon.fr
+ Basic useful boxes
+ Black boxes :
+ ASCII : ascii codes sequence to string - ...
+ Add : Adds its inputs
+ ConcatStrings : String concatenation
+ Configuration : Gets configuration informations
+ ...
+\end{verbatim}
+Additionally, in the right part of the screen ('Help' zone) the corresponding html page is displayed.
+
+Now, if you type:
\begin{verbatim}
> help Add
\end{verbatim}
-You'll get a text help, in the 'Message' part :
+{\bbStudions} 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
- By : laurent.guigues@creatis.insa-lyon.fr
- Categories : atomic box;math;
- * Inputs :
- 'BoxExecute' <bbtk::Void> [signal] : Any signal received by this input
+ Adds its inputs
+ By : laurent.guigues@creatis.insa-lyon.fr
+ Categories : atomic box;math;
+ * Inputs :
+ 'BoxExecute' <bbtk::Void> [signal] : Any signal received...
executes the box
- 'BoxProcessMode' <String> [] : Sets the processing mode of the box
- (Pipeline | Always | Reactive)
- 'In1' <Double> [] : First number to add
- 'In2' <Double> [] : Second number to add
- * Outputs :
- 'BoxChange' <bbtk::VoidS> [signal] : Signals modifications of the box
- 'Out' <Double> [] : Result
+ 'BoxProcessMode' <String> [] : Sets the processing mode...
+ (Pipeline | Always |...
+ 'In1' <Double> [] : First number to add
+ 'In2' <Double> [] : Second number to add
+ * Outputs :
+ 'BoxChange' <bbtk::VoidS> [signal]: Signals modifications...
+ 'Out' <Double> [] : Result
\end{verbatim}
-After loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box by
-the command \texttt{new} :
+\begin{figure}[!ht]
+\caption{The html Help}
+\begin{center}
+\includegraphics[width=0.7\textwidth]{HelpAdd.png}
+\end{center}
+\label{HelpAdd}
+\end{figure}
+
+These descriptions
+(provided by the author of the box) include:
+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} ,
+its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
+and a description.
+Remark that the box \texttt{Add} is not a 'complex' black box
+but an 'atomic' box, hence its help does not
+include a pipeline graph.
+
+You can see that \texttt{Add} boxes have two inputs,
+with name \texttt{In1} and \texttt{In2},
+and an output, named \texttt{Out}.
+
+After loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box, by use of the command \texttt{new}:
\begin{verbatim}
> new Add a
\end{verbatim}
-The \texttt{'a'} at the end is the \emph{name} of the instance,
+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}
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
-in \texttt{C} langage. The \texttt{new} command allows to create
+a \emph{box type}, like \texttt{int} is a data type
+in \texttt{C} language. The \texttt{new} command allows to create
an instance of a box type, exactly like \texttt{int i;} in
-a \texttt{C} code declares a variable of type \texttt{int} whose
-name is \texttt{i}.
+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 \bbi.
-After the creation of the box \texttt{a}, type :
+After the creation of the box \texttt{a}, type:
\begin{verbatim}
> help workspace
\end{verbatim}
Complex Black Box <user::workspace>
User's workspace
By : bbtk
- Category(s) : complex box;
+ Category(s): complex box;
* No inputs
* No outputs
* Boxes :
'a' <std::Add>
\end{verbatim}
-which means that \bbi workspace now contains a black box named \texttt{a},
-of type \texttt{std::Add}.
-
-
-Type
+This means that \bbi workspace now contains a black box named \texttt{a},
+of type \texttt{std::Add}. If you type:
\begin{verbatim}
-Help Add
+> help workspace
\end{verbatim}
- and have a look to the 'Help' Part (see figure : \ref{HelpAdd})
-
-\begin{figure}[!ht]
-\caption{\label{HelpAdd}The html Help}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{HelpAdd.png}
-\end{center}
-\end{figure}
-
-You can see a description
-(the one which was provided by the author of the box),
-the author(s) of the box (usually e-mail adress(es)) and
-the categories to which the box belongs.
-Finally comes the lists of inputs and outputs of the box.
-For each input or output, \bbi provides
-its \emph{name} ,
-its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
-and a description.
-Remark that the box \texttt{Add} is not a 'complex' black box
-but an 'atomic' box, hence its help does not
-include a pipeline graph.
+You get information about the actual instance \texttt{a} of the box type \texttt{std::Add}. It gives something like this:
+\begin{verbatim}
+> help a
+ Black Box 'a' <std::Add>
+ * Inputs :
+ 'BoxExecute' = '? (no adaptor found)' [Modified]
+ 'BoxProcessMode' = 'Pipeline' [Modified]
+ 'In1' = '0' [Modified]
+ 'In2' = '0' [Modified]
+ * Outputs :
+ 'BoxChange' = '? (no adaptor found)' [Out-of-date]
+ 'Out' = '0' [Out-of-date]
+\end{verbatim}
+Note that the inputs appear as \texttt{[Modified]}, since the code defining the box type includes an initialization of the inputs. On the other hand, the outputs appear as \texttt{[Out-of-date]}, as the box has not yet been executed and therefore its outputs have not been updated. See the second part of this section to learn more about the updating. For a moment, just note that one way to process the box \texttt{a} is to use the command:
+\begin{verbatim}
+> exec a
+\end{verbatim}
-You can see that \texttt{Add} boxes have two inputs,
-with name \texttt{In1} and \texttt{In2},
-and an output, with name \texttt{Out}.
+This command does not display anything (except if the
+box itself displays something in its processing).
+It just processes the box if needed. In our case, the result can be seen as follows:
+\begin{verbatim}
+> exec a
+> help a
+ Black Box 'a' <std::Add>
+ * Inputs :
+ 'BoxExecute' = '? (no adaptor found)' [Up-to-date]
+ 'BoxProcessMode' = 'Pipeline' [Up-to-date]
+ 'In1' = '0' [Up-to-date]
+ 'In2' = '0' [Up-to-date]
+ * Outputs :
+ 'BoxChange' = '? (no adaptor found)' [Up-to-date]
+ 'Out' = '0' [Up-to-date]
+\end{verbatim}
+Note the change of status of all the inputs and outputs (\texttt{[Up-to-date]}).
+In practice, the command \texttt{exec} is useful to execute boxes that do not have any output,
+such as boxes that write something to a file or, display a
+graphical interface, and so on.
-You can set the input \texttt{In1}
-of the \texttt{Add} box \texttt{a} to the value $1$
-by the command :
+Now, let us set the input \texttt{In1}
+of the \texttt{Add} box \texttt{a} to the value $3.5$
+by the command:
\begin{verbatim}
-> set a.In1 1
+> set a.In1 3.5
\end{verbatim}
-Similarly, setting the input \texttt{In2} of \texttt{a} to the value $2$
-is done with :
+Similarly, setting the input \texttt{In2} of \texttt{a} to the value $4.3$
+is done with:
\begin{verbatim}
-> set a.In2 2
+> set a.In2 4.3
\end{verbatim}
-And you print the output \texttt{Out} of the box \texttt{a} with :
+And you print the output \texttt{Out} of the box \texttt{a} with:
\begin{verbatim}
> print "result=$a.Out$"
-result=3
+result=7.8
\end{verbatim}
In the string passed to the \texttt{print} command,
each substring enclosed between a couple of \$ is considered
as the name of an output of a box.
-To process this special substrings, the interpretor :
+To process these special substrings, the interpreter:
\begin{enumerate}
\item Processes the box if needed (see below)
\item Converts the output of the box to a string if possible
%\paragraph
-Box processing is needed if :
+Box processing is needed if:
\begin{itemize}
-\item either at least input has changed since last processing
+\item either at least one input has changed since last processing
\item or the input \texttt{'BoxProcessMode'} of the box is set to
\texttt{'Always'}, which forces box reprocessing.
\end{itemize}
-Note that all boxes have an input named \texttt{'BoxProcessMode'}.
-
-Another way to process the box \texttt{a} is to issue the command :
-\begin{verbatim}
-> exec a
-\end{verbatim}
-
-however this command does not display anything (except if the
-box itself displays something in its processing).
-It just processes the box if needed.
-This command is used to execute boxes that do not have any output,
-such as boxes that write something to a file or, display a
-graphical interface, and so on. \newline
+Note that all boxes have an input named \texttt{'BoxProcessMode'}. \newline
%To exit \bbi, type :
%\begin{verbatim}
\paragraph{Summary}
%\hrule
\begin{itemize}
-\item The \texttt{include} command allows to load a package, and the complex black boxes that come with it..
-\item \texttt{help} gives help on :
+\item The \texttt{include} command allows to load a package, and the complex black boxes that come with it.
+\item \texttt{help} gives help on:
\begin{itemize}
\item Available commands if you just type \texttt{help}.
\item A particular command if you type \texttt{help <command-name>}.
\item All available packages and their boxes (without description) if you type \texttt{help packages}.
\item A particular package and its boxes (with brief description) if you type \texttt{help <package-name>}.
\item A particular black box type (with full description) if you type \texttt{help <box-type-name>}. In particular, \texttt{help workspace} displays information on the content of the \texttt{'workspace'} black box, which stores the boxes created by the user (by \texttt{new}).
+\item A particular black box instance (with full description, as well as the values and the status of the inputs/outputs) if you type \texttt{help <box-name>}.
\end{itemize}
%\item \texttt{list} displays the list of black box instances created so far (by \texttt{new}).
-\item \texttt{new} : creates an instance of a black box.
-\item \texttt{set} : sets the value of an input of a black box.
+\item \texttt{new}: creates an instance of a black box.
+\item \texttt{set}: sets the value of an input of a black box.
\item Under any component of \bbStudions, to reference the input called \texttt{i}
of a black box called \texttt{b} you must type \texttt{'b.i'}.
The same syntax holds for outputs.
-\item \texttt{print} : prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. Note that an
+\item \texttt{print}: prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. Note that an
implicit trailing 'new line character' is added at the final string.
-\item \texttt{exec} : runs, if needed, the process of a box.
-%\item \texttt{quit} : quits \bbi.
+\item \texttt{exec}: runs, if needed, the process of a box.
+%\item \texttt{quit}: quits \bbi.
\end{itemize}
\hrule
%\paragraph{Note :}
%A more 'modern' way to proceed is to run \texttt{bbStudio}, drag and drop the \texttt{Command} bookmark to the lower \texttt{Welcome to bbStudio!} bar.
-%Wou'll get something like in figure \ref{bbCommandPlusHelp} :
+%Wou'll get something like in figure \ref{bbCommandPlusHelp}:
%\begin{figure}[!ht]
%\caption{\label{bbCommandPlusHelp}
also called \emph{pipelines},
by connecting black boxes.
This section explains how to do it with examples.
-Read section \ref{bbi-more-on-pipeline-processing} to get
+Read section \ref{bbi-deep-box} to get
more information on pipeline processing.
-First start \bbStudio and load the package \texttt{std}, typing :
+First start \bbStudio and load the package \texttt{std}, i.e. type in the 'Command' part the following command:
\begin{verbatim}
> include std
\end{verbatim}
-in the 'Command' part.
-Assume you want to compute $1+2+3$. You can do it by
+Assume you want to compute a sum of three numbers (e.g. $1+2+3$). You can do it by
chaining two \texttt{Add} boxes, as shown in figure
\ref{bbi-fig-connecting-black-boxes-1}.
\begin{figure}[!ht]
-\caption{\label{bbi-fig-connecting-black-boxes-1} A simple pipeline which adds 3 numbers}
+\caption{ A simple pipeline that adds 3 numbers}
\begin{center}
\includegraphics[width=0.5\textwidth]{1plus2plus3.png}
\end{center}
+\label{bbi-fig-connecting-black-boxes-1}
\end{figure}
-
The \bbi instructions to create and execute this pipeline are :
\begin{verbatim}
> new Add a
\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 \texttt{b} black box output (the pipeline is executed before printing, because the interpretor 'knows' the box \texttt{b},
-whose output is requested, is not up to date).
+the 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.
The command \texttt{'connect a.Out b.In1'} ``plugs'' the output
\texttt{Out} of the box \texttt{a} into the input \texttt{In1} of the
box \texttt{b}.
-Once the boxes are connected, the processing of the two boxes are chained :
+Once the boxes are connected, the processings of the two boxes are chained:
getting the output of \texttt{b} requires getting its inputs,
hence getting the output of \texttt{a} which is connected to it.
-This pipeline mechanism can recurse into arbitrary long
-chains of boxes (see \ref{bbi-more-on-pipeline-processing}
+This pipeline mechanism can recurse into arbitrarily long
+chains of boxes (see \ref{bbi-deep-box}
for details).
-
-Lets' consider an other, more image oriented, example :
+Let us consider another, more image-oriented, example :
\begin{verbatim}
> include vtk
> exec viewer
\end{verbatim}
-Some explainations : the \texttt{include} instructions load the necessary packages. \\
-
-\texttt{FileSelector} will pop a File Selector, at run time, that will out the user chosen file name. \\
-\texttt{Slider} will pop a Slider, at run time, that will out an integer, used later as a slice number.\\
-\texttt{ImageReader} will read any itk readable file, whose name is passed as a std::string, and return a pointer on an itk image.\\
-\texttt{Viewer2D} displays a plane, whose number is specified by an integer.\\
-\\
-\texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a std::string) to the input of the reader (a std::string, too).\\
-\texttt{connect reader.Out viewer.In} plugs the output of the reader (an bbtk::any<bbitk::ImagePointer> which is a type defined by the
-itk package which can hold any itk image pointer) to the input of the Viewer (a vtkImageData *)\\
-\texttt{connect slider.Out viewer.Slice} plugs the output of the slider (an int) to an other output (named Slide) of the viewer.\\
-\texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer that it must re process itself any time the slider is modified.\\
-\\
-\texttt{exec viewer} processes the viewer.
-
+Some explanations:
+\begin{itemize}
+ \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
+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.
+\end{itemize}
This would correspond to the graph in figure \ref{bbi-simplegraph}
\end{figure}
Of course, to be able to connect two boxes,
-the output and the input must be compatibles.
+the output and the input must be compatible.
You can always connect an output to an input of the \emph{same} type,
but you can do more, thanks to particular (hidden) black boxes called {\bf adaptors}.
-An adaptor is a black box which has at least one input, called \texttt{In},
-and at least one ouput called \texttt{Out} and whose role is to convert
+An adaptor is a black box that has at least one input, called \texttt{In},
+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 retreive other useful information).
+to parameter the adaptor or retrieve other useful information).
Under \bbStudions, if you type :
\begin{verbatim}
In our example, the \texttt{CastUCharToDouble} adaptor
would simply cast the value of the \texttt{char} into a \texttt{double},
however arbitrarily complex type conversion may be done.\\
-\texttt{WARNING} : these adaptors are \texttt{C++ static cast}, i.e., there is, right now,
+\texttt{WARNING}: these adaptors are \texttt{C++ static cast}, i.e., there is, right now,
no 'intelligent' conversion (only truncation) e.g. think to \texttt{CastDoubleToUChar}!
%\begin{verbatim}
%\hrule
\begin{itemize}
\item The \texttt{connect} command allows to connect two black boxes
-\item You can connect two black boxes if (and only if) :
+\item You can connect two black boxes if (and only if):
\begin{itemize}
\item The output and the input are of the same type, or
\item There is an adaptor black box in the packages loaded which
> endefine
\end{verbatim}
-Explainations :
+Explanations :
As we will use \texttt{Add} boxes, we need to load the package \texttt{std}, which is done in first line.
The inner boxes have they own entries (In1, In2, In3 for box a, In1, In2 for box b )\\
-Only the inputs In1, In2, In3 of box a and the input In2 of box b is of interest for the end user, but he dosn't want to have to
+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 meaningfull name !
+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"
every widget can be inserted into another widget.
The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{layout}
widgets
-(in \bbi type \texttt{help Slider} :
+(in \bbi type \texttt{help Slider}:
you will see the output \texttt{Widget};
-type \texttt{help LayoutSplit} :
+type \texttt{help LayoutSplit}:
you will see the inputs \texttt{Widget1} and \texttt{Widget2}
and the output \texttt{Widget}).
When you connect the \texttt{Widget} output of a box
you order to include the widget in the layout.
Of course, the order of connection is important.
In our case, the slider \texttt{s1} is included first,
-then the slider \texttt{s2} : \texttt{s1} will be placed
+then the slider \texttt{s2}: \texttt{s1} will be placed
on top of \texttt{s2} (the \texttt{LayoutSplit} box is
implemented that way, but this is arbitrary choice).
%=====> TODO \\
-%One word about a special widget in the package \texttt{wx} :
+%One word about a special widget in the package \texttt{wx}:
%the \texttt{Button}... to be continued.
% ==========================================
\begin{itemize}
\item Any \texttt{atomic} black box has two default Inputs, which are created by the system :
\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 :
+ \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 \\
+ \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() \\
+ \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)\\
+ \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}
+ \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.
\end{itemize}
\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 :
\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 {\bf\emph{WinHeight}}: Height of the window
+ \item {\bf\emph{WinWidth}} : Width of the window
+ \item {\bf\emph{WinTitle}} : Title of the window
+ \item {\bf\emph{WinClose}} : Any received signal closes the window
+ \item {\bf\emph{WinHide}} : Any received signal hides the window
+ \item {\bf\emph{WinDialog}}: When set to 'true', creates a \emph{dialog window}, that blocks the pipeline until it is closed (\emph{modal})
\end{itemize}
If you define a complex widget box, it is a good idea to define these inputs to be able
to customize your window settings.
-\item Any {\bf widget} box has one mandatory Output :
+\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},
+ \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}
\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)
+ \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}
\section{Using third party Package}
\label{Third_Party_Package}
% ==========================================
+% ==========================================
+\subsection{Installing a Package}
+\label{Installing_a_Package}
+
+% ==========================================
+\subsubsection{Linux users}
+\label{Installing_a_Package_for_Linux_users}
+
+After compiling a Package, at install time, think of using :
+\begin {verbatim}
+su -
+make install
+\end{verbatim}
+
+and neither :
+\begin {verbatim}
+su
+make install
+\end{verbatim}
+
+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
+
+
+% ==========================================
+\subsubsection{Windows users}
+\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
+
% ==========================================
\subsection{Plugging in a Package}
\label{Plugging_in_a_Package}
\label{Hard_incorporating_of_a_Package}
% ==========================================
-If the Package you want to use is supplied in a non standard way (e.g. : you
+If the Package you want to use is supplied in a non standard way (e.g.: you
where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and/or
one or more directories containing \bbtk scripts (\texttt{.bbs})
you can edit your \bbtk configuration and add the appropriate
within a script, or from the \texttt{Command} part,
and enjoy the black boxes it contains.
-% ==========================================
-%\subsection{Packages you'll probably want to use }
+% ==========================================%\subsection{Packages you'll probably want to use }
%\label{Packages_you_ll_want_to_use}
% ==========================================
%\begin {itemize}
<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>
<config>
<bbs_path> </bbs_path>
- <package_path> </package_path>
+ <package_path> </package_path>
+ <default_temp_dir> $ </default_temp_dir>
</config>
\end{verbatim}
\end{document}
+
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff