\newcommand{\ctsim}{{\tt CTSim}}
\newcommand{\ctsimtext}{{\tt CTSimText}}
-\newcommand{\usage}{{\bf Usage \par}}
+\newcommand{\usage}{{\bf Usage}{\par}}
\newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
\newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
\date{January 2001}%
}%
\winhelponly{\title{Manual for CTSim 3.0}%
-\author{by Kevin Rosenberg, M.D.\\$$\image{1cm;0cm}{logo-huge.bmp}$$}%
+\author{by Kevin Rosenberg, M.D.\\$$\image{3cm;3cm}{logo-huge.bmp}$$}%
}%
\makeindex%
\begin{document}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
-\winhelponly{\image{1cm;0cm}{logo-huge.bmp}\par}%
+\winhelponly{$$\image{3cm;3cm}{logo-huge}$$}%
Computed Tomography is a technique for estimating the interior of an object
from measurement of radiation collected around the object. This radiation
\rtfsp\ctsim\ can then reconstruct the interior of the object from the projections
collected around the phantom object.
+The \ctsim\ package has two executable files: the graphical \helprefn{ctsim}{ctsim} and text \helprefn{ctsimtext}{ctsimtext} programs.
+
\chapter{Installation}\index{Installation}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\section{Installing Windows Binary}\index{Installation,Windows}%
-\section{Build From Sources}%\index{Installation,Build}%
+\section{Build From Sources}\label{build}\index{Installation,Build}%
See the INSTALL file included in the source distribution for instructions.
-\section{Requirements}\index{Installation,Requirements}%
+\section{Requirements}\label{installreq}\index{Installation,Requirements}%
\begin{itemize}\itemsep=0pt
\item zlib Library (optional)
\par Used for PNG file export.
\ctsim\ can open projection files, image files, phantom definition files, and plotfiles.
-\usage\
+\usage
ctsim [OPTIONS] [files to open...]
-\chapter{ctsimtext}\index{ctsimtext}%
+\chapter{ctsimtext}\label{ctsimtext}\index{ctsimtext}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\ctsimtext\ is a master shell for all of the command-line utilities.
-\usage\
+\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.
The following function names are available:
+\helprefn{if1}{if1}\par
+\helprefn{if2}{if2}\par
+\helprefn{ifexport}{ifexport}\par
+\helprefn{ifinfo}{ifinfo}\par
+\helprefn{phm2if}{phm2if}\par
+\helprefn{phm2pj}{phm2pj}\par
+\helprefn{pj2if}{pj2if}\par
+\helprefn{pjinfo}{pjinfo}\par
+\helprefn{pjrej}{pjrec}\par
+
\subsection{if1}\label{if1}\index{ctsimtext,if1}%
Perfoms math functions on a single image.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\item --invert
\item --log
\item --sqrt
\end{itemize}
-\subsection{if2}\index{ctsimtext,if2}%
+\subsection{if2}\label{if2}\index{ctsimtext,if2}%
Perfoms math functions on a two images.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\item --add
\item --sub
\item --row-plot
\end{itemize}
-\subsection{ifinfo}\index{ctsimtext,ifinfo}%
-
-Displays information about an imagefile.
-
-\usage\
-\begin{itemize}\itemsep=0pt
- \item --labels
- \item --no-labels
- \item --stats
- \item --no-stats
- \item --help
-\end{itemize}
-
-\subsection{ifexport}\index{ctsimtext,ifexport}%
+\subsection{ifexport}\label{ifexport}\index{ctsimtext,ifexport}%
Export an imagefile to a standard graphics file.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\item --format
\begin{itemize}\itemsep=0pt
\item --max
\end{itemize}
-\subsection{phm2pj}\index{ctsimtext,phm2pj}%
+\subsection{ifinfo}\label{ifinfo}\index{ctsimtext,ifinfo}%
+
+Displays information about an imagefile.
+
+\usage
+\begin{itemize}\itemsep=0pt
+ \item --labels
+ \item --no-labels
+ \item --stats
+ \item --no-stats
+ \item --help
+\end{itemize}
+
+\subsection{phm2pj}\label{phm2pj}\index{ctsimtext,phm2pj}%
Simulates collection of X-rays data (projections) around a phantom object.
-\usage\
+\usage
phm2pj projection-file-name number-of-detectors number-of-views [options...]
\begin{itemize}\itemsep=0pt
\item --phantom
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{ctsimtext,phm2if}%
+\subsection{phm2if}\label{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.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\item --nsamples
\end{itemize}
-\subsection{pj2if}\index{ctsimtext,pj2if}%
+\subsection{pj2if}\label{pj2if}\index{ctsimtext,pj2if}%
Convert a projection file into an imagefile.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\end{itemize}
-\subsection{pjinfo}\index{ctsimtext,pjinfo}%
+\subsection{pjinfo}\label{pjinfo}\index{ctsimtext,pjinfo}%
Displays information about a projection file.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
\item --binaryheader
\item --binaryview
\item --dump
\end{itemize}
-\subsection{pjrec}\index{ctsimtext,pjrec}%
+\subsection{pjrec}\label{pjrec}\index{ctsimtext,pjrec}%
Reconstructs the interior of an object from a projection file.
-\usage\
+\usage
\begin{itemize}\itemsep=0pt
- \item Filter
+ \item Filter \par
Selects which filter to apply to each projection. To
properly reconstruct an image, this filter should be multiplied
by the absolute value of distance from zero frequency.
\item abs_hamming
\end{itemize}
- \item Filter Parameter
- \par Sets the alpha level for Hamming
+ \item Filter Parameter \par
+ Sets the alpha level for Hamming
window. At setting of 0.54, this equals the Hanning window.
\item Filter Method
\item Preinterpolation Factor
\end{itemize}
-\chapter{The Web Browser CGI Interface}\index{Web Interface}%
+\chapter{The Web Browser CGI Interface}\label{webinterface}\index{Web Interface}%
\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\printindex%
-\end{document}
+\end{document}%
+
projects / ctsim.git / blobdiff