X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fctsim-textui.tex;fp=doc%2Fctsim-textui.tex;h=6a4a67531bb9c47510b5ec0f7564817c0d193f13;hb=befd71a7157339b52a0c40359518d5276b25d127;hp=5a7976fc5adccab637efce9c7565be052f989a69;hpb=d3fa225aa232e132cc198672c4fc148f96a1ab8c;p=ctsim.git

diff --git a/doc/ctsim-textui.tex b/doc/ctsim-textui.tex
index 5a7976f..6a4a675 100644
--- a/doc/ctsim-textui.tex
+++ b/doc/ctsim-textui.tex
@@ -4,14 +4,28 @@
 
 \ctsimtext\ is a master shell for all of the command-line utilities.
 
-\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 \texttt{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 \par
-\texttt{ctsimtext function-name parameters...}.
+\usage \ctsimtext\ can be invoked via three different
+methods.
+\begin{itemize}\itemsep=0pt
+\item \ctsimtext\ can 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
+\texttt{quit} command.
+
+\item \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\\ \texttt{ctsimtext function-name parameters...}.
+
+\item Using operating systems that support soft or hard linking of
+files (such as UNIX and Linux), the executable file \ctsimtext\ can
+be linked to the function names. This is automatically done by
+the installation file for Linux. Thus, to use \ctsimtext\ with the
+function name \texttt{pjrec}, the below command can be executed:\\
+\texttt{pjrec parameters...}
 
-The available functions are:
+\end{itemize}
 
 \section{if1}\label{if1}\index{ctsimtext,if1}%
 Perfoms math functions on a single image.
@@ -112,13 +126,21 @@ phm2pj projection-file-name number-of-detectors number-of-views [options...]
 
   \item -\,-rotangle
     Sets the rotation amount as a multiple of pi. For parallel geometries use
-a rotation angle of 1 and for equilinear and equiangular geometries use a rotation angle of 2.
+a rotation angle of 1 and for equilinear and equiangular
+geometries use a rotation angle of 2. The default is to use to
+appropriate rotation angle based on the geometry.
+
+  \item -\,-view-ratio
+    Sets the field of view as a ratio of the diameter of the phantom.
+    For normal scanning, a value of 1.0 is fine.
 
-  \item -\,-field-of-view
-    Sets the field of view as a ratio of the diameter of the phantom. For parallel geometries, using a value of 1.0 is fine. For other geometies, this should be at least 1.3 to avoid artifacts.
+  \item -\,-scan-ratio
+    Sets the length of scanning as a ratio of the view diameter.
+    For normal scanning, a value of 1.0 is fine.
 
   \item -\,-focal-length
-    Sets the distance of the radiation source and detectors from the center of the object as a ratio of the radius of the object. For parallel geometries, a value of 1.0 is fine. For other geometries, this should be at least 2.0 to avoid artifacts.
+    Sets the distance of the radiation source and detectors from the center of the object as a ratio of the radius of the object.
+    For parallel geometries, a value of 1.0 is fine. For other geometries, this should be at least 2.0 to avoid artifacts.
 \end{itemize}
 
 The Herman phantom is taken with permission from Gabor Hermans 1980 book\cite{HERMAN80}. The Shepp-Logan phantom was published in 1974\cite{SHEPP74}.
@@ -131,6 +153,7 @@ to average per pixel.
 \usage
 \begin{itemize}\itemsep=0pt
   \item -\,-nsamples
+  \item -\,-view-ratio
 \end{itemize}
 
 \section{pj2if}\label{pj2if}\index{ctsimtext,pj2if}%
@@ -156,7 +179,6 @@ Displays information about a projection file.
 \section{pjrec}\label{pjrec}\index{ctsimtext,pjrec}%
 Reconstructs the interior of an object from a projection file.
 
-\usage
 \begin{twocollist}
 \twocolitemruled{\textbf{Parameter}}{\textbf{Options}}
 \twocolitem{\textbf{-\,-filter}}{Selects which filter to apply to
@@ -220,6 +242,5 @@ to select. With any of the frequency methods,
 \item direct
 \item inverse-fourier
 \end{itemize}
-
-\end{twocollist}
 }
+\end{twocollist}