\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 ?}
% ==========================================
\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
\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{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{Development 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 interpreter}}
- \item A powerful html {\bf\emph{Help environment}}, integrating:
+ \item A powerful html {\bf\emph{help environment}}, integrating:
\begin{itemize}
\item Online documentation scanning
\item Retrieving boxes on various criteria
- \item Checking Demo and examples
+ \item Checking demos and examples
\end{itemize}
\end{itemize}
\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}.
to start the development of a new black box package.
\item \bbCreateBlackBox allows to create the basic file architecture
to start the development of a new black box, that will be included in an already existing package.
- \item \bbs2cpp translates a \texttt{.bbs} script into a \CPP file.
- \item \bbc (sorry : Linux Only, for the moment) that compiles \texttt{.bbs} scripts into executables.
+ \item \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.
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 and 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}
+% ==============================================
+\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 boxe, 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 that
+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
+
+
% ==========================================
In the 'Help' part (See figure \ref{HelpContents}), select \texttt{Examples} link.
\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
\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}
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})
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 std and 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 detailled graph,
+ like in figure \ref{LargeGraph},
+ just clicking on the button
+ '\texttt{graph (detailled)}' 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{Detailled 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 of 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 (\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) can be obtained
-in this zone (see \ref{Scripting}). 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. 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.
-
-% ==========================================
-\subsubsection{Guides}
-\label{sec: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-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 developpers.
- \end{itemize}
-
-
-
-
-% ==========================================
-\subsubsection{Boxes Help}
-\label{sec: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) :
+the commands entered by the user will be preceded by a prompt \textgreater):
\begin{verbatim}
> help
\end{verbatim}
Complex Black Box <user::workspace>
User's workspace
By : bbtk
- Category(s) : complex box;
+ Category(s): complex box;
* No inputs
* No outputs
* No boxes
\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} :
+the command \texttt{new}:
\begin{verbatim}
> new Add a
Complex Black Box <user::workspace>
User's workspace
By : bbtk
- Category(s) : complex box;
+ Category(s): complex box;
* No inputs
* No outputs
* Boxes :
\item A particular black box type (with full description) if you type \texttt{help <box-type-name>}. In particular, \texttt{help workspace} displays information on the content of the \texttt{'workspace'} black box, which stores the boxes created by the user (by \texttt{new}).
\end{itemize}
%\item \texttt{list} displays the list of black box instances created so far (by \texttt{new}).
-\item \texttt{new} : creates an instance of a black box.
-\item \texttt{set} : sets the value of an input of a black box.
+\item \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}
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
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}
\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
git://git.creatis.insa-lyon.fr / bbtk.git / commitdiff