r430: *** empty log message ***
[ctsim.git] / doc / tex2rtf / ctsim.tex
index 05ddbf77c5e10914bc2ec6a801e06973a2f9eadd..5a3254816a4235250ce5903f8958d0d16322ca69 100644 (file)
@@ -61,15 +61,15 @@ PERFORMANCE OF THIS SOFTWARE.
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \winhelponly{$$\image{3cm;3cm}{logo-huge}$$}%
-
+\htmlonly{$$\image{3cm;3cm}{logo-huge.gif}$$}%
 Computed Tomography is a technique for estimating the interior of an object 
 from measurement of radiation collected around the object. This radiation 
 can be either projected through or emitted from the object.
-\rtfsp\ctsim\ simulates the process of projecting X-rays through a phantom object.
-\rtfsp\ctsim\ can then reconstruct the interior of the object from the projections
+\rtfsp\ctsim simulates the process of projecting X-rays through a phantom object.
+\rtfsp\ctsim can then reconstruct the interior of the object from the projections
 collected around the phantom object.
 
-The \ctsim\ package has two executable files: the graphical \helprefn{ctsim}{ctsim} and text \helprefn{ctsimtext}{ctsimtext} programs.
+The \ctsim package has two executable files: the graphical \helprefn{ctsim}{ctsim} and text \helprefn{ctsimtext}{ctsimtext} programs.
 
 \chapter{Installation}\index{Installation}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
@@ -94,7 +94,7 @@ It is available in Windows 95/NT/2000 and Linux GUI versions and non-GUI version
 
 See the INSTALL file included in the source distribution for instructions.
 
-\section{Requirements}\label{installreq}\index{Installation,Requirements}%
+\section{Web Requirements}\label{installreq}\index{Installation,Requirements}%
   \begin{itemize}\itemsep=0pt
   \item zlib Library (optional)
         \par Used for PNG file export.
@@ -108,7 +108,7 @@ See the INSTALL file included in the source distribution for instructions.
        \par www.fftw.org
 
   \item readline library (optional)
-       /par Used for {/ctsimtext} interactive shell.
+       \par Used for \ctsimtext interactive shell.
 
   \item dmalloc library (optional)
        \par Used for debugging memory allocation
@@ -116,21 +116,20 @@ See the INSTALL file included in the source distribution for instructions.
 
   \item wxWindows library (optional) 
   \par Used for platform-independent graphical interface. The graphical-shell
-  program \ctsim\ requires this library.  
+  program \ctsim requires this library.  
   \par www.wxwindows.org
-
 \end{itemize}
 
 \chapter{ctsim - the Graphical User Interface}\label{ctsim}\index{ctsim}% 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
-\ctsim\ is the graphical shell for the CTSim project. It is
+\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. It includes all of the functionality of
 the command-line tool {\tt ctsimtext} as well as image processing and visualization features.
 
-\ctsim\ can open projection files, image files, phantom definition files, and plotfiles.
+\ctsim can open projection files, image files, phantom definition files, and plotfiles.
 
 \usage
 ctsim [OPTIONS] [files to open...]
@@ -139,27 +138,18 @@ ctsim [OPTIONS] [files to open...]
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
-\ctsimtext\ is a master shell for all of the command-line utilities. 
+\ctsimtext is a master shell for all of the command-line utilities. 
 
 \usage
-\ctsimtext\ can be executed without any parameters. In that case, \ctsimtext
+\ctsimtext can be executed without any parameters. In that case, \ctsimtext
 offers a command-line to enter the function-names and their parameters. The output of the command is displayed. Further commands may be given to \ctsimtext. The shell is exited by the {\tt quit} command.
 
-\ctsimtext\ can also be called to execute a single command. This is especially useful for batch files containing multiple \ctsimtext\ commands. This is invoked by calling {\tt ctsimtext function-name parameters...}.
+\ctsimtext can also be called to execute a single command. This is especially useful for batch files containing multiple \ctsimtext commands. This is invoked by calling \par
+{\tt ctsimtext function-name parameters...}.
 
-The following function names are available:
+The available functions are:
 
-\helprefn{if1}{if1}\par
-\helprefn{if2}{if2}\par
-\helprefn{ifexport}{ifexport}\par
-\helprefn{ifinfo}{ifinfo}\par
-\helprefn{phm2if}{phm2if}\par
-\helprefn{phm2pj}{phm2pj}\par
-\helprefn{pj2if}{pj2if}\par
-\helprefn{pjinfo}{pjinfo}\par
-\helprefn{pjrej}{pjrec}\par
-
-\subsection{if1}\label{if1}\index{ctsimtext,if1}%
+\section{if1}\label{if1}\index{ctsimtext,if1}%
 Perfoms math functions on a single image.
 
 \usage
@@ -171,7 +161,7 @@ Perfoms math functions on a single image.
   \item --sqrt
 \end{itemize}
 
-\subsection{if2}\label{if2}\index{ctsimtext,if2}%
+\section{if2}\label{if2}\index{ctsimtext,if2}%
 Perfoms math functions on a two images.
 
 \usage
@@ -184,7 +174,7 @@ Perfoms math functions on a two images.
   \item --row-plot
 \end{itemize}
 
-\subsection{ifexport}\label{ifexport}\index{ctsimtext,ifexport}%
+\section{ifexport}\label{ifexport}\index{ctsimtext,ifexport}%
 Export an imagefile to a standard graphics file.
 
 \usage
@@ -216,7 +206,7 @@ Export an imagefile to a standard graphics file.
   \item --max
 \end{itemize}
 
-\subsection{ifinfo}\label{ifinfo}\index{ctsimtext,ifinfo}%
+\section{ifinfo}\label{ifinfo}\index{ctsimtext,ifinfo}%
 
 Displays information about an imagefile.
 
