projects / ctsim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
r449: Broken .tex file into chapters
[ctsim.git] / doc / tex2rtf / ctsim.tex
diff --git a/doc/tex2rtf/ctsim.tex b/doc/tex2rtf/ctsim.tex
index 9fd2aec2be85bda962217de4218c612f5e534795..6b42f8d311535b2e0ee71be973c78f200bfe347e 100644 (file)
--- a/doc/tex2rtf/ctsim.tex
+++ b/doc/tex2rtf/ctsim.tex
@@ -1,8 +1,17 @@
-\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}%
+\documentclass[11pt]{report}%
 %\input{psbox.tex}
 %\input{psbox.tex}
-
-\newcommand{\ctsim}{{\it CTSim}}
-\newcommand{\ctsimtext}{{\it CTSimText}}
+\usepackage{texhelp}
+\usepackage{fancyheadings}
+\usepackage{mysober}
+\usepackage{mytitle}
+\usepackage{verbatim}
+\usepackage{makeidx}
+\usepackage{times}
+\usepackage{hyperref}
+
+\newcommand{\ctsim}{{\tt CTSim}}
+\newcommand{\ctsimtext}{{\tt CTSimText}}
+\newcommand{\usage}{{\bf Usage}{\par}}
 
 \newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
 \newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
 
 \newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
 \newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
@@ -17,7 +26,7 @@
 \date{January 2001}%
 }%
 \winhelponly{\title{Manual for CTSim 3.0}%
 \date{January 2001}%
 }%
 \winhelponly{\title{Manual for CTSim 3.0}%
-\author{by Julian Smart\\$$\image{1cm;0cm}{tex2rtf.wmf}$$}%
+\author{by Kevin Rosenberg, M.D.\\$$\image{3cm;3cm}{logo-huge.bmp}$$}%
 }%
 \makeindex%
 \begin{document}%
 }%
 \makeindex%
 \begin{document}%
@@ -25,6 +34,7 @@
 \pagestyle{fancyplain}%
 \bibliographystyle{plain}%
 \pagenumbering{roman}%
 \pagestyle{fancyplain}%
 \bibliographystyle{plain}%
 \pagenumbering{roman}%
+
 \setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 \tableofcontents%
 \setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 \tableofcontents%
@@ -51,322 +61,44 @@ WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY
 OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 
 OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 
-\chapter{Introduction}%
+\chapter{Introduction}\label{introduction}%
 \pagenumbering{arabic}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \pagenumbering{arabic}%
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
+\winhelponly{$$\image{3cm;3cm}{logo-huge}$$}%
+\htmlonly{$$\image{3cm;3cm}{logo-huge.gif}$$}%
 Computed Tomography is a technique for estimating the interior of an object 
 from measurement of radiation collected around the object. This radiation 
 can be either projected through or emitted from the object.
 Computed Tomography is a technique for estimating the interior of an object 
 from measurement of radiation collected around the object. This radiation 
 can be either projected through or emitted from the object.
-\ctsim simulates the process of projecting X-rays through a phantom object.
-\ctsim can then reconstruct the interior of the object from the projections
+\rtfsp\ctsim simulates the process of projecting X-rays through a phantom object.
+\rtfsp\ctsim can then reconstruct the interior of the object from the projections
 collected around the phantom object.
 
 collected around the phantom object.
 
