r328: *** empty log message ***
[ctsim.git] / doc / ctsim.tex
index d4207ff789112fa74eb72c666c7c4ec2b954ea27..2cecbaf78b045872087ffe353863cbf68ba04c95 100644 (file)
-\documentstyle[a4,texhelp]{report} 
-\title{CTSim - An Open-Source Computed Tomography Simulator} 
-\author{Kevin Rosenberg} 
-\date{July 2000} 
+\documentclass[11pt,texhelp]{report} 
+\usepackage[dvips]{graphics}
+
 \begin{document} 
+
+\newcommand{\ctsim}{{\tt ctsim}}
+
+
+\title{CTSim - An Open-Source Computed Tomography Simulator} 
+\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}} 
+\date{September 2000} 
 \maketitle 
+
 \chapter{Introduction} 
-Welcome to CT.
-\section{Theory} 
-Theory of CT.
-\chapter{The Programs}
-\centerline{This is a centered line}
-\begin{center}
-This is a 
-centered paragraph.
-\end{center}
-
-{\bf This is in bold font}
+Computed Tomography is the process of acquiring X-ray data (projections)
+though an object and then using mathematics to reconstruct the interior
+of that object.
+
+\chapter{Installation}
+\subsection{Requirements}
+\begin{itemize}
+  \item Running CTSim
+  \begin{itemize}
+    \item Apache or other CGI compatible web server
+
+    \item Perl (version 4.0 or higher)
+
+    \item A client web browser than can display PNG files. Most
+    current web browswer do support PNG.
+
+  \end{itemize}
+  \item Building CTSim
+  \begin{itemize}
+  \item zlib Library (optional)
+        \par Used for PNG file export.
+
+  \item libpng Library (optional)
+        \par Used for PNG file export.
+       \par www.libpng.org
+
+  \item FFTW library (optional)
+       \par Used for frequency-based filtering
+       \par www.fftw.org
+
+  \item dmalloc library (optional)
+       \par Used for debugging memory allocation
+       \par www.dmalloc.com
+
+  \item wxWindows library (optional) \par Used for
+  platform-independent graphical interface. The graphical-shell
+  program {\tt ctsim} requires this library.  \par www.wxwindows.org
+
+  \end{itemize}
+\end{itemize}
+
+\subsection{Download}
+\subsection{Install Binary Distribution}
+\subsection{Build From Sources}
+
+\chapter{The Programs} 
+
+\section{ctsim - The Graphical User Interface}
+\ctsim\ is the graphical shell for the CTSim project. It is
+written using the wxLibrary for cross-platform compatibility with GTK,
+Motif, and Microsoft Windows.
+
+\ctsim\ incorporates most of the capabilities of the CTSim
+project. There are still functions that are only available to the
+command line tools.
+
+\subsection{Usage}
+ctsim [OPTIONS] [files to open...]
+
+\ctsim\ can open projection files and image files.
+
+\section{The Web Browser CGI Interface}
+\subsection{Overview}
+The CGI program {\tt ctsim.cgi} takes projections of a standard
+phantom object, performs reconstruction, and then compares the
+rasterized phantom object with the reconstruction. The comparison is
+performed both visually by an image subtraction as well as by standard
+statistics as described by Herman\cite{HERMAN80}.
+
+\section{tools - The Command Line Interface}
+\subsection{phm2pj}
+Converts a phantom object to a set of projections
+
+{\tt phm2pj} simulates the process of collection of X-Ray projection data
+such as collected by a CT scanner.
+
+\subsection{pjrec}
+
+\subsection{phm2if}
+
+\section{Function Parameters}
+\subsection{Collection Projections}
+\begin{itemize}
+  \item Phantom
+  Select which phantom to collect projections
+
+  \item Geometry
+  \begin{itemize}
+    \item Parallel
+    \item Equiangular
+    \item Equilinear
+  \end{itemize}
+
+  \item Number of Detectors
+
+  \item Number of Views
+
+  \item Number of Samples Per Detector
+
+\end{itemize}
+
+\subsection{Reconstruct Image From Projections}
+\begin{itemize}
+  \item Filter 
+  Selects which filter to apply to each projection. To
+  properly reconstruct an image, the should be multiplied 
+  by the absolute value of distance from zero frequency.
+
+  \item Filter Parameter
+  \item Filter Method
+  \item Filter Generation
+  \item Interpolation
+  \item Backprojection
+  \item Zeropad
+  \item Preinterpolation Factor
+\end{itemize}
+
+\bibliographystyle{abbrv}
+\bibliography{yes}
+
 
 \end{document}