1 | % ----------------------------------------------------------------------- |
---|
2 | % Guide.tex: Base latex file for the User's Guide. |
---|
3 | % ----------------------------------------------------------------------- |
---|
4 | % Copyright (C) 2006, Matthew Whiting, ATNF |
---|
5 | % |
---|
6 | % This program is free software; you can redistribute it and/or modify it |
---|
7 | % under the terms of the GNU General Public License as published by the |
---|
8 | % Free Software Foundation; either version 2 of the License, or (at your |
---|
9 | % option) any later version. |
---|
10 | % |
---|
11 | % Duchamp is distributed in the hope that it will be useful, but WITHOUT |
---|
12 | % ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
---|
13 | % FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
---|
14 | % for more details. |
---|
15 | % |
---|
16 | % You should have received a copy of the GNU General Public License |
---|
17 | % along with Duchamp; if not, write to the Free Software Foundation, |
---|
18 | % Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA |
---|
19 | % |
---|
20 | % Correspondence concerning Duchamp may be directed to: |
---|
21 | % Internet email: Matthew.Whiting [at] atnf.csiro.au |
---|
22 | % Postal address: Dr. Matthew Whiting |
---|
23 | % Australia Telescope National Facility, CSIRO |
---|
24 | % PO Box 76 |
---|
25 | % Epping NSW 1710 |
---|
26 | % AUSTRALIA |
---|
27 | % ----------------------------------------------------------------------- |
---|
28 | \documentclass[11pt,a4paper]{article} |
---|
29 | %\documentclass[12pt,a4paper]{report} |
---|
30 | |
---|
31 | %%%%%% LINE SPACING %%%%%%%%%%%% |
---|
32 | \usepackage{setspace} |
---|
33 | \singlespacing |
---|
34 | %\onehalfspacing |
---|
35 | %\doublespacing |
---|
36 | |
---|
37 | %Define a test for doing PDF format -- use different code below |
---|
38 | \newif\ifPDF |
---|
39 | \ifx\pdfoutput\undefined\PDFfalse |
---|
40 | \else\ifnum\pdfoutput > 0\PDFtrue |
---|
41 | \else\PDFfalse |
---|
42 | \fi |
---|
43 | \fi |
---|
44 | |
---|
45 | %\textwidth=165 mm |
---|
46 | %\textheight=245 mm |
---|
47 | %\topmargin=0 mm |
---|
48 | %\oddsidemargin=0 mm |
---|
49 | %\parindent=6 mm |
---|
50 | |
---|
51 | \usepackage{amsmath} |
---|
52 | \usepackage{amsfonts} |
---|
53 | \usepackage{xspace} |
---|
54 | \usepackage[sort]{natbib} |
---|
55 | \bibpunct[,]{(}{)}{;}{a}{}{,} |
---|
56 | |
---|
57 | %\newcommand{\secA}{\chapter} |
---|
58 | %\newcommand{\secB}{\section} |
---|
59 | %\newcommand{\secC}{\subsection} |
---|
60 | |
---|
61 | \newcommand{\secA}{\section} |
---|
62 | \newcommand{\secB}{\subsection} |
---|
63 | \newcommand{\secC}{\subsubsection} |
---|
64 | |
---|
65 | \newcommand{\version}{1.1.2} |
---|
66 | |
---|
67 | \newcommand{\eg}{e.g.\ } |
---|
68 | \newcommand{\ie}{i.e.\ } |
---|
69 | \newcommand{\hi}{H\textsc{i}\xspace} |
---|
70 | \newcommand{\hipass}{\textsc{hipass}\xspace} |
---|
71 | \newcommand{\duchamp}{\emph{Duchamp}\xspace} |
---|
72 | \newcommand{\atrous}{\textit{{\`a} trous}\xspace} |
---|
73 | \newcommand{\Atrous}{\textit{{\`A} trous}\xspace} |
---|
74 | \newcommand{\diff}{{\rm d}} |
---|
75 | \newcommand{\entrylabel}[1]{\mbox{\texttt{#1:}}\hfil} |
---|
76 | \newenvironment{entry} |
---|
77 | {\begin{list}{}% |
---|
78 | {\renewcommand{\makelabel}{\entrylabel}% |
---|
79 | \setlength{\leftmargin}{33mm}% |
---|
80 | \setlength{\labelwidth}{33mm}% |
---|
81 | \setlength{\labelsep}{0pt}% |
---|
82 | \setlength{\itemsep}{3pt}% |
---|
83 | \setlength{\parsep}{2pt}% |
---|
84 | }% |
---|
85 | }% |
---|
86 | {\end{list}} |
---|
87 | |
---|
88 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
---|
89 | |
---|
90 | \newlength{\MyLen} |
---|
91 | \newcommand{\Lentrylabel}[1]{% |
---|
92 | \settowidth{\MyLen}{\texttt{#1:}}% |
---|
93 | % \setlength{\labelwidth}{30mm}% |
---|
94 | \ifthenelse{\lengthtest{\MyLen > \labelwidth}}% |
---|
95 | {\parbox[b]{\labelwidth}% term > labelwidth |
---|
96 | {\makebox[0pt][l]{\texttt{#1:}}\\}}% |
---|
97 | {\texttt{#1:}}% term < labelwidth |
---|
98 | \hfil\relax} |
---|
99 | |
---|
100 | \newenvironment{Lentry}% |
---|
101 | {\renewcommand{\entrylabel}{\Lentrylabel}\begin{entry} |
---|
102 | \setlength{\itemsep}{3pt}% |
---|
103 | % \setlength{\leftmargin}{25mm}% |
---|
104 | % \setlength{\itemindent}{0mm}% |
---|
105 | % \setlength{\listparindent}{0mm}% |
---|
106 | \setlength{\labelsep}{0mm}% |
---|
107 | }% |
---|
108 | {\end{entry}% |
---|
109 | } |
---|
110 | |
---|
111 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
---|
112 | |
---|
113 | \newcommand{\Mentrylabel}[1]% |
---|
114 | {\raisebox{0pt}[1ex][0pt]{\makebox[\labelwidth][l]% |
---|
115 | {\parbox[t]{\labelwidth}{\hspace{0pt}\texttt{#1}}}}} |
---|
116 | \newenvironment{Mentry} |
---|
117 | {\renewcommand{\entrylabel}{\Mentrylabel}\begin{entry}% |
---|
118 | \setlength{\labelwidth}{33mm}% |
---|
119 | \setlength{\leftmargin}{35mm}% |
---|
120 | }% |
---|
121 | {\end{entry}% |
---|
122 | } |
---|
123 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
---|
124 | |
---|
125 | |
---|
126 | %%%%%%% FANCY HEADINGS %%%%%%%%%% |
---|
127 | %\usepackage{fancyheadings} |
---|
128 | %\pagestyle{fancyplain} |
---|
129 | %\addtolength{\headheight}{1.6pt} |
---|
130 | %\addtolength{\headwidth}{\marginparsep} |
---|
131 | %\addtolength{\headwidth}{\marginparwidth} |
---|
132 | %\renewcommand{\secAmark}[1] |
---|
133 | % {\markboth{#1}{}} |
---|
134 | %\renewcommand{\secBmark}[1] |
---|
135 | % {\markright{\thesection\ #1}} |
---|
136 | %\lhead[\fancyplain{}{\bfseries\thepage}] |
---|
137 | % {\fancyplain{}{\bfseries\rightmark}} |
---|
138 | %\rhead[\fancyplain{}{\bfseries\leftmark}] |
---|
139 | % {\fancyplain{}{\bfseries\thepage}} |
---|
140 | %\cfoot{} |
---|
141 | |
---|
142 | % If we are creating a PDF, use different options for graphicx, hyperref. |
---|
143 | \ifPDF |
---|
144 | \usepackage[pdftex]{graphicx,color} |
---|
145 | \usepackage[pdftex,bookmarks]{hyperref} |
---|
146 | \hypersetup{colorlinks=true,% |
---|
147 | citecolor=red,% |
---|
148 | filecolor=red,% |
---|
149 | linkcolor=red,% |
---|
150 | urlcolor=red,% |
---|
151 | } |
---|
152 | \else |
---|
153 | \usepackage[dvips]{graphicx} |
---|
154 | \usepackage[dvips]{hyperref} |
---|
155 | \fi |
---|
156 | |
---|
157 | \usepackage{lscape} |
---|
158 | \usepackage[dvips]{rotating} |
---|
159 | %\rotdriver{dvips} |
---|
160 | |
---|
161 | \pagestyle{headings} |
---|
162 | \begin{document} |
---|
163 | |
---|
164 | \ifPDF |
---|
165 | \pdfbookmark[2]{Title Page}{title} |
---|
166 | \fi |
---|
167 | \newlength{\centreoff} |
---|
168 | \setlength{\centreoff}{-0.5\oddsidemargin} |
---|
169 | \addtolength{\centreoff}{0.5\evensidemargin} |
---|
170 | \thispagestyle{empty} |
---|
171 | \vspace*{\stretch{1}} |
---|
172 | \noindent\hspace*{\centreoff}% |
---|
173 | \makebox[0pt][l]{\begin{minipage}{\textwidth} |
---|
174 | \flushright |
---|
175 | {\Huge\bfseries Source Detection with \duchamp\\[2ex]} |
---|
176 | {\huge\bfseries A User's Guide |
---|
177 | |
---|
178 | } |
---|
179 | \noindent\rule[-1ex]{\textwidth}{3pt} |
---|
180 | \end{minipage}} |
---|
181 | |
---|
182 | \vspace{\stretch{1}} |
---|
183 | \noindent\hspace*{\centreoff}% |
---|
184 | \makebox[0pt][l]{\begin{minipage}{\textwidth} |
---|
185 | \flushright |
---|
186 | {\bfseries |
---|
187 | Matthew Whiting\\ |
---|
188 | Australia Telescope National Facility\\ |
---|
189 | CSIRO\\[3ex]} |
---|
190 | Duchamp version~\version\\ |
---|
191 | December 7, 2007 |
---|
192 | \end{minipage}} |
---|
193 | |
---|
194 | \begin{figure}[!h] |
---|
195 | %\begin{center} |
---|
196 | \includegraphics[width=\textwidth]{cover_image} |
---|
197 | %\end{center} |
---|
198 | \end{figure} |
---|
199 | |
---|
200 | %\newpage |
---|
201 | \ifPDF |
---|
202 | \pdfbookmark[2]{Contents}{contents} |
---|
203 | \fi |
---|
204 | \tableofcontents |
---|
205 | |
---|
206 | \newpage |
---|
207 | \input{intro} %Introduction and getting going quickly |
---|
208 | \newpage |
---|
209 | \input{userInputs} %User Inputs |
---|
210 | \newpage |
---|
211 | \input{executionFlow} %What \duchamp is doing |
---|
212 | \newpage |
---|
213 | \input{outputs} %Outputs |
---|
214 | \newpage |
---|
215 | \input{hints} %Notes and hints on the use of \duchamp |
---|
216 | \newpage |
---|
217 | \input{future} %Future developments |
---|
218 | |
---|
219 | %\bibliographystyle{plainnat} |
---|
220 | %\bibliographystyle{mn2e} |
---|
221 | %\bibliography{guide} |
---|
222 | |
---|
223 | \newpage |
---|
224 | \ifPDF |
---|
225 | \pdfbookmark[1]{References}{references} |
---|
226 | \fi |
---|
227 | \ifPDF |
---|
228 | \input{Guide-URL-bib} |
---|
229 | \else |
---|
230 | \input{Guide-noURL-bib} |
---|
231 | \fi |
---|
232 | |
---|
233 | \appendix |
---|
234 | \newpage |
---|
235 | \input{app-install} %Obtaining and installing \duchamp |
---|
236 | \newpage |
---|
237 | \input{app-param} %Available parameters |
---|
238 | \newpage |
---|
239 | \input{app-paramEx} %Example parameter files |
---|
240 | \newpage |
---|
241 | \input{app-resultsEx} %Example results files |
---|
242 | \newpage |
---|
243 | \input{app-VOTable} %Example VOTable output |
---|
244 | \newpage |
---|
245 | \input{app-Karma} %Example Karma annotation file output |
---|
246 | \newpage |
---|
247 | \input{app-stats} %Robust statistics for a Normal distribution |
---|
248 | \newpage |
---|
249 | \input{app-waveletNoise} %How Gaussian noise changes with wavelet scale |
---|
250 | |
---|
251 | |
---|
252 | \end{document} |
---|