r548: no message
[ctsim.git] / doc / ctsim-textui.tex
index cfcea75191616614ced5d821e317c9f7b6c1101d..409f580877c6ac2f6afaf26526a11a296fca8beb 100644 (file)
@@ -3,11 +3,11 @@
 \ctsimfooter%
 
 \section{Overview}\index{Command line interface}
-\ctsimtext\ is a master shell for all of the command-line utilities. The
-command-line utilities can perform most of the functions of the graphical
+\ctsimtext\ is a master shell for all of the command-line tools. The
+command-line tools can perform most of the functions of the graphical
 shell. These command-line utilities are especially appropriate for use on
-systems without graphical capability, batch processing, shell scripting,
-and parallel processing with a Beowulf-type computer cluster.
+systems without graphical capability or for batch processing, shell scripting,
+and parallel processing.
 
 \usage \ctsimtext\ can be invoked via three different
 methods.
@@ -31,13 +31,13 @@ be linked to the function names. This is automatically done by
 the installation program and the \texttt{rpm} manager. Thus, to use \ctsimtext\ with the
 function name \texttt{pjrec}, the below command can be executed:\\
 \hspace*{1.5cm}\texttt{pjrec parameters...} \\
-as a shortcut rather than the equivalent command \\
+as a shortcut rather to the equivalent command \\
 \hspace*{1.5cm}\texttt{ctsimtext pjrec parameters...}
 
 \end{enumerate}
 
 \section{Parallel Processing}\index{Parallel processing}
-\ctsimtext\ can be used to spread it's processing over a cluster. Specifically,
+\ctsimtext\ can distribute it's processing over a cluster. Specifically,
 \ctsimtext\ supports the \urlref{LAM}{http://www.mpi.nd.edu/lam} version of
 the MPI environment. On platforms with LAM installed, a parallel version of
 \ctsimtext\ is created. The name of this program is \texttt{ctsimtext-lam}.
@@ -55,7 +55,7 @@ a 16-CPU \urlref{Beowulf}{http://www.beowulf.org} cluster.
 
 \section{if1}\label{if1}\index{if1}%
 Performs math functions on a single image. The commands works with
-both real and complex valued images.
+both real and complex-valued images.
 
 \usage
 \texttt{if1 input-filename output-filename [options...]}
@@ -72,7 +72,7 @@ both real and complex valued images.
 
 \section{if2}\label{if2}\index{if2}%
 Performs math functions on a two images. The command works with both
-real and complex valued images.
+real and complex-valued images.
 
 \usage
 \texttt{if2 input-filename1 input-filename2 output-filename [options...]}
@@ -94,7 +94,7 @@ real and complex valued images.
 Export an image file to a standard graphics file.
 
 \usage
-\texttt{ifexport input-filename output-filename -\,-format }\emph{graphic-format} \texttt{ [options...]}
+\texttt{ifexport input-filename output-filename [options...]}
 
 \textbf{Options}
 
@@ -170,7 +170,8 @@ Simulates collection of X-rays data (projections) around a phantom object.
 
 \twocolitem{\doublehyphen{nray}}{ Number of samples per each detector}
 
-\twocolitem{\doublehyphen{rotangle}}{The rotation angle as a multiple of pi.
+\twocolitem{\doublehyphen{rotangle}}{The rotation angle as a multiple of \latexonly{$\pi$.}
+\latexignore{pi.}
 For parallel geometries use a rotation angle of \texttt{1} and for equilinear and equiangular
 geometries use a rotation angle of \texttt{2}. The default is to use to
 appropriate rotation angle based on the geometry.}
@@ -189,16 +190,16 @@ appropriate rotation angle based on the geometry.}
 
 
 \section{phm2if}\label{phm2if}\index{phm2if}%
-Generates rasterized image file based on a phantom.
+Generates a raster image file based on a phantom.
 
 \usage
-\texttt{phm2if phantom-filename image-filename [options...]}
+\texttt{phm2if phantom-filename image-filename x-image-size y-image-size [options...]}
 
 \textbf{Options}
 
 \begin{twocollist}
-  \twocolitem{\doublehyphen{nsamples}}{Number of samples in x \& y directions per pixel}
-  \twocolitem{\doublehyphen{view-ratio}}{Sets the view ration. For normal scanning,
+  \twocolitem{\doublehyphen{nsamples}}{Number of samples in x and y directions per pixel}
+  \twocolitem{\doublehyphen{view-ratio}}{Sets the view ratio. For normal scanning,
   the default value of \texttt{1.0} is optimal.}
 \end{twocollist}
 
@@ -286,8 +287,8 @@ to select. With any of the frequency methods,
 \end{itemize}
 }
 
-\twocolitem{\doublehyphen{interpolation}}{Interpolation technique.
-\texttt{cubic} is optimal when the
+\twocolitem{\doublehyphen{interpolation}}{Interpolation technique during backprojection.
+\texttt{cubic} has optimal quality when the
 data is smooth. Smooth data is obtained by taking many projections and/or
 using a smoothing filter. In the absence of smooth data, \texttt{linear} gives better results and
 is many times faster than cubic interpolation.