@@ -229,7 +219,7 @@ Displays information about an imagefile.
   \item --help
 \end{itemize}
 
-\subsection{phm2pj}\label{phm2pj}\index{ctsimtext,phm2pj}%
+\section{phm2pj}\label{phm2pj}\index{ctsimtext,phm2pj}%
 Simulates collection of X-rays data (projections) around a phantom object.
 
 \usage
@@ -270,7 +260,7 @@ a rotation angle of 1 and for equilinear and equiangular geometries use a rotati
 
 The Herman phantom is taken with permission from Gabor Hermans 1980 book\cite{HERMAN80}. The Shepp-Logan phantom was published in 1974\cite{SHEPP74}.
 
-\subsection{phm2if}\label{phm2if}\index{ctsimtext,phm2if}%
+\section{phm2if}\label{phm2if}\index{ctsimtext,phm2if}%
 Converts a geometric phantom object into an imagefile. The size of the
 imagefile in pixels must be specified as well as the number of samples
 to average per pixel.
@@ -280,14 +270,14 @@ to average per pixel.
   \item --nsamples
 \end{itemize}
 
-\subsection{pj2if}\label{pj2if}\index{ctsimtext,pj2if}%
+\section{pj2if}\label{pj2if}\index{ctsimtext,pj2if}%
 Convert a projection file into an imagefile.
 
 \usage
 \begin{itemize}\itemsep=0pt
 \end{itemize}
 
-\subsection{pjinfo}\label{pjinfo}\index{ctsimtext,pjinfo}%
+\section{pjinfo}\label{pjinfo}\index{ctsimtext,pjinfo}%
 Displays information about a projection file.
 
 \usage
@@ -299,59 +289,55 @@ Displays information about a projection file.
   \item --dump
 \end{itemize}
 
-\subsection{pjrec}\label{pjrec}\index{ctsimtext,pjrec}%
+\section{pjrec}\label{pjrec}\index{ctsimtext,pjrec}%
 Reconstructs the interior of an object from a projection file.
 
 \usage
-\begin{itemize}\itemsep=0pt
-  \item Filter \par
-  Selects which filter to apply to each projection. To
-  properly reconstruct an image, this filter should be multiplied 
-  by the absolute value of distance from zero frequency.
+\begin{twocollist}
+\twocolitemruled{{\bf Parameter}}{{\bf Options}}
+\twocolitem{{\bf --filter}}{Selects which filter to apply to each projection. To properly reconstruct an image, this filter should be multiplied 
+by the absolute value of distance from zero frequency.
   \begin{itemize}\itemsep=0pt
     \item abs_bandlimit
     \item abs_cosine
     \item abs_hamming
-  \end{itemize}
-
-  \item Filter Parameter \par
-  Sets the alpha level for Hamming
-  window. At setting of 0.54, this equals the Hanning window.
-
-  \item Filter Method
-    \begin{itemize}\itemsep=0pt
-      \item convolution
+  \end{itemize}}
+  \twocolitem{{\bf --filter-parameter}}{Sets the alpha level for Hamming
+  window. At setting of 0.54, this equals the Hanning window.}
+  \twocolitem{{\bf --filter-method}}{Selects the filtering method. For large numbers of detectors, {\tt rfftw} is optimal. For smaller numbers of detectors, {\tt convolution} might be a bit faster. 
+\begin{itemize}\itemsep=0pt
+\item convolution
       \item fourier
       \item fourier_table
       \item fftw
       \item rfftw
-    \end{itemize}
-
-  \item Filter Generation
-    \begin{itemize}\itemsep=0pt
-      \item direct
-      \item inverse_fourier
-    \end{itemize}
-
-  \item Interpolation
-    \begin{itemize}\itemsep=0pt
-      \item nearest
-      \item linear
-    \end{itemize}
-     
-  \item Backprojection
-    \begin{itemize}\itemsep=0pt
-      \item trig
-      \item table
-      \item diff
-      \item diff2
-      \item idiff2
-      \item idiff3
-    \end{itemize}
-
-  \item Zeropad
-  \item Preinterpolation Factor
+\end{itemize}}
+  \twocolitem{{\bf --filter-generation}}{Selects the filter generation. With convolution, {\tt direct} is the proper method to select. With any of the frequency methods, {\tt inverse-fourier} is the best method.
+\begin{itemize}\itemsep=0pt
+\item direct
+      \item inverse-fourier
+\end{itemize}
+}
+  \twocolitem{{\bf --interpolation}}{Interpolation technique. {\tt linear} is optimal.
+\begin{itemize}\itemsep=0pt
+\item nearest
+\item linear
 \end{itemize}
+}    
+  \twocolitem{{\bf -backprojection}}{Selects the backprojection technique. A setting of {\tt idiff3} is optimal.
+\begin{itemize}\itemsep=0pt
+\item trig
+\item table
+\item diff
+\item diff2
+\item idiff2
+\item idiff3
+\end{itemize}
+}
+\twocolitem{{\bf --zeropad}}{ Zeropad factor. A setting of {\tt 1} is optimal.}
+
+  \twocolitem{{\bf --preinterpolate}}{Selects preinterpolation interpolation technique and sets the preinterpolation factor. Currently, this is experimental and does not work well.}
+\end{twocollist}
 
 \chapter{The Web Browser CGI Interface}\label{webinterface}\index{Web Interface}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
@@ -365,7 +351,6 @@ performed both visually by an image subtraction as well as by standard
 statistics as described by Herman\cite{HERMAN80}.
 
 \section{Requirements}\index{Web Interface,Requirements}%
-\begin{itemize}\itemsep=0pt
    \begin{itemize}\itemsep=0pt
       \item Apache or other CGI compatible web server