X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fctsim-textui.tex;h=6a72fdace21e5c9dc21af74e2883155b1b396579;hb=3fe1c8e09462c4b44908fec9d309aa41908889c8;hp=0c123cccd421daee7e0fac5067325bacd63b5912;hpb=e5c753200f28fdf5542a48051ad79c7c7dfbb299;p=ctsim.git diff --git a/doc/ctsim-textui.tex b/doc/ctsim-textui.tex index 0c123cc..6a72fda 100644 --- a/doc/ctsim-textui.tex +++ b/doc/ctsim-textui.tex @@ -1,8 +1,12 @@ \chapter{The Command Line Interface}\label{ctsimtext}\index{ctsimtext}% -\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% +\setheader{{\it CHAPTER \thechapter}}{}{}{\ctsimheadtitle}{}{{\it CHAPTER \thechapter}}% \ctsimfooter% -\ctsimtext\ is a master shell for all of the command-line utilities. +\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 +shell. These command-line utilities are especially appropriate for use on +systems without graphics, batch files, and parallel processing in a Beowulf +computer cluster. \usage \ctsimtext\ can be invoked via three different methods. @@ -11,7 +15,9 @@ methods. \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. +\texttt{quit} command. \ctsimtext\ uses the +\urlref{readline}{http://www.gnu.org} library on UNIX and Linux platforms +to provide for command history processing. \item \ctsimtext\ can also be called to execute a single command. This is especially useful for batch @@ -29,7 +35,7 @@ as a shortcut rather than the equivalent command \\ \end{enumerate} -\section{Parallel Processing With a Computer Cluster} +\section{Parallel Processing} \ctsimtext\ can be used to spread 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 @@ -41,7 +47,7 @@ This parallel processing version has been tested with excellent results on a 16-CPU \urlref{Beowulf}{http://www.beowulf.org} cluster. -\section{if1}\label{if1}\index{ctsimtext,if1}% +\section{if1}\label{if1}\index{if1}% Performs math functions on a single image. \usage @@ -53,7 +59,7 @@ Performs math functions on a single image. \item \doublehyphen{sqrt} \end{itemize} -\section{if2}\label{if2}\index{ctsimtext,if2}% +\section{if2}\label{if2}\index{if2}% Performs math functions on a two images. \usage @@ -66,7 +72,7 @@ Performs math functions on a two images. \item \doublehyphen{row-plot} \end{itemize} -\section{ifexport}\label{ifexport}\index{ctsimtext,ifexport}% +\section{ifexport}\label{ifexport}\index{ifexport}% Export an image file to a standard graphics file. \usage @@ -98,7 +104,7 @@ Export an image file to a standard graphics file. \item \doublehyphen{max} \end{itemize} -\section{ifinfo}\label{ifinfo}\index{ctsimtext,ifinfo}% +\section{ifinfo}\label{ifinfo}\index{ifinfo}% Displays information about an imagefile. @@ -111,7 +117,7 @@ Displays information about an imagefile. \item \doublehyphen{help} \end{itemize} -\section{phm2pj}\label{phm2pj}\index{ctsimtext,phm2pj}% +\section{phm2pj}\label{phm2pj}\index{phm2pj}% Simulates collection of X-rays data (projections) around a phantom object. \usage @@ -154,7 +160,7 @@ appropriate rotation angle based on the geometry.} \end{twocollist} -\section{phm2if}\label{phm2if}\index{ctsimtext,phm2if}% +\section{phm2if}\label{phm2if}\index{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. @@ -166,7 +172,7 @@ to average per pixel. the default value of \texttt{1.0} is optimal.} \end{twocollist} -\section{pj2if}\label{pj2if}\index{ctsimtext,pj2if}% +\section{pj2if}\label{pj2if}\index{pj2if}% Convert a projection file into an imagefile. \usage @@ -176,7 +182,7 @@ Convert a projection file into an imagefile. \twocolitem{\doublehyphen{help}}{Print brief online help} \end{twocollist} -\section{pjinfo}\label{pjinfo}\index{ctsimtext,pjinfo}% +\section{pjinfo}\label{pjinfo}\index{pjinfo}% Displays information about a projection file. \usage @@ -188,7 +194,7 @@ Displays information about a projection file. \item \doublehyphen{dump} \end{itemize} -\section{pjrec}\label{pjrec}\index{ctsimtext,pjrec}% +\section{pjrec}\label{pjrec}\index{pjrec}% Reconstructs the interior of an object from a projection file. \begin{twocollist}