-\chapter{Installation}\index{Installation}%
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
-
-\section{Download}%\index{Installation,Download}%
-
-The latest version of CTSim, plus source code, can be accessed from:
-
-\begin{verbatim}
-http://www.ctsim.org
-ftp://ftp.ctsim.org
-\end{verbatim}
-
-It is available in Windows 95/NT/2000 and Linux GUI versions and non-GUI versions.
-
-\section{Installing Linux RPM}\index{Installation,Linux}%
-
-\section{Installing Windows Binary}\index{Installation,Windows}%
-
-\section{Build From Sources}%\index{Installation,Build}%
-
-See the INSTALL file included in the source distribution for instructions.
-
-\section{Requirements}\index{Installation,Build,Requirements}%
-  \item Building CTSim
-  \begin{itemize}\itemsep=0pt
-  \item zlib Library (optional)
-        \par Used for PNG file export.
-
-  \item libpng Library (optional)
-        \par Used for PNG file export.
-       \par www.libpng.org
-
-  \item FFTW library (optional)
-       \par Used for frequency-based filtering and fourier transformations of images.
-       \par www.fftw.org
-
-  \item readline library (optional)
-       /par Used for {/ctsimtext} interactive shell.
-
-  \item dmalloc library (optional)
-       \par Used for debugging memory allocation
-       \par www.dmalloc.com
-
-  \item wxWindows library (optional) \par Used for
-  platform-independent graphical interface. The graphical-shell
-  program \ctsim requires this library.  \par www.wxwindows.org
-
-  \end{itemize}
-\end{itemize}
-
-\chapter{ctsim - the Graphical User Interface}%\index{ctsim}% 
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
-
-\ctsim\ is the graphical shell for the CTSim project. It is
-written using the wxLibrary for cross-platform compatibility with GTK,
-Motif, and Microsoft Windows. It includes all of the functionality of
-the command-line tool {\tt ctsimtext} as well as image processing and visualization features.
-
-\section{Usage}
-ctsim [OPTIONS] [files to open...]
-
-\ctsim can open projection files, image files, phantom definition files, and plotfiles.
-
-\chapter{ctsimtext - The Command Line Interface}\index{ctsimtext}%
-\ctsimtext is a master shell for all of the command-line utilities. 
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
-
-\section{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.
-
-\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 {\tt ctsimtext function-name parameters...}.
-
-The following function names are available:
+The \ctsim package has two executable files: the graphical \helprefn{ctsim}{ctsim} and text \helprefn{ctsimtext}{ctsimtext} programs.
 
 
-\subsection{if1}\index{Programs,ctsimtext,if1}%
-Perfoms math functions on a single image.
+\include{ctsim-concepts}
 
 
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --invert
-  \item --log
-  \item --exp
-  \item --sqr
-  \item --sqrt
-\end{itemize}
+\include{ctsim-install}
 
 
-\subsection{if2}\index{Programs,ctsimtext,if2}%
-Perfoms math functions on a two images.
+\include{ctsim-gui}
 
 
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --add
-  \item --sub
-  \item --mul
-  \item --comp
-  \item --column-plot
-  \item --row-plot
-\end{itemize}
+\include{ctsim-textui}
 
 
-\subsection{ifinfo}\index{Programs,ctsimtext,ifinfo}%
+\include{ctsim-web}
 
 
-Displays information about an imagefile.
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --labels
-  \item --no-labels
-  \item --stats
-  \item --no-stats
-  \item --help
-\end{itemize}
+\newpage
 
 
-\subsection{ifexport}\index{Programs,ctsimtext,ifexport}%
-Export an imagefile to a standard graphics file.
-
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --format
-  \begin{itemize}\itemsep=0pt
-    \item --pgm
-    \item --pgmasc
-    \item --png
-    \item --png16
-  \end{itemize}
-  \item --center
-  \begin{itemize}\itemsep=0pt
-    \item median
-    \item mode
-    \item mean
-  \end{itemize}
-  \item --auto
-  \begin{itemize}\itemsep=0pt
-     \item --full
-     \item --std0.1
-     \item --std0.5
-     \item --std1
-     \item --std2
-     \item --std3
-  \end{itemize}
-  \item --scale
-  \item --min
-  \item --max
-\end{itemize}
-
-\subsection{phm2pj}\index{Programs,ctsimtext,phm2pj}%
-Simulates collection of X-rays data (projections) around a phantom object.
-
-\subsubsection{Usage}%
-phm2pj projection-file-name number-of-detectors number-of-views [options...]
-\begin{itemize}\itemsep=0pt
-  \item --phantom
-  Select a standard phantom 
-  \begin{itemize}\itemsep=0pt
-    \item herman
-    \item herman-b
-    \item shepp-logan
-    \item shepp-logan-b
-  \end{itemize}
-
-  \item --phmfile
-  Load a phantom definition definition
-
-  \item --geometry
-  \begin{itemize}\itemsep=0pt
-    \item parallel
-    \item equiangular
-    \item equilinear
-  \end{itemize}
-
-  \item --nray
-    Number of samples per each detector
-
-  \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.
-
-  \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 --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.
-\end{itemize}
-
-\subsection{phm2if}\index{Programs,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.
-
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --nsamples
-\end{itemize}
-
-\subsection{pj2if}\index{Programs,ctsimtext,pj2if}%
-Convert a projection file into an imagefile.
-
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-\end{itemize}
-
-\subsection{pjinfo}\index{Programs,ctsimtext,pjinfo}%
-Displays information about a projection file.
-
-\subsubsection{Usage}%
-\begin{itemize}\itemsep=0pt
-  \item --binaryheader
-  \item --binaryview
-  \item --startview
-  \item --endview
-  \item --dump
-\end{itemize}
-
-\subsection{pjrec}\index{Programs,ctsimtext,pjrec}%
-Reconstructs the interior of an object from a projection file.
-
-\subsubsection{Usage}%
-
-\subsubsection{Parameters}%
-\begin{itemize}\itemsep=0pt
-  \item Filter 
-  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.
-  \begin{itemize}\itemsep=0pt
-    \item abs_bandlimit
-    \item abs_cosine
-    \item abs_hamming
-    \item abs_sinc
-  \end{itemize}
-
-  \item Filter Parameter 
-  \par Sets the alpha level for Hamming
-  window. At setting of 0.54, this equals the Hanning window.
-
-  \item Filter Method
-    \begin{itemize}\itemsep=0pt
-      \item convolution
-      \item fourier
-      \item fourier_table
-      \item fftw
-      \item rfftw
-    \end{itemize}
-
-  \item Filter Generation
-    \begin{itemize}\itemsep=0pt
-      \item direct
-      \item inverse_fourier
-    \end{itemize}
-
-  \item Interpolation
-    \begin{itemize}\itemsep=0pt
-      \item nearest
-      \item linear
-    \end{itemize}
-     
-  \item Backprojection
-    \begin{itemize}\itemsep=0pt
-      \item trig
-      \item table
-      \item diff
-      \item diff2
-      \item idiff2
-      \item idiff3
-    \end{itemize}
-
-  \item Zeropad
-  \item Preinterpolation Factor
-\end{itemize}
-
-\chapter{The Web Browser CGI Interface}\index{Web Interface}%
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\bibliographystyle{plain}
+\bibliography{ctsim}
+\addcontentsline{toc}{chapter}{Bibliography}
+\setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
-\section{Overview}\index{Web Interface,Overview}%
-The CGI program {\tt ctsim.cgi} takes projections of a standard
-phantom object, performs reconstruction, and then compares the
-rasterized phantom object with the reconstruction. The comparison is
-performed both visually by an image subtraction as well as by standard
-statistics as described by Herman\cite{HERMAN80}.
-
-\section{Requirements}\index{Web Interface,Requirements}%
-\begin{itemize}\itemsep=0pt
-   \item For Web Interface
-   \begin{itemize}\itemsep=0pt
-      \item Apache or other CGI compatible web server
-
-      \item Perl (version 4.0 or higher)
-
-      \item A client web browser than can display PNG files. Most
-      current web browswer do support PNG.
-    \end{itemize}
-
-  \end{itemize}
-
-\bibliographystyle{abbrv}
-\bibliography{yes}
-
 \addcontentsline{toc}{chapter}{Index}
 \addcontentsline{toc}{chapter}{Index}
-\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
-\printindex%
+\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}} %
+\setfooter{\thepage}{}{}{}{}{\thepage} %
+\printindex %
 
 
-\end{document} 
+\end{document}%
+ 
Computed Tomography simulator and reconstructor