% ---------------------------------------------------------------------
%
% Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
%                        pour la Santé)
% Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
% Previous Authors : Laurent Guigues, Jean-Pierre Roux
% CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
%
%  This software is governed by the CeCILL-B license under French law and 
%  abiding by the rules of distribution of free software. You can  use, 
%  modify and/ or redistribute the software under the terms of the CeCILL-B 
%  license as circulated by CEA, CNRS and INRIA at the following URL 
%  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
%  or in the file LICENSE.txt.
%
%  As a counterpart to the access to the source code and  rights to copy,
%  modify and redistribute granted by the license, users are provided only
%  with a limited warranty  and the software's author,  the holder of the
%  economic rights,  and the successive licensors  have only  limited
%  liability. 
%
%  The fact that you are presently reading this means that you have had
%  knowledge of the CeCILL-B license and that you accept its terms.
% ------------------------------------------------------------------------                                                                          

% ==========================================
\newif\ifpdf 
\ifx\pdfoutput\undefined \pdffalse % we are not running PDFLaTeX 
\else 
\pdfoutput=1 \pdftrue % we are running PDFLaTeX 
\fi
% ==========================================
\usepackage[a4paper,textwidth=14cm]{geometry}
\usepackage[latin1]{inputenc}
\usepackage{varioref}
\usepackage{url}
\usepackage{multicol}
\usepackage{colortbl}
%\usepackage[active]{srcltx}
\usepackage{color}
\usepackage[english]{babel}
%\usepackage{picins}
%\usepackage{fancyhdr}
%\usepackage{picins}
\usepackage{xspace}
% ==========================================
%%% Math
\usepackage{amsmath,amsfonts,amssymb}
\usepackage{bm}
\usepackage{theorem}
\usepackage{stmaryrd}

% ==========================================
%%% Graphics
\usepackage{graphics}
\ifpdf
\usepackage[pdftex]{graphicx} 
\else
\usepackage[ps2pdf]{graphicx} 
\fi
\graphicspath{{figs/}}

% ==========================================
% bib
\usepackage{natbib}
%\bibliographystyle{abbrvnat}
\bibliographystyle{plainnat}

%\bibliographystyle{plain}

% http://merkel.zoneo.net/Latex/natbib.php?lang=fr

% ==========================================
%% PDF configuration 
% http://www.p-joeckel.de/pdflatex/)
% http://ringlord.com/publications/latex-pdf-howto/

%%%% Options of pdflatex
\ifpdf
\DeclareGraphicsExtensions{.pdf,.jpg,.mps,.png,.eps}
\usepackage[pdftex,                %
    bookmarks         = true,%     % Signets
    bookmarksnumbered = true,%     % Signets numÃ©rotÃ©s
    pdfpagemode       = None,%     % Signets/vignettes fermÃ© Ã  l'ouverture
    pdfstartview      = FitH,%     % La page prend toute la largeur
    pdfpagelayout     = SinglePage,% Vue par page
    colorlinks        = true,%     % Liens en couleur
    urlcolor          = magenta,%  % Couleur des liens externes
    pdfborder         = {0 0 0}%   % Style de bordure : ici, pas de bordure
    ]{hyperref}%                   % Utilisation de HyperTeX
%\usepackage[pdftex,bookmarks,pagebackref]{hyperref}
\pdfadjustspacing=1

%%%% Options for latex + dvips -Ppdf + ps2pdf
\else
\DeclareGraphicsExtensions{.eps,.ps}
\usepackage[ps2pdf,bookmarks,pagebackref]{hyperref}
\fi

%%%% Commun options
\hypersetup{
  linktocpage,%
  %%------------- Color Links ------------------------------ 
  colorlinks=true,% 
  linkcolor=myred,%
  citecolor=mydarkblue,% 
  urlcolor=myblue,%
  menucolor=red,%
  %%------------- Doc Info --------------------------------- 
  pdftitle={The Black Box Toolkit},%
  pdfauthor={},%
  %%------------ Doc View ----------------------------------}
  pdfhighlight=/P,%
  bookmarksopen=false,%
  plainpages=false,
  pdfpagemode=None}

