r416: no message
[ctsim.git] / doc / tex2rtf / ctsim.tex
index be33ab4fbdd32aa3b0f49dcf45a6a20ac9826b2a..b4a8005d80e02f5da1a00a9e5c1cd8e3148fd16c 100644 (file)
@@ -5,6 +5,7 @@
 
 \newcommand{\ctsim}{{\tt CTSim}}
 \newcommand{\ctsimtext}{{\tt CTSimText}}
+\newcommand{\usage}{{\bf Usage \par}}
 
 \newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
 \newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
@@ -53,7 +54,7 @@ WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY
 OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 
-\chapter{Introduction}%
+\chapter{Introduction}\label{introduction}%
 \pagenumbering{arabic}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
@@ -61,8 +62,8 @@ PERFORMANCE OF THIS SOFTWARE.
 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.
-\ctsim simulates the process of projecting X-rays through a phantom object.
-\ctsim can then reconstruct the interior of the object from the projections
+\ctsim\ simulates the process of projecting X-rays through a phantom object.
+\ctsim\ can then reconstruct the interior of the object from the projections
 collected around the phantom object.
 
 \chapter{Installation}\index{Installation}%
@@ -88,7 +89,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}\index{Installation,Build,Requirements}%
+\section{Requirements}\index{Installation,Requirements}%
   \begin{itemize}\itemsep=0pt
   \item zlib Library (optional)
         \par Used for PNG file export.
@@ -110,12 +111,12 @@ 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}\index{ctsim}% 
+\chapter{ctsim - the Graphical User Interface}\label{ctsim}\index{ctsim}% 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
@@ -124,29 +125,29 @@ 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.
 
-\section{Usage}
-ctsim [OPTIONS] [files to open...]
+\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...]
 
-\chapter{ctsimtext - The Command Line Interface}\index{ctsimtext}%
-\ctsimtext is a master shell for all of the command-line utilities. 
+\chapter{ctsimtext}\index{ctsimtext}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
-\section{Usage}%
+\ctsimtext\ is a master shell for all of the command-line utilities. 
 
-\ctsimtext can be executed without any parameters. In that case, \ctsimtext
+\usage\
+\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 {\tt ctsimtext function-name parameters...}.
 
 The following function names are available:
 
-\subsection{if1}\label{if1}\index{Programs,ctsimtext,if1}%
+\subsection{if1}\label{if1}\index{ctsimtext,if1}%
 Perfoms math functions on a single image.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --invert
   \item --log
@@ -155,10 +156,10 @@ Perfoms math functions on a single image.
   \item --sqrt
 \end{itemize}
 
-\subsection{if2}\index{Programs,ctsimtext,if2}%
+\subsection{if2}\index{ctsimtext,if2}%
 Perfoms math functions on a two images.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --add
   \item --sub
@@ -168,10 +169,11 @@ Perfoms math functions on a two images.
   \item --row-plot
 \end{itemize}
 
-\subsection{ifinfo}\index{Programs,ctsimtext,ifinfo}%
+\subsection{ifinfo}\index{ctsimtext,ifinfo}%
 
 Displays information about an imagefile.
-\subsubsection{Usage}%
+
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --labels
   \item --no-labels
@@ -180,10 +182,10 @@ Displays information about an imagefile.
   \item --help
 \end{itemize}
 
-\subsection{ifexport}\index{Programs,ctsimtext,ifexport}%
+\subsection{ifexport}\index{ctsimtext,ifexport}%
 Export an imagefile to a standard graphics file.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --format
   \begin{itemize}\itemsep=0pt
@@ -212,10 +214,10 @@ Export an imagefile to a standard graphics file.
   \item --max
 \end{itemize}
 
-\subsection{phm2pj}\index{Programs,ctsimtext,phm2pj}%
+\subsection{phm2pj}\index{ctsimtext,phm2pj}%
 Simulates collection of X-rays data (projections) around a phantom object.
 
-\subsubsection{Usage}%
+\usage\
 phm2pj projection-file-name number-of-detectors number-of-views [options...]
 \begin{itemize}\itemsep=0pt
   \item --phantom
@@ -253,27 +255,27 @@ 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}\index{Programs,ctsimtext,phm2if}%
+\subsection{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.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --nsamples
 \end{itemize}
 
-\subsection{pj2if}\index{Programs,ctsimtext,pj2if}%
+\subsection{pj2if}\index{ctsimtext,pj2if}%
 Convert a projection file into an imagefile.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
 \end{itemize}
 
-\subsection{pjinfo}\index{Programs,ctsimtext,pjinfo}%
+\subsection{pjinfo}\index{ctsimtext,pjinfo}%
 Displays information about a projection file.
 
-\subsubsection{Usage}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item --binaryheader
   \item --binaryview
@@ -282,12 +284,10 @@ Displays information about a projection file.
   \item --dump
 \end{itemize}
 
-\subsection{pjrec}\index{Programs,ctsimtext,pjrec}%
+\subsection{pjrec}\index{ctsimtext,pjrec}%
 Reconstructs the interior of an object from a projection file.
 
-\subsubsection{Usage}%
-
-\subsubsection{Parameters}%
+\usage\
 \begin{itemize}\itemsep=0pt
   \item Filter 
   Selects which filter to apply to each projection. To
@@ -297,7 +297,6 @@ Reconstructs the interior of an object from a projection file.
     \item abs_bandlimit
     \item abs_cosine
     \item abs_hamming
-    \item abs_sinc
   \end{itemize}
 
   \item Filter Parameter 
@@ -352,16 +351,13 @@ statistics as described by Herman\cite{HERMAN80}.
 
 \section{Requirements}\index{Web Interface,Requirements}%
 \begin{itemize}\itemsep=0pt
-   \item For Web Interface
    \begin{itemize}\itemsep=0pt
       \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}
-
+      current web browsers support PNG.
   \end{itemize}
 
 \newpage