]> Creatis software - bbtk.git/blob - kernel/doc/bbtkUsersGuide/bbtkReferenceManual.tex
56a71c500226f5dcb1a280ae2f164b6895d0f8ab
[bbtk.git] / kernel / doc / bbtkUsersGuide / bbtkReferenceManual.tex
1 % ==========================================
2 \documentclass[11pt,final,a4paper]{article}
3 \input{config.tex}
4
5
6
7
8 \begin{document}
9 \begin{center}
10
11 {\Large \BBTK}
12 \vspace{1cm}
13
14 {\Huge Reference Manual}
15 \vspace{1cm}
16
17 \bbtk version \bbtkVersion
18 \vspace{0.5cm}
19
20
21 Last modified on : September 20, 2008 \\
22 Generated on : \today 
23 \vspace{0.5cm}
24
25 Fantomas, Belphegor
26 \end{center}
27
28 % ==========================================
29 \tableofcontents
30 % ==========================================
31
32 \listoftables
33
34 \listoffigures
35
36
37
38 % ==========================================
39 %\section*{Abstract}
40 % ==========================================
41 \newpage
42 % ==========================================
43 \hrule
44
45
46 \begin{verbatim}
47 ---> Should be moved in a 'Reference Manual' ?\\
48 ---> Any suggestion welcome!
49
50 --> The following is just the concatenation of various parts, removed from different 'manuals', and wainting for
51 their new affectation.
52 \end{verbatim}
53
54 \section{aaa}
55 \subsection{bbb}
56
57 \begin{table}[!ht]
58 \caption{\label{kinds} \texttt{Black Box} kinds}
59 \small
60 \begin{tabular}{|ll|}
61 \hline
62 \texttt{Kind name}                & : Meaning                         \\ \hline \\ \hline
63 \texttt{ADAPTOR}                  & : Adaptor Box                     \\ \hline
64 \texttt{DEFAULT\_ADAPTOR}         & :                                  \\ \hline
65 \texttt{WIDGET\_ADAPTOR}          & :                                  \\ \hline
66 \texttt{DEFAULT\_WIDGET\_ADAPTOR} & :                                  \\ \hline
67 \texttt{GUI}                      & :                                  \\ \hline
68 \texttt{DEFAULT\_GUI}             & :                                  \\ \hline
69 \texttt{ALL}                      & : If kind='ALL' then sets the level for all kinds \\ \hline
70 \end{tabular}
71 \end{table}
72
73
74
75         
76    \bf\emph{Boxes} : Box retrieving on various criterions :
77       \begin{itemize}
78         \item {\bf\emph{By name}} (Alphabetical list)
79         \item {\bf\emph{By package}} (see table : \ref{bbi-list_of_packages})
80         \item {\bf\emph{By category}} (see table : \ref{categories})
81         \item {\bf\emph{Adaptors}} Used internaly to perform type conversions (not end user intended)     
82       \end{itemize}
83
84
85
86 % ==========================================
87 \begin{table}[!ht]
88 \caption{\label{bbi-list_of_packages} List of bbtk supplied packages.}
89 \small
90 \begin{tabular}{|lp{10cm}|}
91 \hline
92 Package         & What it's used for \\ \hline
93 \texttt{std}    & : the 'standard' package including basic useful boxes \\ \hline 
94 \texttt{wx}     & : basic graphical interface elements (widgets : sliders, buttons, etc.) based on the \texttt{wxWidgets} library \\ \hline 
95 \itk    & : the basic image processing package, based on the \itk library. (without description)\\ \hline 
96 \vtk    & : prints help on the package \texttt{package-name} and its boxes (with brief description). The package must have been previously loaded\\ \hline 
97 \texttt{wxvtk}  & : widget boxes based on the \vtk library.\\ \hline 
98 \texttt{itkvtk} & : adaptors to convert \itk structures into \vtk structures and conversally.\\ \hline 
99 %\texttt{creaImageIO} & : provides high level widgets to read images including DICOM.\\ \hline 
100 \texttt{toolsbbtk} & : Tools for bbtk administration and package development.\\ \hline 
101
102 \end{tabular}
103 \end{table}
104 % ==========================================
105
106
107
108 % ==========================================
109 \begin{table}[!ht]
110 \caption{\label{categories} \texttt{Black Box} categories}
111 \small
112 \begin{tabular}{|lp{10cm}|}
113 \hline
114  \texttt{Category name}  & : Meaning                                          \\ \hline \\ \hline
115  \texttt{adaptor}        & : Adaptor box                                      \\ \hline
116  \texttt{application}    & : Final application, end user intended             \\ \hline
117  \texttt{atomic box}     & : System category.
118                Automatically assigned to Atomic Black Boxes (c++ defined)     \\ \hline
119  \texttt{complex box}    & : System category.
120                Automatically assigned to Complex Black Boxes (script defined) \\ \hline  
121  \texttt{command line}   & : Script which defines a command line application \\ 
122                          & :(no embedded GUI, but command line imput parameters) \\ \hline
123  \texttt{demo}           & : Demonstration                             \\ \hline
124  \texttt{devel}          & : Developer tool (bbCreatePackage.bbs, ...) \\ \hline
125  \texttt{dicom}          & : DICOM aware box                            \\ \hline 
126  \texttt{example}        & : Example script showing a box use-case      \\ \hline
127  \texttt{filter}         & : Image processing box                       \\ \hline
128  \texttt{image}          & : Image processing related box               \\ \hline
129  \texttt{interaction}    & :                                            \\ \hline
130  \texttt{math}           & : Mathematical operations                    \\ \hline
131  \texttt{mesh}           & : Mesh processing related box                 \\ \hline
132  \texttt{misc}           & : Box that cannot be put in any other category ! \\ \hline
133  \texttt{read/write}     & : Box that read or write data from or to disk  \\ \hline
134  \texttt{viewer}         & : Box which displays some data                \\ \hline
135  \texttt{widget}         & : Piece of graphical interface                \\ \hline  
136  \texttt{3D object creator} & : Sophisticated 3D widget  \\ \hline  
137  \texttt{toolsbbtk}         & : Component of bbStudio    \\ \hline  
138 \end{tabular}
139 \end{table}
140
141 % ==========================================
142
143
144
145 % ==========================================
146 \subsubsection{complex black box definition related commands}
147 \label{bbi-reference-black-box-definition}
148 % ==========================================
149
150 See table \ref{bbi-reference-complex-box} 
151 % ==========================================
152 \begin{table}[!ht]
153 \caption{\label{bbi-reference-complex-box} \bbi complex black box definition related commands.}
154 \small
155 \begin{tabular}{|lcm{6cm}|}
156 \hline
157 Command & Parameters & Effect \\ \hline
158
159
160 \texttt{define} & \texttt{<box-type>} & 
161 Starts the definition of a complex black box of type  
162 \texttt{box-type}\\ \hline 
163
164 \texttt{endefine} & - & 
165 Ends the definition of a complex black box type\\ \hline 
166
167 \texttt{author} & \texttt{<string>} & 
168 Sets the author(s) of the complex black box currently being defined \\ \hline 
169
170 \texttt{description} & \texttt{<string>} & 
171 Sets the description of the complex black box currently being defined \\ \hline 
172
173 \texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} & 
174 Defines a new input for the current complex black box, 
175 named \texttt{name}. 
176 It is defined as corresponding to 
177 the input \texttt{input} of the box \texttt{box}.
178  
179 \texttt{<help>} is the help string for the new input.
180 The box \texttt{box} must already have been created in the complex box 
181 and of course have an input named \texttt{input}.\\ \hline 
182
183 \texttt{output} & \texttt{<name>} \texttt{<box.output>} \texttt{<help>} & 
184 Defines a new output for the current complex black box, 
185 named \texttt{name}. 
186 It is defined as corresponding to 
187 the output \texttt{output} of the box \texttt{box}. 
188 \texttt{<help>} is the help string for the new output.
189 The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}. \\ \hline 
190
191
192 \end{tabular}
193 \end{table}
194
195 % ==========================================
196 \subsubsection{Interpreter related commands}
197 \label{bbi-reference-interpreter}
198 % ==========================================
199 See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
200 % ==========================================
201 \begin{table}[!ht]
202 \caption{\label{tabbbi-reference-interpreter_1}\bbi intepreter related commands (part 1).}
203 \small
204 \begin{tabular}{|lcm{6cm}|}
205 \hline
206 Command & Parameters & Effect \\ \hline
207
208 \texttt{author} &  \texttt{<author-name>} & 
209 Adds the string \texttt{<author-name>} to the author information of the black box being defined \\ \hline 
210
211 \texttt{category} & \texttt{<category-name>} & 
212   Adds the string \texttt{<category-name>} to the category information of the black box being defined \\ \hline 
213
214 \texttt{help} & - & 
215 Prints help on available commands \\ \hline 
216
217 & \texttt{<command-name>} & 
218 Prints help on the command \texttt{command-name} \\ \hline 
219
220 & \texttt{packages} & 
221 Prints help on available packages and their box types 
222 (without description)\\ \hline 
223
224 & \texttt{<package-name>} & 
225 Prints help on the package \texttt{package-name} and its boxes 
226 (with brief description). 
227 The package must have been previously loaded \\ \hline 
228
229 & \texttt{<box-type>} & 
230 Prints help (with full description) on the type of box 
231 \texttt{box-type}. 
232 The box type must belong to a package which has been previously loaded \\ \hline 
233
234 & \texttt{<debug-directive>} & 
235 [expr|-C|-D] 
236   Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr=''). 
237          \texttt{-C} checks the factory integrity.
238          \texttt{-D} turns on objects debug info after main ends\\ \hline 
239
240 \texttt{include} & \texttt{<file-name>} & 
241 Includes and executes the content of the file named \texttt{file-name} 
242 exactly like if you were typing its content at the place were the 
243 \texttt{include} command is. \\ \hline 
244
245 \texttt{load} & \texttt{<package-name>} & 
246 Loads the package \texttt{package-name} (use it only if you know that you won't work with complex black boxes) \\ \hline 
247
248 \texttt{include} & \texttt{<package-name>} & 
249 Loads the package \texttt{package-name} and includes all the complex black boxes that comes with it \\ \hline 
250
251 \texttt{kind} & \texttt{<box kind>} & 
252 Specifies the \texttt{kind} of the complex black boxes you are describing \\ \hline 
253 \end{tabular}
254 \end{table}
255
256
257
258 %
259 % This arbitrary part1/part2 is to avoid to have all the tables at the end of the docoment ...
260 %
261
262 \begin{table}[!ht]
263 \caption{\label{tabbbi-reference-interpreter_2}\bbi intepreter related commands (part 2).}
264 \small
265 \begin{tabular}{|lcm{6cm}|}
266 \hline
267 Command & Parameters & Effect \\ \hline
268 \texttt{unload} & \texttt{<package-name>}& 
269 Unloads the package \texttt{package-name}. 
270 The package must have been previously loaded. 
271 No box of a type defined in this package must still exist.\\ \hline 
272
273 \texttt{message} & \texttt{<category>} \texttt{<level>} & 
274 Sets the level of verbosity of \bbi for the category of messages 
275 \texttt{category} to \texttt{level}.\\ \hline 
276 %See \ref{verbosity}.
277
278 \texttt{config} & - & Displays the Configuration parameters\\ \hline 
279
280 \texttt{reset} & - & Deletes all boxes and unloads all packages so 
281 that \bbi gets back to its initial state \\ \hline 
282
283 \texttt{quit} & - & Exits the interpreter (Don't use it under \bbStudions)\\ \hline 
284
285 \end{tabular}
286 \end{table}
287
288
289 \subsection{ccc}
290
291 \begin{verbatim}
292 ---> Should be moved in a 'Reference Manual' ?\\
293 ---> Any suggestion welcome!
294 \end{verbatim}
295
296 % ==========================================
297 \subsubsection{Black box packages}
298 \label{bbi-more-on-packages}
299 % ==========================================
300
301 There are various others user-intended packages :
302 \begin{itemize}
303 \item{vtk} \\
304 It contains some vtk based image processing filters :
305 %   \begin{enumerate}
306
307      \paragraph{AppendPolyData}
308      Appends one of more polygonal datasets into a single polygonal dataset 
309
310      \paragraph{ConeSource}
311      Creates a Cone 
312
313      \paragraph{ImageAnisotropicDiffusion3D}
314 vtk\-Image\-Anisotropic\-Diffusion\-3D dif\-fuses a volume iteratively. \\
315 The neighborhood of the diffusion is determined by the instance flags. \\
316 if 'Faces' is on, the 6 voxels adjoined by faces are included in the neighborhood. \\
317 If 'Edges' is on the 12 edge connected voxels are included, and if 'Corners' is on, the 8 corner connected voxels are included. \\
318 'DiffusionFactor' determines how far a pixel value moves toward its neighbors, and is insensitive to the number of neighbors chosen.\\ 
319 The diffusion is anisotropic because it only occurs when a gradient measure is below 'GradientThreshold'. \\
320 Two gradient measures exist and are toggled by the 'GradientMagnitudeThreshold' flag. \\
321 When 'GradientMagnitudeThreshold' is on, the magnitude of the gradient, computed by central differences, above 'DiffusionThreshold' a voxel is not
322 modified. \\
323 The alternative measure examines each neighbor independently.\\ 
324 The gradient between the voxel and the neighbor must be below the 'DiffusionThreshold' for diffusion to occur with THAT neighbor.\\
325      Receives : \\
326      - In : an image (vtkImageData*)\\
327      - Diffusion : Difference threshold that stops the diffusion\\
328      Outputs : \\
329      - Out : the isosurface mesh (vtkPolyData*)
330      
331      \paragraph{ImageCharacteristics}
332      Exports objet sizes, and Spacings
333      
334      \paragraph{ImageDilateErode3D}
335
336      Dilates one value and erodes another.\\ 
337      vtkImageDilateErode3D will dilate one value and erode another. \\
338      It uses an elliptical foot print, and only erodes/dilates on the boundary of the two values. \\
339      The filter is restricted to the X, Y, and Z axes for now.\\ 
340      It can degenerate to a 2 or 1 dimensional filter by setting the kernel size to 1 for a specific axis. \\
341      (bbfication of vtkImageDilateErode3D) \\
342      Receives : \\
343      - In : an image (vtkImageData*)\\
344      - DilateValue : The dilatation value\\
345      - ErodeValue : The erosion value\\
346      Outputs : \\
347      - Out : the isosurface mesh (vtkPolyData*)     
348      
349      \paragraph{ImageGaussianSmooth}
350      Performs a gaussian convolution of the input image\\
351      Receives : \\
352      - In : an image (vtkImageData*)\\
353      - StdDevX : Standard deviation in X direction\\
354      - StdDevY : Standard deviation in Y direction\\
355      Outputs : \\
356      - Out : the isosurface mesh (vtkPolyData*)       
357      
358      \paragraph{ImagePlanes}
359      Creates three 3D planes with the input image mapped onto with which the user can interact; \\ 
360      The output vtkImagePlaneWidget objects are to be inserted into a 3D scene (e.g. a Viewer3D)
361      Receives : \\
362      - In : an image (vtkImageData*)\\
363      Outputs : \\     
364      - PlaneX : the image plane in X direction (vtkImagePlaneWidget*)\\
365      - PlaneY : the image plane in Y direction (vtkImagePlaneWidget*)\\
366      - PlaneY : the image plane in Z direction (vtkImagePlaneWidget*)\\
367      
368           Outputs : \\
369      - Out : the isosurface mesh (vtkPolyData*)  
370            
371      \paragraph{IsoSurfaceExtractor}
372      Extracts an iso-surface of a 3D image and creates a vtkProp3D object to insert into a 3D scene (e.g. a Viewer3D)
373      Receives : \\
374      - In : an image (vtkImageData*)\\
375      - Isovalue : the isosurface value (double)\\
376      - Colour : Surface colour (vector of 3 doubles)
377      Outputs : \\
378      - Out : the isosurface (vtkProp3D**)
379      
380       \paragraph{MIPCreator}     
381      Creates a Maximum Intensity Projection (MIP) view of a 3D image.\\
382      Receives : \\
383      - In : an image (vtkImageData*)\\
384      - Scale : the Gray scale scaling (float) \\
385      - Shift : the Gray scale shift (float) \\    
386      Ouputs : \\
387      - Out : The MIP object (vtkProp3D*) to be plugged into a 3D Viever
388     
389      \paragraph{MarchingCubes}
390      Extracts an iso-surface of an image using the marching cubes algorithm (bbfication of vtkMarchingCubes)\\
391      Receives : \\
392      - In : an image (vtkImageData*)\\
393      - Value : the isosurface value (double)\\
394      Outputs : \\
395      - Out : the isosurface mesh (vtkPolyData*)
396
397      \paragraph{MetaImageReader}
398      Reads .mhd / .mhd image formats (bbfication of vtkMetaImageReader) \\
399      Receives : \\
400      - In : the name of the file to be read (std::string)
401      Outputs :
402      - Out : The image (vtkImageData*)     
403      
404      \paragraph{SegmentationConnectivity}
405      Segmentation with min max threshold and connectivity  \\  
406      Receives : \\
407      - In : an image (vtkImageData*)\\
408      - PositionXYZ : initial position (std::vector<int>) \\
409      - ThresholdMinMax : min, max threshold values (std::vector<int>) \\
410      Outputs : \\
411      - Out : The image (vtkImageData*)       
412           
413      \paragraph{SphereSource}
414      Creates a Sphere      
415 %   \end{enumerate}
416
417 \item{itk} \\
418 It contains some itk based image processing filters :
419  
420      \paragraph{BinaryThresholdImageFilter}
421      Binarizes an image by thresholding (generic bbification of itk::BinaryThresholdImageFilter) 
422      Receives : \\ 
423
424       - In :             Input image. Can be any itk::Image<T,D>*    \\
425       - InsideValue :    Output value for pixels inside thresholds (Double)    \\
426       - LowerThreshold :   Lower threshold(Double)    \\
427       - OutsideValue   :   Output value for pixels outside thresholds (Double)    \\
428       - UpperThreshold :   Upper threshold (Double)    \\
429       Outputs :     \\
430       - Out'        : Output image. Of the same type and dimension than the input image
431      
432      \paragraph{DICOMSeriesFileNames}
433      Reads a series from a DICOM directory as a 3D itk image     
434
435      \paragraph{ExtractImageFilter}
436      Decrease the image size by cropping the image to the selected region bounds (bbification of itk::ExtractImageFilter)     
437
438      \paragraph{ImageProperties}
439      Outputs different properties of an image (type, dimension, size, spacing, ...)      
440
441      \paragraph{ImageRegion}
442 Creates a generic ImageRegion (bbtk::any) from two vectors providing the index and size of the region. 
443 The dimension D of the actual itk::ImageRegion created is the max of the sizes of Index and Size 
444 (the smallest vector is padded by zeros)     
445
446      \paragraph{ImageReader}
447 Generic itk image reader
448
449      \paragraph{ImageWriter}
450 Generic itk image writer
451
452      \paragraph{ImageSeriesReader}
453 Generic itk image series reader.
454
455      \paragraph{ResampleImageFilter}
456 Resamples an image
457
458 \item{itkvtk} \\
459 It doesn't contain any end user intended box, only adaptors : to convert a generic itkImage to a vtkImageData, and vtkImageData* to a generic itkImage pointer 
460
461 Sorry nothing is done, right now for meshes. 
462
463 \item{wxvtk} \\
464
465 It contains two atomic black boxes.
466
467      \paragraph{Viewer2D} 
468      Receives : \\
469      - a \textless vtkImageData* \textgreater (In),\\
470      - an Orientation(0:yz / 1:xz / 2:xy),\\
471      - an initial slice number (Slice).\\
472      Outputs :\\
473      - a \textless vtkRenderer* \textgreater (Renderer)
474      
475      \paragraph{Viewer3D} 
476      Receives :\\
477      - up to 5 Input Actors (\textless vtkProp3D* \textgreater),\\
478      - up to 5 Input Observers (\textless vtkInteractorObserver* \textgreater), \\
479      - a boolean 'Stereo' option, to use Red-Blue filter     
480      Outputs :\\
481      - an Interactor (\textless wxVTKRenderWindowInteractor* \textgreater) with which vtk widgets can interact, \\
482      - a Renderer (\textless vtkRenderer* \textgreater) to which actors can be added.
483
484 It contains too some sophisticated complex black boxes :
485  
486      \paragraph{IsoSurfaceWithControls} 
487      Image iso-surface extractor (vtk::IsoSurfaceExtractor) with associated control panel (isovalue, opacity and colour)\\
488      Receives :\\
489      - an initial isovalue (Isovalue)
490      - an initial opacity  (Opacity)
491      - an initial colour   (Colour)
492      Outputs :\\
493      \textless vtkProp3D* \textgreater (In)\\
494       
495      \paragraph{MIPWithControls}     
496      Maximum Intensity Projection (MIP) creator (vtk::MIPCreator) with associated control panel (shift and scale) \\
497     Receives :\\
498      - an initial scale (Scale)
499      - an initial shift  (Shift) 
500      Outputs :\\
501      \textless vtkProp3D* \textgreater (In)\\
502          
503 \item{wx} \\
504
505 Some boxes are the bbfication of usefull xwWidgets, some other ones are more
506 sophisticated.
507
508     \paragraph{ColourSelector} Colour Selector dialog (bbfication of wxColourSelector) \\
509                         %\begin{verbatim}
510          \texttt{Out} : Colour choosen in format '[0,1] [0,1] [0,1]' 
511                         %\end{verbatim}
512
513     \paragraph{ColourSelectorButton} A button which displays a colour picker dialog when clicked \\
514                         %\begin{verbatim}
515           \texttt{In} :Initial colour \\
516           \texttt{Out} : Colour choosen in format '[0,1] [0,1] [0,1]'
517                         %\end{verbatim} \\
518
519     \paragraph{CommandButton} Button which executes bbi commands \\
520                         %\begin{verbatim}
521           \texttt{In} : Commands to be executed separated by commas (;). Each single quote (') is replaced by a double quote ("). \\
522           \texttt{Label} : Label of the button  \\
523           \texttt{Widget} : Output widget \\
524                         %\end{verbatim}
525
526     \paragraph{DirectorySelector} Pops up a directory selection dialog (wxDirDialog)\\
527                         %\begin{verbatim}
528           \texttt{DefaultDir} : The default directory\\
529           \texttt{Message} : Message to show on the dialog \\
530           \texttt{Title} : Title of the dialog \\
531           \texttt{Out} : The directory selected by the user\\
532                         %\end{verbatim}
533  
534     \paragraph{FileSelector} Pops up a file selection dialog for reading or saving (wxFileDialog)\\
535                         %\begin{verbatim}
536           \texttt{DefaultDir} : The default directory \\
537           \texttt{DefaultFile} : The default filename \\
538           \texttt{Message} : Message to show on the dialog \\
539           \texttt{OpenSave} : Open for an open dialog (default) / Save for a save dialog\\ 
540           \texttt{Title} : Title of the dialog \\
541           \texttt{Wildcard} : A wildcard, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" \\
542           \texttt{Out} : The file selected by the user \\
543                         %\end{verbatim}
544
545     \paragraph{InputText} A zone in which the user can enter a text (wxTextCtrl)\\
546                         %\begin{verbatim}
547           \texttt{In} : Initial text (default '')\\ 
548           \texttt{Title} : Title of the input zone (default '')\\ 
549           \texttt{WinTitle} : Title of the window (*)\\
550           \texttt{Out} :Current text\\
551                         %\end{verbatim}
552
553     \paragraph{LayoutLine} LayoutLine widget (wxBoxSizer)\\
554                         %\begin{verbatim}
555           \texttt{Orientation} Orientation (default V), 0=H=HORIZONTAL , 1=V=VERTICAL \\
556           \texttt{Widget}1 widget 1 \\
557           \texttt{Widget2} widget 2 \\
558           \texttt{Widget3} widget 3 \\
559           \texttt{Widget4} widget 4 \\
560           \texttt{Widget5} widget 5 \\
561           \texttt{Widget6} widget 6 \\
562           \texttt{Widget7} widget 7 \\
563           \texttt{Widget8} widget 8 \\
564           \texttt{Widget9} widget 9\\
565           %\end{verbatim}    
566     
567     \paragraph{LayoutSplit} Widget which splits a window in two fixed size parts (wxSplitterWindow)\\ 
568                         %\begin{verbatim}
569           \texttt{Orientation} : Orientation (default H), 0=H=HORIZONTAL , 1=V=VERTICAL\\ 
570           \texttt{Proportion} : Proportion (in percent) of the first children in the window\\ 
571           \texttt{Widget1} : Upper or left widget\\ 
572           \texttt{Widget2} : Lower or right widget\\
573                         %\end{verbatim}
574
575     \paragraph{LayoutTDown} Creates a 'T like' complex container : Down {UpLeft, UpRight} \\
576                         %\begin{verbatim}
577           \texttt{Widget1} : UpLeft container\\
578           \texttt{Widget2} : UpRight container\\ 
579           \texttt{Widget3} : Down container\\
580                         \begin{verbatim}
581 //                       ---------------
582 //                       |      |      |
583 //                       |  W1  |  W2  |
584 //                       |-------------|
585 //                       |             |
586 //                       |     W3      |
587 //                       ---------------
588                         \end{verbatim}
589    
590     \paragraph{LayoutTLeft} Creates a 'T like' complex container :  Left {RigthUp, RightDown}\\
591                         %\begin{verbatim}
592            \texttt{input}  Widget1 : "UpLeft container"  \\ 
593            \texttt{input}  Widget2 : "UpRight container" \\  
594            \texttt{input}  Wigdet3 : "Down container"    \\ 
595                         \begin{verbatim} 
596 //                       ---------------
597 //                       |      |  W2  |
598 //                       |  W1  |      |
599 //                       |      |------|
600 //                       |      |  W3  |
601 //                       |      |      |
602 //                       ---------------   
603                         \end{verbatim}
604
605     \paragraph{LayoutTRight} Creates a 'T like' complex container : Right {LeftUp, LeftDown}\\
606                         %\begin{verbatim}
607           \texttt{input} Widget1 currentBox.Widget1 "Up container"       \\
608           \texttt{input} Widget2 down.Widget1       "DownLeft container" \\ 
609           \texttt{input} Widget3 down.Widget2       "DownRight container"\\    
610                         \begin{verbatim}  
611 //                       ---------------
612 //                       |      |      |
613 //                       |  W1  |      |
614 //                       |------|  W2  |
615 //                       |  W3  |      |
616 //                       |      |      |
617 //                       ---------------
618                         \end{verbatim}
619   
620     \paragraph{LayoutTUp} Creates a 'T like' complex container : Up {DownLeft, DownRight} as w1{w2,w3}\\ 
621                         %\begin{verbatim} 
622           \texttt{ input} Widget1 currentBox.Widget1 "Up"       \\
623           \texttt{input} Widget2 down.Widget1        "DownLeft" \\ 
624           \texttt{input} Widget3 down.Widget2        "DownRight"\\
625      
626 //             \begin{verbatim}
627 //                       ----------------
628 //                       |    W1        |
629 //                       |              |
630 //                       |------|-------|
631 //                       | W3   |  W2   |
632 //                       |      |       |
633 //                       ----------------
634                 \end{verbatim}
635                           
636     \paragraph{LayoutTab} LayoutTab widget (wxNotebook)\\
637                         %\begin{verbatim}
638           \texttt{Orientation} Orientation (default T), 0=T=TOP , 1=R=RIGHT , 2=B=BOTTON , 3=L=LEFT \\
639           \texttt{Widget1} widget 1 \\
640           \texttt{Widget2} widget 2 \\
641           \texttt{Widget3} widget 3 \\
642           \texttt{Widget4} widget 4 \\
643           \texttt{Widget5} widget 5 \\
644           \texttt{Widget6} widget 6 \\
645           \texttt{Widget7} widget 7 \\
646           \texttt{Widget8} widget 8 \\
647           \texttt{Widget9} widget 9 \\   
648 %\end{verbatim}
649    
650     \paragraph{OutputText}              Text zone to be inserted into a window (wxStaticText)\\
651                         %\begin{verbatim}
652           \texttt{In} Text \\
653           \texttt{Title} Title prepended to the text\\   
654                         %\end{verbatim}
655                            
656     \paragraph{RadioButton}             RadioButton group widget 0-9 entries\\
657                         %\begin{verbatim}
658           \texttt{In} Set initial item \\
659           \texttt{In0} option 0\\ 
660           \texttt{In1} option 1\\ 
661           \texttt{In2} option 2\\ 
662           \texttt{In3} option 3\\ 
663           \texttt{In4} option 4\\ 
664           \texttt{In5} option 5 \\
665           \texttt{In6} option 6 \\
666           \texttt{In7} option 7 \\
667           \texttt{In8} option 8 \\
668           \texttt{In9} option 9 \\
669           \texttt{Title} Title of the widget (default '')\\ 
670           \texttt{Out} Number of the selected Item 
671                         %\end{verbatim}
672                            
673     \paragraph{Slider}          Slider widget (wxSlider)\\
674                         %\begin{verbatim}
675           \texttt{ChangeResolution} Enables the user to change the slider resolution (default FALSE) \\
676           \texttt{In} Initial slider position(default 0) \\
677           \texttt{Label} Show slider labels ? (default FALSE) \\
678           \texttt{Max} Maximum value of the slider (default 500)\\ 
679           \texttt{Min} Minimum value of the slider (default 0)\\ 
680           \texttt{Orientation} Orientation : (default H) 0=H=HORIZONTAL, 1=V=VERTICAL\\ 
681           \texttt{ReactiveOnTrack} Slider sends info when track moves (default 0 = no)\\ 
682           \texttt{Title} Title shown above the slider (default '')\\     
683                         %\end{verbatim}
684 \end{itemize}
685
686
687 %\bibliography{all}
688
689
690
691 %\section{Conclusion}
692
693
694 \end{document}