\hyperbaseurl{http://www.creatis.insa-lyon.fr/creatools/bbtk}

\definecolor{myblue}{rgb}{0,0,0.7}
\definecolor{myred}{rgb}{0.7,0,0}
\definecolor{mygreen}{rgb}{0,0.7,0}
\definecolor{mydarkblue}{rgb}{0,0,0.5} 

% ==========================================
\def\bbtkVersion{@BBTK_VERSION@}
\def\bbtkVersionDate{@BBTK_VERSION_DATE@}
\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
\def\x{\bm{x}}
\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
\def\bbtk{{\xspace}$\texttt{bbtk}$ }
\def\bbi{{\xspace}$\texttt{bbi}$ }
\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
\def\bbfy{{\xspace}$\texttt{bbfy}$ }
\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
\def\bbPackageBrowser{{\xspace}$\texttt{bbPackageBrowser}$ }
\def\bbCreateBlackBox{{\xspace}$\texttt{bbCreateBlackBox}$ }
\def\bbs{{\xspace}$\texttt{bbs}$ }
\def\bbc{{\xspace}$\texttt{bbc}$ }
\def\bbRegeneratePackageDoc{{\xspace}$\texttt{bbRegeneratePackageDoc}$ }
\def\bbRegenerateBoxesLists{{\xspace}$\texttt{bbRegenerateBoxesLists}$ }
\def\bbPlugPackage{{\xspace}$\texttt{bbPlugPackage}$ }

\def\bb{{\xspace}$\texttt{bb}$ }
%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}

\def\cmake{{\xspace}$\texttt{cmake}$ }

\def\C{{\xspace}$\texttt{C}$ }
\def\CPP{{\xspace}$\texttt{C++}$ }

\def\xml{{\xspace}$\texttt{xml}$ }

\def\itk{{\xspace}$\texttt{itk}$ }
\def\vtk{{\xspace}$\texttt{vtk}$ }
\def\gdcm{{\xspace}$\texttt{gdcm}$ }
\def\gsmis{{\xspace}$\texttt{gsmis}$ }
\def\wx{{\xspace}$\texttt{wxWidgets}$ }

\def\lin{{\xspace}\textit{Linux} }
\def\win{{\xspace}\textit{Windows} }

% the same macros with no space at the end

\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
\def\bbtkns{{\xspace}$\texttt{bbtk}$}
\def\bbins{{\xspace}$\texttt{bbi}$}
\def\bbfyns{{\xspace}$\texttt{bbfy}$}
\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
\def\bbStudions{{\xspace}$\texttt{bbStudio}$}
\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
\def\bbPackageBrowserns{{\xspace}$\texttt{bbPackageBrowser}$}
\def\bbCreateBlackBoxns{{\xspace}$\texttt{bbCreateBlackBox}$}
\def\bbsns{{\xspace}$\texttt{bbs}$}
\def\bbns{{\xspace}$\texttt{bb}$}
\def\bbcns{{\xspace}$\texttt{bbc}$}
%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
\def\bbRegeneratePackageDocns{{\xspace}$\texttt{bbRegeneratePackageDoc}$}
\def\bbRegenerateBoxesListsns{{\xspace}$\texttt{bbRegenerateBoxesLists}$}
\def\bbPlugPackagens{{\xspace}$\texttt{bbPlugPackage}$}


\def\cmakens{{\xspace}$\texttt{cmake}$}

\def\Cns{{\xspace}$\texttt{C}$}
\def\CPPns{{\xspace}$\texttt{C++}$}

\def\xmlns{{\xspace}$\texttt{xml}$}

\def\itkns{{\xspace}$\texttt{itk}$}
\def\vtkns{{\xspace}$\texttt{vtk}$}
\def\gdcmns{{\xspace}$\texttt{gdcm}$}
\def\gsmisns{{\xspace}$\texttt{gsmis}$}
\def\wxns{{\xspace}$\texttt{wxWidgets}$}

\def\linns{{\xspace}\textit{Linux}}
\def\winns{{\xspace}\textit{Windows}}


\def\bbtkGuide [#1]{
\begin{center}
{\Large \BBTK}
\vspace{1cm}

{\Huge #1}
\vspace{1cm}

\bbtk version \bbtkVersion \hspace{2mm}(\bbtkVersionDate)
\vspace{0.5cm}

Generated on : \today 
\vspace{0.5cm}

Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
\vspace{0.3cm}

CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image pour la Sant\'e) \\ 
CNRS UMR 5220, INSERM U620, INSA Lyon, Universit\'e Claude-Bernard Lyon 1

http://www.creatis.insa-lyon.fr/creatools/bbtk 
\end{center}
\tableofcontents
\listoftables
\listoffigures
}

% ==========================================
%%% mode: latex
%%% TeX-master: "bbtkUsersGuide"
%%% End: 

\newcounter{Ctrfile}
%% env
\newenvironment{file}[1]
{
\bigskip\hrule\smallskip
\stepcounter{Ctrfile}
\textbf{File #1}
%\hspace{0.2cm}\arabic{Ctrfile}\hfill \textbf{#1}
\smallskip\hrule\medskip
%\algocaption{#1}
}
{
\hrule\smallskip
\hfill\textbf{End of file}
\smallskip\hrule
\bigskip
}
