r328: *** empty log message ***
[ctsim.git] / doc / ctsim.tex
1 \documentclass[11pt,texhelp]{report} 
2 \usepackage[dvips]{graphics}
3
4 \begin{document} 
5
6 \newcommand{\ctsim}{{\tt ctsim}}
7
8
9 \title{CTSim - An Open-Source Computed Tomography Simulator} 
10 \author{Kevin Rosenberg, MD\footnote{San Juan Regional Medical Center, 801 W. Maple, Farmington NM 87401. Phone: (505) 599-6103. E-mail: kevin@rosenberg.net}} 
11 \date{September 2000} 
12 \maketitle 
13
14 \chapter{Introduction} 
15 Computed Tomography is the process of acquiring X-ray data (projections)
16 though an object and then using mathematics to reconstruct the interior
17 of that object.
18
19 \chapter{Installation}
20 \subsection{Requirements}
21 \begin{itemize}
22   \item Running CTSim
23   \begin{itemize}
24     \item Apache or other CGI compatible web server
25
26     \item Perl (version 4.0 or higher)
27
28     \item A client web browser than can display PNG files. Most
29     current web browswer do support PNG.
30
31   \end{itemize}
32   \item Building CTSim
33   \begin{itemize}
34   \item zlib Library (optional)
35         \par Used for PNG file export.
36
37   \item libpng Library (optional)
38         \par Used for PNG file export.
39         \par www.libpng.org
40
41   \item FFTW library (optional)
42         \par Used for frequency-based filtering
43         \par www.fftw.org
44
45   \item dmalloc library (optional)
46         \par Used for debugging memory allocation
47         \par www.dmalloc.com
48
49   \item wxWindows library (optional) \par Used for
50   platform-independent graphical interface. The graphical-shell
51   program {\tt ctsim} requires this library.  \par www.wxwindows.org
52
53   \end{itemize}
54 \end{itemize}
55
56 \subsection{Download}
57 \subsection{Install Binary Distribution}
58 \subsection{Build From Sources}
59
60 \chapter{The Programs} 
61
62 \section{ctsim - The Graphical User Interface}
63 \ctsim\ is the graphical shell for the CTSim project. It is
64 written using the wxLibrary for cross-platform compatibility with GTK,
65 Motif, and Microsoft Windows.
66
67 \ctsim\ incorporates most of the capabilities of the CTSim
68 project. There are still functions that are only available to the
69 command line tools.
70
71 \subsection{Usage}
72 ctsim [OPTIONS] [files to open...]
73
74 \ctsim\ can open projection files and image files.
75
76 \section{The Web Browser CGI Interface}
77 \subsection{Overview}
78 The CGI program {\tt ctsim.cgi} takes projections of a standard
79 phantom object, performs reconstruction, and then compares the
80 rasterized phantom object with the reconstruction. The comparison is
81 performed both visually by an image subtraction as well as by standard
82 statistics as described by Herman\cite{HERMAN80}.
83
84 \section{tools - The Command Line Interface}
85 \subsection{phm2pj}
86 Converts a phantom object to a set of projections
87
88 {\tt phm2pj} simulates the process of collection of X-Ray projection data
89 such as collected by a CT scanner.
90
91 \subsection{pjrec}
92
93 \subsection{phm2if}
94
95 \section{Function Parameters}
96 \subsection{Collection Projections}
97 \begin{itemize}
98   \item Phantom
99   Select which phantom to collect projections
100
101   \item Geometry
102   \begin{itemize}
103     \item Parallel
104     \item Equiangular
105     \item Equilinear
106   \end{itemize}
107
108   \item Number of Detectors
109
110   \item Number of Views
111
112   \item Number of Samples Per Detector
113
114 \end{itemize}
115
116 \subsection{Reconstruct Image From Projections}
117 \begin{itemize}
118   \item Filter 
119   Selects which filter to apply to each projection. To
120   properly reconstruct an image, the should be multiplied 
121   by the absolute value of distance from zero frequency.
122
123   \item Filter Parameter
124   \item Filter Method
125   \item Filter Generation
126   \item Interpolation
127   \item Backprojection
128   \item Zeropad
129   \item Preinterpolation Factor
130 \end{itemize}
131
132 \bibliographystyle{abbrv}
133 \bibliography{yes}
134
135
136 \end{document}