SoftwareGuide.tex 6.03 KB
Newer Older
OTB Bot's avatar
OTB Bot committed
1 2 3 4 5 6 7 8 9 10 11 12 13
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Complete documentation on the extended LaTeX markup used for Insight
% documentation is available in ``Documenting Insight'', that is part
% of the standard documentation for Insight.  It may be found online
% at:
%
%                    http://www.itk.org
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass{InsightSoftwareGuide}

Jordi Inglada's avatar
Jordi Inglada committed
14

OTB Bot's avatar
OTB Bot committed
15
\usepackage[dvips]{graphicx}
16
\usepackage{times,lscape,url}
Jordi Inglada's avatar
Jordi Inglada committed
17
%\usepackage{mdwtab}
OTB Bot's avatar
OTB Bot committed
18

Jordi Inglada's avatar
Jordi Inglada committed
19

Thomas Feuvrier's avatar
Thomas Feuvrier committed
20
%%% \usepackage[latin1]{inputenc}
OTB Bot's avatar
OTB Bot committed
21
%%% \selectlanguage{french}
22
% Configuration pour les accents francais pour l'OTB
23
\usepackage[latin1]{inputenc}
24
%\usepackage[french]{babel}
Jordi Inglada's avatar
Jordi Inglada committed
25
\usepackage{tikz}
Thomas Feuvrier's avatar
Thomas Feuvrier committed
26

27 28 29 30 31 32 33 34
\usepackage{color}

\definecolor{listcomment}{rgb}{0.0,0.5,0.0}
\definecolor{listkeyword}{rgb}{0.0,0.0,0.5}
\definecolor{listnumbers}{gray}{0.65}
\definecolor{listlightgray}{gray}{0.955}
\definecolor{listwhite}{gray}{1.0}

35
\usepackage{minted}
36 37 38 39 40 41 42
\newminted{cpp}{fontsize=\small}
\newminted{cmake}{fontsize=\small}
\newminted{bat}{fontsize=\small}

\usepackage{mdframed}
\BeforeBeginEnvironment{cppcode}{\begin{mdframed}[leftline=false,rightline=false,backgroundcolor=listlightgray]}
\AfterEndEnvironment{cppcode}{\end{mdframed}}
43

OTB Bot's avatar
OTB Bot committed
44 45 46 47 48 49 50 51
\newif\ifitkFullVersion
\itkFullVersiontrue
%\itkFullVersionfalse

\newif\ifitkPrintedVersion
\itkPrintedVersiontrue
%\itkPrintedVersionfalse

52
\usepackage{multicol}
OTB Bot's avatar
OTB Bot committed
53 54 55 56 57 58 59 60

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%  hyperref should be the last package to be loaded.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifitkPrintedVersion
\usepackage[dvips,
61 62 63
pdftitle={OTB Software Guide},
pdfauthor={CNES},
pdfsubject={Remote Sensing, Orfeo, Pleiades, Cosmo Skymed},
64
pdfkeywords={Image processing, Remote sensing, Guide},
OTB Bot's avatar
OTB Bot committed
65 66 67 68 69 70 71 72
pdfpagemode={UseOutlines},
bookmarks,bookmarksopen,
pdfstartview={FitH},
backref,
colorlinks,linkcolor={black},citecolor={black},urlcolor={black},
]{hyperref}
\else
\usepackage[dvips,
73 74 75
pdftitle={OTB Software Guide},
pdfauthor={CNES},
pdfsubject={Remote Sensing, Orfeo, Pleiades, Cosmo Skymed},
76
pdfkeywords={Image processing, Remote sensing, Guide},
OTB Bot's avatar
OTB Bot committed
77 78 79 80 81 82 83 84
pdfpagemode={UseOutlines},
bookmarks,bookmarksopen,
pdfstartview={FitH},
backref,
colorlinks,linkcolor={blue},citecolor={blue},urlcolor={blue},
]{hyperref}
\fi

Jordi Inglada's avatar
Jordi Inglada committed
85
\usepackage{amsmath,amssymb,amsfonts}
86
\usepackage{bbm}
OTB Bot's avatar
OTB Bot committed
87 88 89 90 91 92 93 94 95 96
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%
%   Load configuration parameters prepared by CMake
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\input{SoftwareGuideConfiguration.tex}

97
\def\logoCNES{CNES_nom.eps}
98 99

\newtheorem{algo}{Algorithm}
Jordi Inglada's avatar
Jordi Inglada committed
100
\newtheorem{defin}{Definition}
OTB Bot's avatar
OTB Bot committed
101 102 103 104 105 106 107 108
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%
%           The Insight Toolkit Software Guide
%
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

109
\title{The ORFEO Tool Box Software Guide\\ Updated
110
  for OTB-\otbversion}
OTB Bot's avatar
OTB Bot committed
111

Jordi Inglada's avatar
Jordi Inglada committed
112
\author{OTB Development Team}
OTB Bot's avatar
OTB Bot committed
113 114

