\chapter{The Command Line Interface}\label{ctsimtext}\index{ctsimtext}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
+\setfooter{\thepage}{}{}{}{\manver}{\thepage}%
\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.
\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 -\,-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 -\,-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 -\,-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}.
\usage
\begin{itemize}\itemsep=0pt
\item -\,-nsamples
+ \item -\,-view-ratio
\end{itemize}
\section{pj2if}\label{pj2if}\index{ctsimtext,pj2if}%
\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
\item fftw
\item rfftw
\end{itemize}
-} \twocolitem{\textbf{-\,-interpolation}}{Interpolation technique.
+}
+
+\twocolitem{\textbf{-\,-filter-generation}}{Selects the filter
+generation. With convolution, \texttt{direct} is the proper method
+to select. With any of the frequency methods,
+\texttt{inverse-fourier} is the best method.
+\begin{itemize}\itemsep=0pt
+\item direct
+\item inverse-fourier
+\end{itemize}
+}
+
+\twocolitem{\textbf{-\,-interpolation}}{Interpolation technique.
\texttt{linear} is optimal.
\begin{itemize}\itemsep=0pt
\item nearest
\item cubic
\end{itemize}
}
-\end{twocollist}
-
-\subsection{Advanced Options}
-These options are only visible if \emph{Advanced Options} has been
-selected in the \texttt{File/Preferences} dialog.
-
-\begin{twocollist}
\twocolitem{\textbf{-\,-backprojection}}{Selects the
backprojection technique. A setting of \texttt{idiff} is optimal.
\begin{itemize}\itemsep=0pt
\twocolitem{\textbf{-\,-zeropad}}{Zeropad factor. A setting of
\texttt{1} is optimal.}
-\twocolitem{\textbf{-\,-filter-generation}}{Selects the filter
-generation. With convolution, \texttt{direct} is the proper method
-to select. With any of the frequency methods,
-\texttt{inverse-fourier} is the best method.
-\begin{itemize}\itemsep=0pt
-\item direct
-\item inverse-fourier
-\end{itemize}
-
\end{twocollist}
-}
projects / ctsim.git / blobdiff