% ==========================================
\documentclass[11pt,final,a4paper]{article}
\input{config.tex}
-
-
-
\begin{document}
-
-\begin{center}
-
-{\Large \BBTK}
-\vspace{1cm}
-
-{\Huge User's Guide}
-\vspace{1cm}
-
-\bbtk version \bbtkVersion
-\vspace{0.5cm}
-
-
-Last modified on : October 16, 2008 \\
-Generated on : \today
-\vspace{0.5cm}
-\end{center}
-\begin{center}
-Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
-\end{center}
-\begin{center}
-CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
-INSA Lyon\\
-Universit\'e Claude-Bernard Lyon 1\\
-
-http://www.creatis.insa-lyon.fr/creatools/bbtk
-
-\end{center}
-
+\bbtkGuide[User's Guide]
% ==========================================
-\tableofcontents
-% ==========================================
-
-\listoftables
-
-\listoffigures
-
-% ==========================================
-%\section*{Abstract}
% ==========================================
\newpage
-% ==========================================
\hrule
-\section{What is bbtk ?}
+\section{Introduction}
+% ==========================================
+\subsection{What is bbtk ?}
% ==========================================
\BBTK(\bbtkns) is a set of tools
(\CPP libraries and executables)
%\end{verbatim}
% ==========================================
-\subsection{The black box philosophy}
+\subsubsection{The black box philosophy}
% ==========================================
\href{http://www.answers.com/topic/black-box-theater}{The Answers Dictionary} defines a {\bf black box} as
\end{itemize}
% ==========================================
-\subsection{\bbtk components}
+\subsubsection{\bbtk components}
% ==========================================
\BBTK includes :
\begin{itemize}
\end{center}
\end{figure}
-\newpage
+%%\newpage
+
+% ==========================================
+\subsection{Content of this guide}
+% ==========================================
+
+
% ==========================================
+\newpage
+\hrule
\section{Getting started with bbStudio}
+\label{bbStudio}
% ==========================================
Just run it, typing in a console \bbStudio
or clicking on its icon or its menu entry.
-
You'll get something like in figure
\ref{bbi-fig-bbStudio-gui-start}
-(the exact appearance of \bbStudio is Operating System and \bbtk version dependent)
-At start, \bbStudio opens with a very minimal 'How to use' in the middle. \\
-Don't forget to read it : it will vanish at the first mouse click. \
+(the exact appearance of \bbStudio is Operating System and \bbtk version dependent).
-
-\newpage
+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]
\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}
+%\begin{center}
+%\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
+%\end{center}
+%\end{figure}
-Feel free to resize any part you want.
-Your preferences will be kept next time you run again \bbStudio. \\
-
-Let's have a look at the resized window :
-
-\begin{figure}[!ht]
-\caption{\label{bbi-fig-bbStudio-gui}The bbStudio Development environment interface}
-\begin{center}
-\includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
-\end{center}
-\end{figure}
-
-You can see four parts : \texttt{Files}, \texttt{Messages},
- \texttt{Command}, \texttt{Help}.\\
-
-The stuff is written using the Advanced User Interface library of wxWidgets
+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),
whose 'docking manager' allows windows and toolbars to be floated/docked
-onto a frame.\\
-Please don't use this feature at learning time (the snapshots of this document
- wouldn't match with your screen ...)
+onto a frame.
+Feel free to resize/reposition any part you want.
+Your preferences will be kept next time you run again \bbStudions.
+
+%Please don't use this feature at learning time
+%(the snapshots of this document wouldn't match with your screen ...)
\subsubsection{'Files' part}
\label{bbi-FilesPart}
-It's the .bbs script editor.\\
+It's the \bbs script editor.
+
If you load a file holding a script, it will be displayed here, and you'll be
able to modify it, to save it, to save-as it, to run it, using the
-lower toolbar (see figure : \ref{lowertoolbar})
+lower toolbar (see figure \ref{lowertoolbar})
\begin{figure}[!ht]
-\caption{\label{lowertoolbar}The lower tool bar}
+\caption{\label{lowertoolbar}The 'Files' lower tool bar}
\begin{center}
\includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
\end{center}
Two kinds of messages will be output here:\\
System messages : produced by the kernel, in case of a user mistyping, or an execution error\\
Script messages : produced by the \bbtk equivalent of \texttt{printf}
-or \texttt{std::cout} in user programs
+or \texttt{std::cout} in user programs.
\subsubsection{'Command' part}
\label{bbi-CommandPart}
-This is where user will type \bbs commands which are executed on the fly..
+You can type here \bbs commands which are executed on the fly.
+The buttons are shortcuts to usual commands.
\subsubsection{'Help' part}
\label{bbi-HelpContentsPart}
-The 'Help' part of \bbStudio is used to browse the html help of \BBTK.
-All the entries of the starting page are self-explanatory :
- \begin{itemize}
- \item {\bf\emph{Help Contents}}
- \begin{itemize}
- %\item {\bf\emph{Wiki}} : Direct link to the bbtk Wiki (intranet only, right now, www
- %later).
- \item {\bf\emph{Demo}} : Link to some 'sophisticated' demonstrations.
- \item {\bf\emph{Examples}} : Link to some detailed 'How to use' examples
- \end{itemize}
-
- \item {\bf\emph{Guides}}
- \begin{itemize}
- \item {\bf\emph{User's Guide}} : This Guide.
- \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for user who wants to create his own
- black boxes.
- % \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers. .
- %\item {\bf\emph{Reference Manual}} :
- % \item {\bf\emph{Booklet}} : Vade mecum.
- \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.
- \end{itemize}
-
- \item {\bf\emph{Boxes}} : Lists of currently available Boxes :
- \begin{itemize}
- \item {\bf\emph{ Alphabetical list}},
- \item {\bf\emph{ List by package}},
- \item {\bf\emph{ List by category}} : Each box is indexed by a list of keywords, called 'categrories', such as 'read/write',
- 'filter' 'viewer', ...
- \item {\bf\emph{ List of adaptors}} : A special hidden Box category, called \texttt{{Adaptors}} exists. \\
- They are used internaly to perform type conversions. Thought there are not end user intended, you may see them.
- \end{itemize}
-
-
-
- \end{itemize}
+The 'Help' part of \bbStudio is used to browse the html help of \BBTKns.
% ==========================================
% ==========================================
-\newpage
+%\newpage
% ==============================================
-\subsection{Running Demo and Examples}
+\subsection{Running Demos and Examples}
% ==============================================
-In the part 'Help' (See figure \ref{HelpContents}), select \texttt{Examples} link.
+In the 'Help' part (See figure \ref{HelpContents}), select \texttt{Examples} link.
\begin{figure}[!ht]
-\caption{\label{HelpContents}Help}
+\caption{\label{HelpContents}\bbStudio 'Help' panel}
\begin{center}
\includegraphics[width=0.7\textwidth]{HelpContents.png}
\end{center}
\end{figure}
-\newpage
+%\newpage
You will get a list of examples (See figure \ref{example}).
-Due to an unfixed bug in Linux, you will have to click on 'reload' to get it. \\
+Note : due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\
\begin{figure}[!ht]
-\caption{\label{example}example list}
+\caption{\label{example}Examples list}
\begin{center}
\includegraphics[width=0.7\textwidth]{example.png}
\end{center}
%\end{figure}
-Select \texttt{wx::exampleSlider} (See figure \ref{exampleSlider});
+Select \texttt{wx::exampleSlider}.
\begin{figure}[!ht]
-\caption{\label{exampleSlider}example 'exampleSlider'}
+\caption{\label{exampleSlider}Html documentation of example 'exampleSlider'}
\begin{center}
\includegraphics[width=0.7\textwidth]{exampleSlider.png}
\end{center}
\end{figure}
-You can see the graphical summary representation of the current script (the elementary boxes that compose it, and their
-connections) \\
-Click on \texttt{source}, it will be loaded
+You can see information on 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}).
+
+Click on \texttt{[source]}, it will be loaded
in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
\begin{figure}[!ht]
-\caption{\label{exampleSliderSource}source code of 'exampleSlider'}
+\caption{\label{exampleSliderSource}Source code of 'exampleSlider'}
\begin{center}
\includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
\end{center}
\end{figure}
-Run it, using the lower toolbar (see figure : \ref{lowertoolbar})
+Run it, using the 'Files' toolbar (see figure \ref{lowertoolbar})
You'll get something like in figure \ref{execSliderSource}.
\begin{figure}[!ht]
-\caption{\label{execSliderSource}execution of 'exampleSlider'}
+\caption{\label{execSliderSource}Execution of 'exampleSlider'}
\begin{center}
\includegraphics[width=0.7\textwidth]{execSliderSource.png}
\end{center}
Feel free to move the slider, to check it actually works...
-\newpage
+%\newpage
Just a few words on what you saw :
\begin{itemize}
-\item{in the File part} \\
-The source code of the script
+\item{In the source code of the script} : \\
\begin{verbatim}
load std
load wx
\end{verbatim}
-We load the packages std and wx
+These \bbs commands load the packages std and wx
\begin{verbatim}
new Slider slider
- set slider.ReactiveOnTrack 1
+ set slider.ReactiveOnTrack 1
\end{verbatim}
-We create a \texttt{Slider} called \emph{slider}\\
-We tell it to inform anybody that's interested in, that the cursor moved, each time it moved. \\
-The default behaviour is to inform, only when cursor is released.
+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}
new OutputText text
\end{verbatim}
-We create an \texttt{OutputText} called \emph{text}
+We create an \texttt{OutputText} box called \emph{text}
(in which slider value will be displayed)
\begin{verbatim}
new LayoutLine layout
\end{verbatim}
-We create a \texttt{LayoutLine} called \emph{layout},
-a widget designed to embed other wigets (say, a main window)
+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
connect slider.BoxChange text.BoxExecute
connect slider.Out text.In
\end{verbatim}
-We tell \emph{slider} to inform \emph{text} every time it's modified.\\
-We tell \emph{slider} to pass its output value (\texttt{Out}) to \emph{text} input value (\texttt{In})
+We tell \emph{slider} to inform \emph{text} every time it's modified.
+
+We tell \emph{slider} to pass its output value (\texttt{Out})
+to \emph{text} input value (\texttt{In})
\begin{verbatim}
exec layout
\end{verbatim}
-We tell \emph{layout} to process itself (it will do it only if it's warned
-that one of its entries was modified since its (own) last processing).
+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}
+\item{In the Help part}
-You can see the graphical representation of the workflow (pipeline) of the script, as in figure \ref{SmallGraph}.
+You can see the graphical representation of the workflow (pipeline) created by the script,
+as in figure \ref{SmallGraph}.
\begin{figure}[!ht]
\end{center}
\end{figure}
-Both graphical interface pipeline (\emph{slider} and \emph{text} are embedded into \emph{layout})
- and processing pipeline (\emph{slider} warns \emph{text} immedialtely when it's modified, \emph{slider} passed \emph{text} its new value).\\
- Yes, we know : all the arrows (graphical interface pipeline arrows and processing arrows) are blue; we are sorry about that...\\
+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, just clicking on the button \\ \texttt{graph (detailled)} in the toolbar of the \texttt{Command} part, like in
- figure \ref{LargeGraph}.
+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}
\end{figure}
\end{itemize}
-\newpage
+%\newpage
% ==============================================
\subsection{Online Help}
The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of :
one single line area (\texttt{Command}), at the bottom, in which you can enter your commands and
a multiple line zone in which the Command interpreter prints out the result of your commands.
-The upper part contains the script editor; we shall not use it right now, you may reduce it
-
-Try typing in the \texttt{Command} area (in this manual,
-the commands entered by the user will be preceded by a prompt \textgreater) :
-\begin{verbatim}
-> help
-\end{verbatim}
-
-you get the list of the commands of the interpreter :
-\begin{verbatim}
-Available commands :
- author
- category
- config
- connect
- debug
- define
- delete
- description
- endefine
- endpackage
- exec
- graph
- help
- include
- index
- input
- kind
- load
- message
- new
- newgui
- output
- package
- print
- quit
- reset
- set
- unload
-\end{verbatim}
-
-To get help on a particular command type \texttt{help <command-name>},
-for example:
-\begin{verbatim}
-> help author
-\end{verbatim}
-
-gives :
-\begin{verbatim}
- usage : author <string>
- Adds the string <string> to the author information of the black box being defined
-\end{verbatim}
-
-The \texttt{help} command has multiple usages.
-It is used to get help about almost anything in the interpreter!
-Type \texttt{'help help'} to get help on the \texttt{help} command itself :
-\begin{verbatim}
-> help help
- usage :
- (1) help
- (2) help <command name>
- (3) help packages [all]
- (4) help <package name> [all]
- (5) help <black box type>
- (6) help <black box name>
- Effect :
- (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
- of a black box instance.
-\end{verbatim}
-
-
-More information about what is a 'box' will be given in the 'Scripting' part of this manual.
+%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}} : Step to step How-to for user who wants to create his own
- application, just using already existing boxes.
+ \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 file
- headers. Should concern only the kernel developpers (i.e. : us).
+ \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source files. Should only concern the kernel developpers.
\end{itemize}
-
+
+
% ==========================================
\subsubsection{Boxes Help}
% ==========================================
- Box retrieving on various criteria :
+ 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}} \\ Several packages are supplied with bbtk :
- \begin{itemize}
- \item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
- \item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).
- \item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
- \item {\bf\emph{vtk}} : the basic images and surfaces processing and vizualization package, based on the \vtk library.
- \item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
- interaction).
- %\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
- \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development:
- % \begin{itemize}
- % \item{\texttt{GUICreateBlackBox}} For creating the XML or C++ code for a new black box
- % \item{\texttt{GUICreatePackage}} For creating a new bbtk package file structure on disk (Graphical user interface for the shell script bbCreatePackage)
- % \item{\texttt{MakePackageDoc}} For creating the html documentation of a package. The doc is generated at the 'canonical' location. Works both for a build tree or an installed toolkit.
- % \end{itemize}
- \end{itemize}
- \item {\bf\emph{List by category}}.
-
-
- A given box may belong to more than one \texttt{category}.\\
- You have to consider categories like keywords to index black boxes.\\
- Some of them are mutually exclusive.
- A black box may be :
+ \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{atomic box / complex box}\\
- Whether it's written is C++ or it's an assembly of several black boxes (atomic or complex).\\
- Any box is either atomic ou complex.
- \item{example / demo / application}\\
- These ones are always complex black boxes.
+ \item\texttt{atomic box}/\texttt{complex box}\\
+ Whether it's a '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), contrarily to the scripts which only define complex boxes but do not instanciate and execute boxes.
\begin {itemize}
- \item{example}\\
- It's just a (simple) example, for programmers, on how to use a given feature.
- \item{demo}\\
- It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work, done only by using \texttt{bbtk}
- boxes.
- \item{application}\\
- It's a Final application, end user intended (e.g. Subscale a huge volume witout loading it in memory, Crop a DICOM image, etc)
+ \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 witout loading it in memory, Crop a DICOM image, etc.)
\end {itemize}
- \item{widget}\\
- Piece of graphical interface (based on \texttt{wxWidgets})
- \item{Dicom}\\
- Dicom medical image related box.
- \item{viewer}
- \item{read/write}
- \item{mesh}
- \item{3D Object creator}
- \item{math}
- \item{misc}
+ \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}
% ==========================================
\label{Package_Browser}
% ==========================================
-You can run it using the tool bar of the 'Command' part. See figure \ref{imPackage_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}
\end{center}
\end{figure}
-It allows you to query informations about what you can find in the packages (boxes and applications), using several criterions
-(warning : it's case sensitive, i.e '\texttt{Button}' will give different results than '\texttt{button}' ...)
+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 Packages :\\
-All the boxes and applications held in a given package (e.g. \texttt{wxvtk}, \texttt{std}, ...)
-\item Name :\\
-You can query on a subpart of the name of a box or an application (e.g. \texttt{DICOM})
-\item Description :\\
-You can query on a substring of the description of a box or an application (e.g. \texttt{utton} : user wants to get all
-the\texttt{Button} as well as the \texttt{button} )
-\item Category :\\
-You can query on a sub part of the category name of a box or an application (e.g. \texttt{3D})
-\item Input Type :\\
-You can query all the boxes or applications that have at least one Input entry of the given type (e.g. \texttt{int})
-\item Output Type :\\
-You can query all the boxes or applications that have at least one Output entry of the given type (e.g. \texttt{int})
-\item Input Nature :\\
-You can query all the boxes or applications that have at least one Input entry of the given nature (e.g. \texttt{signal})
-\item Output Nature :\\
-You can query all the boxes or applications that have at least one Output entry of the given nature (e.g.
-\texttt{signal},\texttt{file name})
+\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
-All these criterions are \emph{AND}ed while the query process.\\
-You can get the whole description of a given box or application clicking on its name.
-\newpage
+%%\newpage
% ==============================================
\subsection{The Menu}
\item{\texttt{Tools}}
\begin {itemize}
\item{\texttt{Create package}} :
- Provides a graphical interface to help Package developper to create a new empty 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 developper to create a new empty black box, and add it to an already existing package.
+ 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}}
Incorporates a package into the list of known packages. Updates the html documentation.
\item{\texttt{Regenerate package doc}} :
- if user was supplied new black boxes, and added them to an already existing package, he can update the package documentation, in order to benefit all the features of the Help mechanisms.
+ If a package has changed (e.g. new boxes) this updates the package html documentation.
\item{\texttt{Regenerate boxes list}} :
- if user wants to update only boxes list (quicker)
+ Updates the boxes lists (alphabetical, by package, ...)
\item{\texttt{Regenerate all}}
-
- \item{\texttt{Show last image graph}}
- User wants to rebuild the whole documentation.
+ Regenerates all the packages documentations and the boxes lists (may be long...).
+ \item{\texttt{Show last graph}}
+ Shows the last pipeline graph that was generated
\end {itemize}
\item{\texttt{Options}}
\begin {itemize}
all the already loaded packages are unloaded (this is the recomended option).
\end {itemize}
\item{\texttt{Windows}}
- User may decide, for any reason of his own, to hide one or more pannels:
+ User may decide, for any reason of his own, to hide one or more panels:
\begin {itemize}
\item{\texttt{Show 'Files' panel}}
\item{\texttt{Show 'Help' panel}}
\item{\texttt{Show 'Command' panel}}
\item{\texttt{Show 'Messages' panel}}
- \item{\texttt{Launch Package browser}} The package browser is a stand alone application. This can be achieved, too,
- using the lower tool bar : button \texttt{Start Package Browser}.
- \item{}
+ \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}.
\end {itemize}
\end {itemize}
+
+
+
+
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+\newpage
+\hrule
+\section{Writing black box scripts (\bbsns)}
+\label{Scripting}
+% ==========================================
% ==========================================
-\section{bbs scripting}
% ==========================================
+This section introduces how to write down black box scripts (\bbsns)
+to create and execute pipelines.
+
% ==========================================
-\subsection{Using an already existing script}
+\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) :
+\begin{verbatim}
+> help
+\end{verbatim}
+
+you get the list of the commands of the interpreter :
+\begin{verbatim}
+Available commands :
+ author
+ category
+ config
+ connect
+ debug
+ define
+ delete
+ description
+ endefine
+ endpackage
+ exec
+ graph
+ help
+ include
+ index
+ input
+ kind
+ load
+ message
+ new
+ newgui
+ output
+ package
+ print
+ quit
+ reset
+ set
+ unload
+\end{verbatim}
-Using the lower toolbar (see figure : \ref{lowertoolbar}), open the file
-holding the script.
+To get help on a particular command type \texttt{help <command-name>},
+for example:
+\begin{verbatim}
+> help author
+\end{verbatim}
+
+gives :
+\begin{verbatim}
+ usage : author <string>
+ Adds the string <string> to the author information of the black box being defined
+\end{verbatim}
+
+The \texttt{help} command has multiple usages.
+It is used to get help about almost anything in the interpreter!
+Type \texttt{'help help'} to get help on the \texttt{help} command itself :
+\begin{verbatim}
+> help help
+ usage :
+ (1) help
+ (2) help <command name>
+ (3) help packages [all]
+ (4) help <package name> [all]
+ (5) help <black box type>
+ (6) help <black box name>
+ Effect :
+ (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
+ of a black box instance.
+\end{verbatim}
+
+%More information about what is a 'box' will be given in the 'Scripting' part of this manual.
- You'll see it, in the '\texttt{Files}' part.\\ \\
- You may run it, using the lower toolbar. \\
- %\texttt{WARNING :} if the script contains one or more \texttt{LayoutSplit}
-% object, you will have to resize the sub windows. \\ \\
- You may modify, save or save-as the current script, using the lower toolbar.\\ \\
- You may have a look at the graphical representation of the pipeline (sorry,
- right now, to modify the pipeline, you have to modify the script;
- you cannot modify grapically the pipeline; Work in progress...)
-
% ==========================================
-\subsection{Inside black boxes}
+\subsection{Creating and executing black boxes}
% ==========================================
At start the interpreter does not know any black box.
% ==========================================
% ==========================================
-\subsubsection{Connecting black boxes}
+\subsection{Connecting black boxes}
\label{bbi-connecting-black-boxes}
% ==========================================
% ==========================================
% ==========================================
-\subsubsection{Creating complex black boxes}
+\subsection{Creating complex black boxes}
\label{bbi-complex-black-boxes}
% ==========================================
% ==========================================
% ==========================================
-\subsubsection{Writing scripts}
+\subsection{Writing scripts files}
\label{bbi-writing-scripts}
% ==========================================
Once you have defined a new type of complex box, you
may like to reuse it. To do this, you can simply
-write the \bbi commands defining the new box
+write the \bbs commands defining the new box
into a text file and afterwards include that file in \bbins.
-Doing this, you start writing \bbi scripts.
-The conventionnal (and mandatory) extension for such scripts is \texttt{bbs}
+Doing this, you start writing \bbs scripts.
+The conventional (and mandatory) extension for such scripts is \texttt{bbs}
(black box script).
For consistency reasons, you are requested to prepend \texttt{bb} to the name.
> include Add3
\end{verbatim}
-\subsubsection{Creating complex black boxes that use complex black boxes}
+\subsection{Creating complex black boxes that use complex black boxes}
\label{bbi-complex-complex-black-boxes}
\end{verbatim}
-\subsubsection{Naming Conventions}
+\subsection{Naming Conventions}
\label{bbi-Naming Conventions}
% ==========================================
% ==========================================
-\subsubsection{Creating command line applications}
+\subsection{Creating command line applications}
\label{bbi-command-line-app}
% ==========================================
x+y=7
\end{verbatim}
-\bbStudio is always compiled in graphical mode (with \wx), therefore
-you can also use the \texttt{-g} commutator.
+You can also use the \texttt{-g} commutator.
\bbi then prompts the user in graphical mode,
displaying a dialog box for each input,
like in fig. \ref{bb-input-dialog-box}.
\end{center}
\end{figure}
+Note that for both \texttt{-t} and \texttt{-g} options,
+the input from the user is a \texttt{string} and
+\bbi converts it to the right input type using
+an \texttt{adaptor}, hence the right adaptors must be loaded.
+
% ==========================================
\hrule
\paragraph{Summary}
% ==========================================
% ==========================================
-\subsubsection{Using graphical interface boxes (widget boxes)}
+\subsection{Using graphical interface boxes (widget boxes)}
\label{bbi-widget}
% ==========================================
% ==========================================
-\subsubsection{Overview}
-\label{bbi-overview}
+%\subsubsection{Overview}
+%\label{bbi-overview}
% ==========================================
-.
+
Basic graphical interface components are provided in the package \texttt{wx},
such as buttons, sliders, file open/save dialogs, etc.
%The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
%are ``terminal'' widgets.
%``container'' widgets are of another kind : they are
+% ==========================================
+%\subsubsection{Layout widgets}
+%\label{bbi-layout-widgets}
+% ==========================================
+
There is a special kind of widget, called '\texttt{Layout}', designed to
contain other widgets in order to build larger dialog boxes.
+
For example, the \texttt{LayoutSplit} widget is a container which
-``splits'' horizontally a window into two parts,
+``splits'' a window into two parts, either horizontally or vertically,
each part including another widget.
-The size of the two parts can be adjusted by the user thanks
-to a ``handle''.
+The initial size of the two parts can be fixed by the input 'Proportion'
+and be adjusted by the user thanks to a ``handle''.
The example \texttt{exampleLayoutSplit} demonstrates its use.
Run it : it displays a window with two sliders.
\begin{file}{scripts/test/testSplit.bbs}
\begin{verbatim}
-load std
load wx
new Slider s1
Right now, there are only \emph{three} layout widgets in the \texttt{wx} package :
\begin{itemize}
-\item {the \texttt{LayoutSplit} widget} we just described, the \texttt{LayoutLine} , and the \texttt{LayoutTab}
-widget.
+\item {the \texttt{LayoutSplit} widget} we just described
-\item {the \texttt{LayoutLine} widget} can have multiple children (Widgeti inputs) and
+\item {the \texttt{LayoutLine} widget} can have multiple children
+(\texttt{Widget1}, \texttt{Widget2},\dots \texttt{Widget9} inputs) and
divides its window into as much parts as children,
each part of equal size.
The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
-%See the example \texttt{example}.
With only those two layout widgets you can already create
-complex dialog boxes (of course layouts can be nested, which leads to tree-like structures of widgets). \\
+complex dialog boxes
+(of course layouts can be nested, which leads to tree-like
+structures of widgets). \\
See the script \texttt{exampleComplexLayoutSplit\_In\_LayoutSplit} for an example.
-\item {The \texttt{LayoutTab} widget} is based on the \texttt{wxNotebook.}\\
-The label of each 'note book' is the name of the object it contains.
+\item {The \texttt{LayoutTab} widget} arranges its children
+in different pages or 'tabs' (\texttt{wxNotebook}-based).
+The label of each page is the name of the widget it contains.
+
\end{itemize}
%the \texttt{Button}... to be continued.
% ==========================================
-\subsubsection{Deeper in the boxes}
+\subsection{Deeper in the boxes}
\label{bbi-deep-box}
% ==========================================
-Any box has three mandatory Inputs :
+\subsubsection{Default and mandatory inputs and outputs}
+\begin{itemize}
+\item Any \texttt{atomic} black box has two default Inputs, which are created by the system :
\begin{itemize}
\item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
- \item {\bf\emph{Boxchange}} : Signals any modification of the box. This output may be connected if necessary to the \emph{BoxExecute}
- input of an other box, further within the execution pipeline.
\item {\bf\emph{BoxProcessMode}} : Sets the processing mode of the box :
\begin{itemize}
\item {\bf\emph{Pipeline}} :% bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
The box executes itself only when an input was changed (normal pipeline processing).
\item {\bf\emph{Reactive}} : %bbSetModifiedStatus() calls bbUpdate() \\
Re-processes immediately when \emph{any input} changes.\\
- To be more selective, better use \texttt{connect A.BoxChange \emph{currentBox}.BoxExecute}.
+ To be more selective, better use
+ '\texttt{connect A.BoxChange B.BoxExecute}'.
\item {\bf\emph{Always}} :% bbUpdate() always calls Process. \\
Usefull for 'sources', that must be processed, even when no input changed (e.g. : FileSelector, ColorSelector)\\
This one is not end user intended (for Package developer only)
\end{itemize}
\end{itemize}
-
-Any widget box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout box} :
+\item And one default output :
\begin{itemize}
- \item {\bf\emph{WinHeight}} : Height of the window
+ \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}
+
+If you create complex boxes, it is a good idea to define those inputs and outputs to be able
+to force the execution of your complex box or be aware of its changes...
+
+\item Any {\bf widget} box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout} box :
+\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{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 :
+
+\begin{itemize}
+ \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, then the box will create its own window (frame or dialog) on execution. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of a \texttt{Layout box},
+ it will be embedded in its parent window.
+\end{itemize}
+
+If you define a complex widget box, it is a good idea to use this standard name for your window output
-Any \emph{Layout box} (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has one or more mandatory Inputs :
+\item Any {\bf Layout} box (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has one or more mandatory Inputs :
\begin{itemize}
\item {\bf\emph{Widget}}\texttt{i} : e.g. a \emph{LayoutSplit} box (Widget which splits a window in two resizeable parts)
has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.\\
e.g. a \emph{LayoutLine} divides the window in up to 9 (depending on the number of inputs \emph{Widget}i) fixed size parts.
\end{itemize}
+If you define a complex layout box, it is a good idea to use these standard names for your
+sub-windows inputs.
-Any widget box has one mandatory Output :
-
-\begin{itemize}
- \item {\bf\emph{Widget}} : that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, it
- will popup. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of any \texttt{Layout box},
- it will be embedded in its parent window.
-
-\end{itemize}
-
+\end{itemize}
% ==========================================
-\subsection{More on ...}
-\label{bbi-more-on}
+%\subsection{More on ...}
+%\label{bbi-more-on}
% ==========================================
% ==========================================
%\item{...} \\
%\end{itemize}
% ==========================================
-\subsubsection{Pipeline processing}
-\label{bbi-more-on-pipeline-processing}
+%\subsubsection{Pipeline processing}
+%\label{bbi-more-on-pipeline-processing}
% ==========================================
-\begin{itemize}
-\item the ``control'' mechanism in bbi.
+%\begin{itemize}
+%\item the ``control'' mechanism in bbi.
-When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
-In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
+%When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
+%In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
%(switch exec commands, e.g. Button)
-\item the role of ProcessMode to update widgets.
-\end{itemize}
+%\item the role of ProcessMode to update widgets.
+%\end{itemize}
%\subsubsection{Advanced issues}
%\paragraph{Reducing the number of inputs of a box}
%\label{bbi-more-on-errors}
% ==========================================
-\subsubsection{Creating and using your own uninstalled version of bbStudio}
-\label{bbi-more-on-your_own_version}
-
-Suppose you want to run your own uninstalled version (say : you downloaded and compiled the
-cvs version in order to use a recently commited patch, but you want to be able
-to still use the standard version).
-
-You have to :
-\begin{itemize}
-\item cvs checkout the sources :
-\begin{verbatim}
-cvs checkout bbtk
-\end{verbatim}
-\item
-create a build directory
-\begin{verbatim}
-mkdir buildBBTK
-\end{verbatim}
-\item cd in the build directory:
-\begin{verbatim}
-cd buildBBTK
-\end{verbatim}
-\item run ccmake.
-\begin{verbatim}
-ccmake ../bbtk
-\end{verbatim}
-
-Don't forget to switch ON the flag \texttt{BBTK\_COMPILE\_DEBUG\_MESSAGE} \\
-(see figure : \ref{bb-ccmake})
-
-\begin{figure}[!ht]
-\caption{\label{bb-ccmake}Running ccmake}
-\begin{center}
-\includegraphics[width=0.6\textwidth]{ccmake.png}
-\end{center}
-\end{figure}
-\item As usual, type \texttt{c} until there is no longer any area quoted with a * (or highlighted in red)\\
-Ask for generation (type \texttt{g} -once is always enough-)
-\item Ask for compilation and link.
-\begin{verbatim}
-make
-\end{verbatim}
-
-
-The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \texttt{bin}
-directory of the built tree.
-
-\item choose to install or not your own version.
-\begin{verbatim}
-make install
-\end{verbatim}
-Linux users : Don't forget to \texttt{sudo} before.
-\end{itemize}
% ==========================================
-
-
+%\vspace{0.5cm}
+\hrule
\newpage
-
-
-
-% ==========================================
-%\vspace{0.5cm}\hrule \\
-
\section{Using third party Package}
\label{Third_Party_Package}
% ==========================================
% ==========================================
\bbStudio makes it easy for you : in the menu \texttt{Tools} just click on the
-option \texttt{Plug Package}. You will be asked to to '\texttt{Select
-package directory}'. Browse untill you find the the install tree, or the the build tree,
-depending whether you installed the package or not.\\
+option \texttt{Plug Package}. You will be asked to '\texttt{Select
+package directory}'. Browse untill you find the install or the build directory,
+depending whether you installed the package or not.
+
+\bbStudio will update the configuration file, generate the 'Package
+documentation', and update the 'Boxes Lists'.
-\bbStudio will update the Configuration file, generate the 'Package
-documentaion', and update the 'Box List'.\\
You will be able to use the new package just as you did for any other \bbtk
canonical Package.
% ==========================================
If the Package you want to use is supplied in a non standard way (e.g. : you
-where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and
-one or more directories containing \bbtk scripts (\texttt{.bbs}), you will have
-to proceed to some (simple) manual operations.\\
-\texttt{Nota bene} : This way is hightly discouraged !
-
-% ==========================================
-\subsubsection{More on the configuration file}
-\label{The_configuration_file}
-% ==========================================
-
-First, have a glance at the Configuration, just clicking on \texttt{Config} button of the \texttt{Command} part toolbar.
-
-You'll get something like :
-
-\begin{verbatim}
-=============
- Configuration
- =============
- bbtk_config.xml : [/home/jpr/Creatis/bbtk/binLIN/bin/bbtk_config.xml]
- Documentation Path : [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/doc]
- Data Path : [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/data]
- Temp Directory : [/home/jpr/Creatis/bbtk/binLIN]
- File Separator : [/]
- BBS Paths
- --- [.]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin/../share/bbtk/bbs]
- --- [/home/jpr/Creatis/bbtk/binLIN/share/bbtk/bbs]
- PACKAGE Paths :
- --- [.]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin/../lib]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin\Debug]
- --- [/home/jpr/Creatis/bbtk/binLIN/bin\Release]
-\end{verbatim}
-
-(depending on who you are, and whether \texttt{bbStudio} is installed or not.)\\
-
-Note the two main parts : \texttt{BBS Paths} and \texttt{PACKAGE Paths}
-\subsubsection{How bbStudio uses the Configuration file}
-\label{How_bbStudio_uses_the_Configuration_file}
-
-
-At start, \bbi tries to open an \texttt{xml}
-configuration file named \texttt{bbtk\_config.xml}.
-The search order is
-\begin{enumerate}
-\item The current directory
-\item The subdir \texttt{.bbtk} of the user's home directory.
-\begin{itemize}
-\item On \texttt{Unix}, the home directory is the
-one stored by the environnement variable \texttt{HOME},
-typically \texttt{/home/username}.
-\item On \texttt{Windows}, the home directory is
-the user's profile directory stored by the environnement
-variable \texttt{USERPROFILE},
-typically \texttt{C:\\...}.
-\end{itemize}
-\item If none of these two paths contains the file then it creates
-a new one in the \texttt{.bbtk} directory.
-\end{enumerate}
-
-
-To use a third party Package, you will have to update it.\\
-
-\subsubsection{Modifying the Configuration file}
-\label{Modifying_the_Configuration_file}
-
-Just use the \texttt{Open bbtk Config file} option of the \texttt{Files} of the \bbStudio menu.
-
-You will get something like :
-\begin{verbatim}
-<config>
- <description> Sets the search directories in the build tree </description>
- <url> </url>
- <bbs_path> /home/jpr/Creatis/bbtk/binLIN/share/bbtk/bbs </bbs_path>
- <package_path> /home/jpr/Creatis/bbtk/binLIN/bin </package_path>
-# For windows
- <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Debug </package_path>
- <package_path> /home/jpr/Creatis/bbtk/binLIN/bin\Release </package_path>
-#
- <data_path> </data_path>
-#
- <default_temp_dir> /home/jpr/Creatis/bbtk/binLIN </default_temp_dir>
-</config>
-\end{verbatim}
-
-To use a new Package :
-\begin{itemize}
-\item {}
-After the already existing \texttt{xml} tags
-\texttt{bbs\_path}
- (i.e. the lines begining by
- \texttt{<bbs\_path>}
- %bbs_path
-and ending by
-\texttt{</bbs\_path>}),
-you can add paths to :
-\begin{itemize}
-\item A custom folder in which to search for \texttt{.bbs} scripts (\texttt{include} command of \bbins) by adding
- an \texttt{xml} tag:\\
- \texttt{<bbs\_path>}
-\emph{complete\_path\_to\_scripts\_folder}
-\texttt{<\/bbs\_path>}.
-\end{itemize}
-
-\item {}
-After the already existing tags
-\texttt{package\_path}
- (i.e. the lines begining by
- \texttt{package\_path}
- %bbs_path
-and ending by
-\texttt{/package\_path}),
-you can add paths to :
-\begin{itemize}
-\item A custom folder in which to search for packages (the dynamic libraries
- (\texttt{.dll} or \texttt{.so}, called with the \texttt{load} command of \bbins) by adding an \texttt{xml} tag :\\
-\texttt{<package\_path>}
-\emph{complete\_path\_to\_dynamic\_library\_folder}
-\texttt{<\/package\_path>}.
-\end{itemize}
-\end{itemize}
-
+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
+paths, see \ref{The_configuration_file}.
%\end{itemize}
% ==========================================
\label{Updating_the_documentation}
% ==========================================
You may add your own boxes (simple boxes, if you are aware enough in \CPP
-language), or complex boxes if you are aware enough in bbtk scripting).
-
-To be able to use the Help tools as well as the features provided by this package,
- you must use the
-option \texttt{Regenerate package doc} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
-You'll be prompted for the Package name. Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
+language, or complex boxes if you are aware enough in bbtk scripting).
-To benefit the features of Box indexing you must use the
-option \texttt{Regenerate Boxes Lists} in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+To update the html help of this package,
+use the option \texttt{Regenerate package doc}
+in the menu \texttt{Tools} of \texttt{bbStudio}.
+You'll be prompted for the Package name.
+Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
+To update html boxes lists with the new boxes,
+use the option \texttt{Regenerate Boxes Lists}
+in the menu \texttt{Tools} of \texttt{bbStudio}.
% ==========================================
\subsection{Using the package}
\label{Using_the_package}
% ==========================================
-The only thing you have to do is to \texttt{load} the package, within the script, or from the
-\texttt{Command} part, and enjoy the black boxes it contains.
+The only thing you have to do is to \texttt{include} or \texttt{load} the package,
+within a script, or from the \texttt{Command} part,
+and enjoy the black boxes it contains.
% ==========================================
-\subsection{Packages you'll probably want to use }
-\label{Packages_you_ll_want_to_use}
+%\subsection{Packages you'll probably want to use }
+%\label{Packages_you_ll_want_to_use}
% ==========================================
-\begin {itemize}
-\item{\texttt{creaLib}} \\
-a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
-packages (an, sure, useful as well for people that doesn't use bbtkns.
-
-\item{\texttt{creaContours}} \\
-Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
-\item{\texttt{creaImageIO}} \\
-Allows browsing, selectionning, ordering directories containing images of almost any type
-(including DICOM)
-\end {itemize}
-
-\newpage
+%\begin {itemize}
+%\item{\texttt{creaLib}} \\
+%a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
+%packages (an, sure, useful as well for people that doesn't use bbtkns.
+%\item{\texttt{creaContours}} \\
+%Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
+%\item{\texttt{creaImageIO}} \\
+%Allows browsing, selectionning, ordering directories containing images of almost any type
+%(including DICOM)
+%\end {itemize}
+%\newpage
% ==========================================
-%\vspace{0.5cm}\hrule \\
+%\vspace{0.5cm}
+\hrule
+\newpage
\section{Using black boxes in \CPP programs}
\label{cpp}
% ==========================================
-A very useful feature is that you may use any black box within a \CPP program without worrying about \texttt{wxWigets} main window.\\
+A very useful feature is that you may use any widget
+black box within a \CPP program
+without worrying about writing a \wx main application.\\
Let's look a the following bbs script :
exec layout
\end{verbatim}
-User wants to create a slider and an output text, within a LayoutLine, and display the slider value in the output text.\\
-Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.\\
+User wants to create a slider and an output text, within a LayoutLine,
+and display the slider value in the output text.
+Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.
-Using the standalone application \texttt{bbc} you just 'convert' the script.
+The following \CPP code does the same :
\begin{verbatim}
+#include <bbtkFactory.h>
#include <bbwxSlider.h>
#include <bbwxOutputText.h>
-#include <bbtkFactory.h>
#include <bbwxLayoutLine.h>
int main(int argv, char* argc[])
{
+ try
+ {
// we need to intanciate a bbtk::Factory to be aware of the adaptors
bbtk::Factory::Pointer factory = bbtk::Factory::New();
// Graphical pipeline
bbtk::Connection::Pointer c1 = bbtk::Connection::New(slider,"Widget",
- layout,"Widget1");
+ layout,"Widget1");
bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
- layout,"Widget2");
+ layout,"Widget2");
// Execution pipeline
// ------------------
// We have to pass the 'factory', in order to call automatically an adaptor,
// if necessary.
bbtk::Connection::Pointer s2t = bbtk::Connection::New(slider,"Out",
- text,"In",
- factory);
- bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
- text,"BoxExecute");
+ text,"In",
+ factory);
+ bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
+ text,"BoxExecute");
layout->bbSetInputWinDialog(true);
// Go!
e.Print();
}
}
-\end{verbatim}
-%\bibliography{all}
+In this code, we use the headers of the \texttt{bbwx} \CPP library,
+which define the black boxes of the \texttt{wx} package.
+
+to be continued ...
+
+\end{verbatim}
% ==========================================
-\section{Language reference}
+\hrule
+\newpage
+\section{\bbs language reference}
\label{bbi-reference}
% ==========================================
-
% ==========================================
\subsection{Pipeline creation and execution related commands}
\label{bbi-reference-creation-execution}
% ==========================================
- See table \ref{bbi-reference-box}
+% See table \ref{bbi-reference-box}
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-box} \bbi pipeline creation and execution related commands.}
+\caption{\label{bbi-reference-box} \bbs pipeline creation and execution related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{new} & \texttt{<boxtype>} \texttt{<box-name>}&
-Creates a box of type \texttt{boxtype} and name
+\texttt{new} & \texttt{<box-type>} \texttt{<box-name>}&
+Creates a box of type \texttt{box-type} and name
\texttt{box-name}.\\ \hline
+\texttt{newgui} & \texttt{<box-name>} \texttt{<gui-box-name>} &
+Automatically creates a graphical user interface with name \texttt{gui-box-name}
+for the black box \texttt{box-name} and connects it to the box inputs\\ \hline
+
\texttt{delete} & \texttt{<box-name>} &
-Destroys the box named \texttt{box-name}.\\ \hline
+Destroys the box named \texttt{box-name}\\ \hline
\texttt{connect} & \texttt{<box1.output>} \texttt{<box2.input>} &
Connects the output
in the packages loaded which converts a \texttt{std::string}
to the type of the input \texttt{input}. \\ \hline
-\texttt{print} & \texttt{<string>} &
-Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
-output \texttt{output} of the box named \texttt{box}.
-An \texttt{adaptor} must exist
-in the packages loaded which converts
-the type of the output \texttt{output}
-to a \texttt{std::string}.
-\\ \hline
-
\texttt{exec} & \texttt{<box-name>} &
Executes the box named \texttt{box-name}.
If needed the boxes
connected to its inputs
are also processed recursively (pipeline processing).\\ \hline
-\texttt{exec} & \texttt{freeze} &
- Allows to block execution commands while keeping definition commands active.(This one is not for end user)\\ \hline
-\texttt{exec} & \texttt{unfreeze} &
- Turns back to 'normal' mode (This one is not for end user).\\ \hline
+& \texttt{freeze} &
+ Allows to block execution commands while keeping definition commands active (this one is not for end user)\\ \hline
+& \texttt{unfreeze} &
+ Turns back to 'normal' mode (this one is not for end user).\\ \hline
\end{tabular}
\end{table}
% ==========================================
\newpage
+% ==========================================
+\subsection{Package related commands}
+\label{bbi-reference-package}
+
+\begin{table}[!ht]
+\caption{\label{tabbbi-reference-interpreter_1}\bbs package related commands. }% (part 1).}
+\small
+\begin{tabular}{|lcm{6cm}|}
+\hline
+Command & Parameters & Effect \\ \hline
+
+
+\texttt{include} & \texttt{<package-name>} &
+Loads the package \texttt{package-name} and includes all its complex box definition scripts. \\ \hline
+
+\texttt{load} & \texttt{<package-name>} &
+Loads the atomic black boxes of package \texttt{package-name}.
+Loads the dynamic library but not the complex boxes defined in the scripts shipped with the package.
+Use it only if you know that you won't work with its complex black boxes \\ \hline
+
+\texttt{unload} & \texttt{<package-name>}&
+Unloads the package \texttt{package-name}.
+The package must have been previously loaded.
+No box of a type defined in this package must still exist.\\ \hline
+
+\texttt{reset} & - & Deletes all boxes and unloads all packages so
+that the interpreter gets back to its initial state \\ \hline
+
+
+\texttt{package} & \texttt{<package-name>} &
+All complex black boxes definitions until the next \texttt{endpackage}
+will be stored into the package \texttt{package-name} \\ \hline
+
+\texttt{endpackage} & - &
+Closes a \texttt{package} command \\ \hline
+
+
+\end{tabular}
+\end{table}
+\newpage
+
% ==========================================
\subsection{Interpreter related commands}
\label{bbi-reference-interpreter}
% ==========================================
-See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
+%See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
% ==========================================
\begin{table}[!ht]
-\caption{\label{tabbbi-reference-interpreter_1}\bbi intepreter related commands (part 1).}
+\caption{\label{tabbbi-reference-interpreter_1}\bbs intepreter related commands. }% (part 1).}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{author} & \texttt{<author-name>} &
-Adds the string \texttt{<author-name>} to the author information of the black box being defined \\ \hline
-
-\texttt{category} & \texttt{<category-name>} &
- Adds the string \texttt{<category-name>} to the category information of the black box being defined \\ \hline
\texttt{help} & - &
Prints help on available commands \\ \hline
\texttt{box-type}.
The box type must belong to a package which has been previously loaded \\ \hline
-& \texttt{<debug-directive>} &
-[expr|-C|-D]
- Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
- \texttt{-C} checks the factory integrity.
- \texttt{-D} turns on objects debug info after main ends\\ \hline
+\texttt{message}
+& - &
+Prints information on available kinds of messages and their current level\\ \hline
+
+ & \texttt{<kind>} \texttt{<level>} &
+Sets the level of verbosity of the interpreter for the kind of messages
+\texttt{kind} to \texttt{level}.\\ \hline
+
\texttt{include} & \texttt{<file-name>} &
Includes and executes the content of the file named \texttt{file-name}
exactly like if you were typing its content at the place were the
\texttt{include} command is. \\ \hline
-\texttt{load} & \texttt{<package-name>} &
-Loads the package \texttt{package-name} (use it only if you know that you won't work with complex black boxes) \\ \hline
-
-\texttt{include} & \texttt{<package-name>} &
-Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline
-
-\texttt{kind} & \texttt{<box kind>} &
-Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline
-\end{tabular}
-\end{table}
+\texttt{print} & \texttt{<string>} &
+Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
+output \texttt{output} of the box named \texttt{box}.
+An \texttt{adaptor} must exist
+in the packages loaded which converts
+the type of the output \texttt{output}
+to a \texttt{std::string}.
+\\ \hline
-%
-% This arbitrary part1/part2 is to avoid to have all the tables at the end of the docoment ...
-%
+\texttt{graph} & ... &
+Generates the html doc including the pipeline graph for a given complex box \\ \hline
-\begin{table}[!ht]
-\caption{\label{tabbbi-reference-interpreter_2}\bbi intepreter related commands (part 2).}
-\small
-\begin{tabular}{|lcm{6cm}|}
-\hline
-Command & Parameters & Effect \\ \hline
-\texttt{unload} & \texttt{<package-name>}&
-Unloads the package \texttt{package-name}.
-The package must have been previously loaded.
-No box of a type defined in this package must still exist.\\ \hline
+\texttt{index} & ... &
+Generates the html index of currently loaded boxes types \\ \hline
-\texttt{message} & \texttt{<category>} \texttt{<level>} &
-Sets the level of verbosity of \bbi for the category of messages
-\texttt{category} to \texttt{level}.\\ \hline
-%See \ref{verbosity}.
+\texttt{config} & - & Displays the configuration parameters\\ \hline
-\texttt{config} & - & Displays the Configuration parameters\\ \hline
-\texttt{reset} & - & Deletes all boxes and unloads all packages so
-that \bbi gets back to its initial state \\ \hline
+\texttt{debug} & \texttt{<debug-directive>} &
+[expr|-C|-D]
+ Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
+ \texttt{-C} checks the factory integrity.
+ \texttt{-D} turns on objects debug info after main ends\\ \hline
-\texttt{quit} & - & Exits the interpreter (Don't use it under \bbStudions)\\ \hline
+\texttt{quit} & - & Exits the interpreter\\ \hline
\end{tabular}
\end{table}
\label{bbi-reference-black-box-definition}
% ==========================================
-See table \ref{bbi-reference-complex-box}
+%See table \ref{bbi-reference-complex-box}
% ==========================================
\begin{table}[!ht]
-\caption{\label{bbi-reference-complex-box} \bbi complex black box definition related commands.}
+\caption{\label{bbi-reference-complex-box} \bbs complex black box definition related commands.}
\small
\begin{tabular}{|lcm{6cm}|}
\hline
Command & Parameters & Effect \\ \hline
-\texttt{define} & \texttt{<box-type>} &
-Starts the definition of a complex black box of type
-\texttt{box-type}\\ \hline
+\texttt{define} & \texttt{<box-type>} [\texttt{<package-name>}] &
+Starts the definition of a complex black box of type
+\texttt{box-type}. If \texttt{<package-name>} is provided then includes the
+box in the given package (otherwise it is defined in the current package,
+i.e. \texttt{user} if outside a \texttt{package/endpackage} block). \\ \hline
\texttt{endefine} & - &
Ends the definition of a complex black box type\\ \hline
\texttt{author} & \texttt{<string>} &
-Sets the author(s) of the complex black box currently being defined \\ \hline
+Concatenate the string to the author string
+of the current complex black box.\\ \hline
\texttt{description} & \texttt{<string>} &
-Sets the description of the complex black box currently being defined \\ \hline
+Concatenate the string to the description of the current complex black box.
+\\ \hline
+
+\texttt{category} & \texttt{<string>} &
+Specifies the \texttt{categories} of the current complex black box.
+The categories must be separated by semicolons, e.g. "\texttt{widget;image}"\\ \hline
+
+\texttt{kind} & \texttt{<box kind>} &
+Specifies the \texttt{kind} of the current complex black box
+( ADAPTOR, DEFAULT\_ADAPTOR, WIDGET\_ADAPTOR, DEFAULT\_WIDGET\_ADAPTOR )\\ \hline
\texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} &
Defines a new input for the current complex black box,
\texttt{<help>} is the help string for the new output.
The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}. \\ \hline
-
\end{tabular}
\end{table}
-% ==========================================
-\newpage
+%\newpage
+Note : if outside a \texttt{define/endefine} block then the current complex black box
+is '\texttt{user::workspace}', that is the main program equivalent
+(this is how applications are documented).
+This remark holds for all complex black box related commands.
+
+
+
+
+
+
+
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+% ==========================================
+%\hrule
+\newpage
\section{Install and run time issues}
+% ==========================================
+
+
+
+
+%%==============================================================================================
+%%==============================================================================================
+\subsection{\bbtk configuration file}
+\label{The_configuration_file}
+%%==============================================================================================
+%%==============================================================================================
+
+At start, \bbtk applications (\bbStudio, \bbi) try
+to open an \texttt{xml}
+configuration file named \texttt{bbtk\_config.xml}.
+The search order is
+\begin{enumerate}
+\item The current directory
+\item The subdir \texttt{.bbtk} of the user's home directory.
+\begin{itemize}
+\item On \texttt{Unix}, the home directory is the
+one stored by the environnement variable \texttt{HOME},
+typically \texttt{/home/username}.
+\item On \texttt{Windows}, the home directory is
+the user's profile directory stored by the environnement
+variable \texttt{USERPROFILE},
+typically \texttt{C:$\backslash$ Documents and Settings$\backslash$ username}.
+\end{itemize}
+\item If none of these two paths contains the file then it creates
+a new one in the \texttt{.bbtk} directory.
+\end{enumerate}
+
+
+Information on \bbtk configuration is
+obtained in \bbStudio by clicking on the
+\texttt{Config} button of the \texttt{Command} part toolbar.
+
+If you did not installed other packages than the ones
+provided by \bbtk, you get something like :
+
+\begin{verbatim}
+ =============
+ Configuration
+ =============
+ bbtk_config.xml : [/home/guigues/.bbtk/bbtk_config.xml]
+ Documentation Path : [/usr/local/bin/../share/bbtk/doc]
+ Data Path : [/usr/local/bin/../share/bbtk/data]
+ Temp Directory : []
+ File Separator : [/]
+ BBS Paths
+ --- [.]
+ --- [/usr/local/bin/../share/bbtk/bbs]
+ PACKAGE Paths :
+ --- [.]
+ --- [/usr/local/bin/../lib]
+\end{verbatim}
+
+The first line let you know which configuration file is currently used.
+
+You can open this file using \bbStudio menu \texttt{Files$>$Open bbtk Config file}.
+
+You will get something like :
+
+\begin{verbatim}
+<?xml version=\"1.0\" encoding=\"iso-8859-1\"?>
+<config>
+ <bbs_path> </bbs_path>
+ <package_path> </package_path>
+</config>
+\end{verbatim}
+
+The \texttt{xml} tags \texttt{bbs\_path} and \texttt{package\_path}
+allow to set additionnal directories in which to search
+for \bbs files and packages dynamic libraries.
+
+For example, if you add the line :
+\begin{verbatim}
+ <bbs_path> /home/guigues/bbs </bbs_path>
+\end{verbatim}
+
+Then the interpreter will search for \bbs in the folder \texttt{/home/guigues/bbs},
+which allows a command like \texttt{'include bbMyBox.bbs'} to work if
+the folder \texttt{/home/guigues/bbs} contains the file \texttt{bbMyBox.bbs}.
+
+The same, the \texttt{xml} tag \texttt{<package\_path>} let you
+set additional path in which to find a package dynamic library,
+hence allowing to load additionnal packages with the \texttt{'load'} command.
+
+All \bbs and package paths are summmarized in the
+information output when pressing 'Config' in \bbStudio.
+You can see that two \bbs paths are always set :
+\begin{itemize}
+\item The current directory (\texttt{.})
+\item The \bbs folder of \bbtk
+\end{itemize}
+Also, two package paths are always set :
+\begin{itemize}
+\item The current directory (\texttt{.})
+\item The libraries folder of \bbtk
+\end{itemize}
+
+Additional paths set in your \texttt{bbtk\_config.xml} are added after those standard paths.
+Note that the order displayed is the one in which the folders are searched when
+\texttt{include} or \texttt{load} commands are issued.
+
+
+%%==============================================================================================
+\subsection{Misc}
\begin {itemize}
-\item{make} \\
-For some strange reasons (?!?), at \texttt{cmake} time, you may be warned that an error occured while documentation generation.\\
-Take it easy, \texttt{make} again!\\
+%\item{make} \\
+%For some strange reasons (?!?), at \texttt{cmake} time,
+%you may be warned that an error occured while documentation generation.\\
+%Take it easy, \texttt{make} again!\\
\item{\bbStudio} is written using the Advanced User Interface library of wxWidgets.
If, after some hazardous floating/docking operations onto the frame, you feel
\end {itemize}
-%\section{Conclusion}
\end{document}
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff