X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=doc%2Fctsim.tex;h=73deaf43dbbce8090180e9cdebb2bf174a68aff3;hp=bb38e0a1c920f3236b4a6981593a4d07db33497d;hb=d3fa225aa232e132cc198672c4fc148f96a1ab8c;hpb=711cae0ee02e046370fdb4d6c6f440596ff71980 diff --git a/doc/ctsim.tex b/doc/ctsim.tex index bb38e0a..73deaf4 100644 --- a/doc/ctsim.tex +++ b/doc/ctsim.tex @@ -1,75 +1,116 @@ -\documentclass[11pt,texhelp]{report} -\usepackage[dvips]{graphics} +\documentclass[11pt]{report}% +\usepackage{graphicx} +\usepackage{texhelp} +\usepackage{fancyhea} +%\usepackage{mysober} +\usepackage{mytitle} +%\usepackage{verbatim} +\usepackage{makeidx} +%\usepackage{times} +\usepackage{hyperref} +\input{psbox.tex} + +\latexonly{\includeonly{ctsim-concepts,ctsim-install,ctsim-gui,ctsim-textui,ctsim-web,ctsim-appendix}} +\hyphenation{poly-gon-al} + +\newcommand{\ctsim}{\texttt{CTSim}} +\newcommand{\ctsimtext}{\texttt{CTSimText}} +\newcommand{\usage}{\textbf{Usage}\par} + +\newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}% +\newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}% +\newcommand{\commandpageref}[2]{\latexignore{\helprefn{{\tt $\backslash$#1}}{#2}}\latexonly{{\tt $\backslash$#1} {\it page \pageref{#2}}}\index{#1}} +\newcommand{\indexit}[1]{#1\index{#1}}% +\newcommand{\inioption}[1]{{\bf {\tt #1}}\index{#1}}% + +\latexignore{\newcommand{\sqrt}[2]{sqrt(#2)}}% + +\parskip=10pt% +\parindent=0pt% +%\backgroundcolour{255;255;255}\textcolour{0;0;0}% Has an effect in HTML only +\title{CTSim 3.0 User Manual}% +\author{Kevin Rosenberg, M.D.}% +\date{February 9, 2001}% +\makeindex% + +\begin{document}% +\maketitle% +\pagestyle{fancyplain}% +\pagenumbering{roman}% + +\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% +\parskip=2pt +\tableofcontents% + +\parskip=10pt +\chapter*{Copyright notice}% +\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +Copyright (c) 1983-2001 Kevin Rosenberg, M.D. + +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose is hereby granted without fee, provided that the +above copyright notice, author statement and this permission notice appear in +all copies of this software and related documentation. + +THE SOFTWARE IS PROVIDED ``AS-IS'' AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, +IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF +MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. + +IN NO EVENT SHALL KEVIN ROSENBERG BE LIABLE FOR ANY +SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR +ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, +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. + +\chapter{Introduction}\label{introduction}% +\pagenumbering{arabic}% +\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% + +$$\image{3cm;3cm}{logo-huge.eps}$$ +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. +\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. + +This manual begins with an introduction into the concepts of +\rtfsp\ctsim. Then, the graphical shell, \helprefn{ctsim}{ctsim}, +is documented followed the the command-line shell, +\helprefn{ctsimtext}{ctsimtext}. Finally, the web-based +\helprefn{interface}{webinterface} is discussed followed by +\helprefn{installation}{installation} instructions. + +I hope that you enjoy \ctsim! + +\include{ctsim-concepts} + +\include{ctsim-gui} + +\include{ctsim-textui} + +\include{ctsim-web} + +\include{ctsim-install} + +\include{ctsim-appendix} + +\newpage + +\bibliographystyle{plain} +\bibliography{ctsim} +\addcontentsline{toc}{chapter}{Bibliography} +\setheader{{\it REFERENCES}}{}{}{}{}{{\it REFERENCES}}% +\setfooter{\thepage}{}{}{}{}{\thepage}% -\begin{document} +\addcontentsline{toc}{chapter}{Index} +\setheader{{\it INDEX}}{}{}{}{}{{\it INDEX}} % +\setfooter{\thepage}{}{}{}{}{\thepage} % +\printindex % -\newcommand{\ctsim}{{\tt ctsim}} - - -\title{CTSim - An Open-Source Computed Tomography Simulator} -\author{Kevin Rosenberg, MD\footnote{San Juan Regional Medical Center, 801 W. Maple, Farmington NM 87401. Phone: (505) 599-6103. E-mail: kevin@rosenberg.net}} -\date{July 2000} -\maketitle - -\chapter{Introduction} -Computed Tomography is the process of taking projection of X-ray data -though and object and using sophisticated mathematics to estimate -information about the interior of that object. - -\chapter{Installation} -\subsection{Requirements} -\begin{itemize} - - \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} - -\subsection{Download} -\subsection{Install Binary Distribution} -\subsection{Build From Sources} - -\chapter{The Programs} - -\section{ctsim - The Graphical User Interface} -\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. - -\ctsim\ incorporates most of the capabilities of the CTSim -project. There are still functions that are only available to the -command line tools. - -\subsection{Usage} -ctsim [OPTIONS] [files to open...] - -\ctsim\ can open projection files and image files. - -\section{The Web Browser CGI Interface} -\subsection{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{tools - The Command Line Interface} -\subsection{phm2pj} -Converts a phantom object to a set of projections - -{\tt phm2pj} simulates the process of collection of X-Ray projection data -such as collected by a CT scanner. - -\subsection{pjrec} - -\subsection{phm2if} - -\bibliographystyle{abbrv} -\bibliography{yes} - - -\end{document} +\end{document}%