source: trunk/docs/Guide.tex @ 194

Last change on this file since 194 was 194, checked in by Matthew Whiting, 18 years ago

Update of the documentation and installation files in preparation for version 1.0.6.
Guide now mentions recent changes of how the cube stats are calculated and how the S/Nmax value is reported.

File size: 4.2 KB
Line 
1\documentclass[12pt,a4paper]{article}
2%\documentclass[12pt,a4paper]{report}
3
4%%%%%% LINE SPACING %%%%%%%%%%%%
5\usepackage{setspace}
6\singlespacing
7%\onehalfspacing
8%\doublespacing
9
10%Define a test for doing PDF format -- use different code below
11\newif\ifPDF
12\ifx\pdfoutput\undefined\PDFfalse
13\else\ifnum\pdfoutput > 0\PDFtrue
14     \else\PDFfalse
15     \fi
16\fi
17
18\textwidth=165 mm
19\textheight=245 mm
20\topmargin=0 mm
21\oddsidemargin=0 mm
22\parindent=6 mm
23
24\usepackage[sort]{natbib}
25\usepackage{lscape}
26\bibpunct[,]{(}{)}{;}{a}{}{,}
27
28%\newcommand{\secA}{\chapter}
29%\newcommand{\secB}{\section}
30%\newcommand{\secC}{\subsection}
31
32\newcommand{\secA}{\section}
33\newcommand{\secB}{\subsection}
34\newcommand{\secC}{\subsubsection}
35
36
37\newcommand{\eg}{e.g.\ }
38\newcommand{\ie}{i.e.\ }
39\newcommand{\hi}{H\textsc{i}}
40\newcommand{\hipass}{\textsc{hipass}}
41\newcommand{\duchamp}{\emph{Duchamp}}
42\newcommand{\atrous}{\textit{{\`a} trous}}
43\newcommand{\Atrous}{\textit{{\`A} trous}}
44\newcommand{\diff}{{\rm d}}
45\newcommand{\entrylabel}[1]{\mbox{\textsf{\bf{#1:}}}\hfil}
46\newenvironment{entry}
47        {\begin{list}{}%
48                {\renewcommand{\makelabel}{\entrylabel}%
49                        \setlength{\labelwidth}{30mm}%
50                        \setlength{\labelsep}{5pt}%
51                        \setlength{\itemsep}{2pt}%
52                        \setlength{\parsep}{2pt}%
53                        \setlength{\leftmargin}{35mm}%
54                }%
55        }%
56{\end{list}}
57
58%%%%%%% FANCY HEADINGS %%%%%%%%%%
59%\usepackage{fancyheadings}
60%\pagestyle{fancyplain}
61%\addtolength{\headheight}{1.6pt}
62%\addtolength{\headwidth}{\marginparsep}
63%\addtolength{\headwidth}{\marginparwidth}
64%\renewcommand{\secAmark}[1]
65%                {\markboth{#1}{}}
66%\renewcommand{\secBmark}[1]
67%                {\markright{\thesection\ #1}}
68%\lhead[\fancyplain{}{\bfseries\thepage}]
69%      {\fancyplain{}{\bfseries\rightmark}}
70%\rhead[\fancyplain{}{\bfseries\leftmark}]
71%      {\fancyplain{}{\bfseries\thepage}}
72%\cfoot{}
73
74% If we are creating a PDF, use different options for graphicx, hyperref.
75\ifPDF
76  \usepackage[pdftex]{graphicx,color}
77  \usepackage[pdftex,bookmarks]{hyperref}
78  \hypersetup{colorlinks=true,%             
79              citecolor=red,%
80              filecolor=red,%
81              linkcolor=red,%
82              urlcolor=red,%
83              }
84\else
85  \usepackage[dvips]{graphicx}
86  \usepackage[dvips]{hyperref}
87\fi
88
89\pagestyle{headings}
90\begin{document}
91
92\ifPDF
93\pdfbookmark[2]{Title Page}{title}
94\fi
95\newlength{\centreoff}
96\setlength{\centreoff}{-0.5\oddsidemargin}
97\addtolength{\centreoff}{0.5\evensidemargin}
98\thispagestyle{empty}
99\vspace*{\stretch{1}}
100\noindent\hspace*{\centreoff}%
101\makebox[0pt][l]{\begin{minipage}{\textwidth}
102\flushright
103{\Huge\bfseries Source Detection with \duchamp\\%
104A User's Guide
105
106}
107\noindent\rule[-1ex]{\textwidth}{3pt}
108\end{minipage}}
109
110\vspace{\stretch{1}}
111\noindent\hspace*{\centreoff}%
112\makebox[0pt][l]{\begin{minipage}{\textwidth}
113\flushright
114{\bfseries
115Matthew Whiting\\
116Australia Telescope National Facility\\
117CSIRO\\[3ex]}
118Duchamp version~1.06\\
119November 1, 2006
120\end{minipage}}
121
122\begin{figure}[!h]
123%\begin{center}
124\includegraphics[width=\textwidth]{cover_image}
125%\end{center}
126\end{figure}
127
128%\newpage
129\ifPDF
130\pdfbookmark[2]{Contents}{contents}
131\fi
132\tableofcontents
133
134%\newpage
135\input{intro} %Introduction and getting going quickly
136\newpage
137\input{userInputs} %User Inputs
138\newpage
139\input{executionFlow} %What \duchamp\ is doing
140\newpage
141\input{outputs} %Outputs
142\newpage
143\input{hints} %Notes and hints on the use of \duchamp
144\newpage
145\input{future} %Future developments
146
147%\bibliographystyle{plainnat}
148%\bibliographystyle{mn2e}
149%\bibliography{guide}
150
151\newpage
152\ifPDF
153\pdfbookmark[1]{References}{references}
154\fi
155\ifPDF
156\input{Guide-URL-bib}
157\else
158\input{Guide-noURL-bib}
159\fi
160
161\appendix
162\newpage
163\input{app-install} %Obtaining and installing \duchamp
164\newpage
165\input{app-param} %Available parameters
166\newpage
167\input{app-paramEx} %Example parameter files
168
169\input{app-resultsEx} %Example results files
170
171\input{app-VOTable} %Example VOTable output
172
173\input{app-Karma} %Example Karma annotation file output
174\newpage
175\input{app-stats} %Robust statistics for a Normal distribution
176
177\input{app-waveletNoise} %How Gaussian noise changes with wavelet scale
178
179
180\end{document}
Note: See TracBrowser for help on using the repository browser.