\authoraddress{
115
  \url{http://www.orfeo-toolbox.org}\\
116
  e-mail: \email{otb@cnes.fr}
OTB Bot's avatar
OTB Bot committed
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
}

\date{\today}


% actually write the .idx file
\makeindex

\setcounter{tocdepth}{3}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%           Begin Document
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\begin{document}

\ifitkPrintedVersion
%% \input{PrintedPreamble.tex}
\fi

\maketitle

\frontmatter

145
\hyperbaseurl{http://www.orfeo-toolbox.org}
OTB Bot's avatar
OTB Bot committed
146 147 148 149


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
Jordi Inglada's avatar
Jordi Inglada committed
150
%  Page with OTB logo
OTB Bot's avatar
OTB Bot committed
151 152 153 154
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\cleardoublepage

Jordi Inglada's avatar
Jordi Inglada committed
155 156 157
\begin{minipage}[t][10cm][b]{\textwidth}
\center
\includegraphics[width=0.5\textwidth]{logoVectoriel.eps}
Jordi Inglada's avatar
Jordi Inglada committed
158 159 160 161 162 163
\large
\begin{center}
\emph{The ORFEO Toolbox is not a black box.}\\
\end{center}
\hspace{8cm} Ch.D.
\normalsize
Jordi Inglada's avatar
Jordi Inglada committed
164
\end{minipage}
OTB Bot's avatar
OTB Bot committed
165 166 167 168 169 170 171 172 173 174 175 176



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% remove headings from the following material
\pagestyle{plain}
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%



177
%%\ifitkPrintedVersion
OTB Bot's avatar
OTB Bot committed
178
%% \input{Cover.tex}
Jordi Inglada's avatar
Jordi Inglada committed
179
%%\fi
OTB Bot's avatar
OTB Bot committed
180 181

\input{Abstract.tex}
182

OTB Bot's avatar
OTB Bot committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Insert Table of Contents; List of Figures and Tables
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% enable headings from the following material
\pagestyle{normal}
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\small
\tableofcontents
\listoffigures
\listoftables
\normalsize




%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
209
%
OTB Bot's avatar
OTB Bot committed
210
% Begin technical content
211
%
OTB Bot's avatar
OTB Bot committed
212 213 214 215
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\mainmatter

216
\part{Introduction}\label{part:introduction}
OTB Bot's avatar
OTB Bot committed
217 218

\input{Introduction.tex}
219
\input{SystemOverview.tex}
OTB Bot's avatar
OTB Bot committed
220

221
\part{Tutorials}\label{part:tutorials}
222 223 224

\input{Tutorial.tex}

OTB Bot's avatar
OTB Bot committed
225

226
\part{User's guide}\label{part:userguide}
OTB Bot's avatar
OTB Bot committed
227

228 229
\input{DataRepresentation.tex}
\input{ReadWrite.tex}
230
\input{ReadWriteVectorData.tex}
OTB Bot's avatar
OTB Bot committed
231
\input{Filtering.tex}
Jordi Inglada's avatar
Jordi Inglada committed
232
\input{ImageRegistration.tex}
233
\input{DisparityEstimation.tex}
234
\input{StereoReconstruction.tex}
Jordi Inglada's avatar
Jordi Inglada committed
235
\input{OrthoRectification.tex}
Jordi Inglada's avatar
Jordi Inglada committed
236 237
\input{Radiometry.tex}
\input{Fusion.tex}
238
\input{FeatureExtraction.tex}
239
\input{MultiScaleAnalysis.tex}
240
\input{ImageSegmentation.tex}
241
\input{ImageSimulation.tex}
242
\input{DimensionReduction.tex}
243
\input{Classification.tex}
244
\input{ObjectBasedImageAnalysis.tex}
245
\input{ChangeDetection.tex}
246
\input{Hyperspectral.tex}
Jordi Inglada's avatar
Jordi Inglada committed
247
\input{Visualization.tex}
OTB Bot's avatar
OTB Bot committed
248 249 250

%%% \input{Applications.tex}

Emmanuel Christophe's avatar
Emmanuel Christophe committed
251

OTB Bot's avatar
OTB Bot committed
252

253
\part{Developer's guide}\label{part:developerguide}
Jordi Inglada's avatar
Jordi Inglada committed
254 255
\input{Iterators.tex}
\input{ImageAdaptors.tex}
256
\input{StreamingAndThreading.tex}
Jordi Inglada's avatar
Jordi Inglada committed
257
\input{WriteAFilter.tex}
258
\input{Persistent.tex}
259
\input{WriteAnApplication.tex}
260
\input{WriteModules.tex}
261

OTB Bot's avatar
OTB Bot committed
262 263 264 265 266 267 268 269
\backmatter

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%  Insert the bibliography using BibTeX
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

270 271
% \bibliographystyle{plain}
\bibliographystyle{abbrv}
272
\bibliography{\bibtexdatabasepath/Insight}
OTB Bot's avatar
OTB Bot committed
273 274 275 276 277 278 279 280


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%  Insert the Index file
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

281
\InputIfFileExists{SoftwareGuide.ind}{}{}
OTB Bot's avatar
OTB Bot committed
282

Jordi Inglada's avatar
Jordi Inglada committed
283 284
%%\ifitkPrintedVersion
%%\cleardoublepage
OTB Bot's avatar
OTB Bot committed
285
%%% \input{MarketingMaterial.tex}
Jordi Inglada's avatar
Jordi Inglada committed
286
%%\fi
OTB Bot's avatar
OTB Bot committed
287 288 289 290 291

\end{document}