r499: no message
[ctsim.git] / doc / ctsim-gui.tex
index a8df9fefd88a13aec50fe38c7f34f637c3a5fb70..420e56d5220a60acadba111912d1b731772316e6 100644 (file)
 \setfooter{\thepage}{}{}{}{}{\thepage}%
 
 \section{Overview}
-\ctsim is the graphical shell for the CTSim project. It is
+\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.
+the command-line tool \ctsimtext\ as well as image processing and visualization features.
 
-\ctsim can open projection files, image files, phantom definition files, and plotfiles.
+\ctsim\ can open projection files, image files, phantom definition files, and plotfiles.
 
 \usage
 ctsim [OPTIONS] [files to open...]
 
 \section{Files Supported}
 \subsection{Phantom}
+Phantom files are supported. Besides loading phantom files from
+the disk, the Herman and Shepp-Logan phantoms are built-in to CTSim.
+Phantom files can be read and stored on the disk. However, a text
+editor is required to create and edit these files.
 \subsection{Image}
+Image files are 2-dimensional files stored a 4-byte floating point values.
+They are stored in little-endian format and \ctsim\ incorporates routines
+to read and write files correctly on both big and little endian architextures.
+
+Images files can be either real or complex valued. Typically, all images
+are real except for images that have been processed by Fourier transforms.
+
 \subsection{Projection}
+Projection files are created from Phantom files during the projection process.
+Numerous options are available for creation of the these files.
+
 \subsection{Plot}
+Plot files are created by CTSim during analysis of image files. They can be
+read and stored on the disk. They are stored as ASCII files for easy
+cross-platform support.
 
 \section{Phantom Menus}
 
+\subsection{Rasterize Dialog}
+This creates an image file from a phantom. Technically, it converts
+the phantom from a vector (infinite resolution) object into defined resolution
+image. The parameters to set are:
+
+x-size   Number of columns in image file
+y-size   Number of rows in image file
+samples  Numbers of samples taken per pixel in the x and y directions.
+         For example, if the nsamples is set to \texttt{3}, then for every
+         pixel in the image file, 9 samples (3 x 3) are averaged.
+
+\subsection{Projection Dialog}
+This creates a projection file from a phantom.
+
 \section{Image Menus}
+\subsection{File - Properties}
+Properties of image files include
+%\begin{itemize}\itemsep=0
+%\item Whether the image is real or complex valued
+%\item Numeric statistics
+%\item Image file labels
+%\end{itemize}
+
+\subsection{View}
+These options are for change the intensity scale for viewing the image.
+They do not change the image data.
+
+\subsection{Image}
+These commands create a new image based upon the current image,
+and for some commands, also a comparison image.
+
+\subsection{Filter}
+These commands filter image.
+
+\subsection{Anaylze}
+These commands are used for analyzing an image.
 
 \section{Projection Menus}
+\subsection{Process - Convert Polar Dialog}\label{convertpolardialog}
+The parameters are \texttt{xsize}, \texttt{ysize}, and \texttt{interpolation}.
+The \texttt{xsize} and \texttt{ysize} parameters set the size of the 
+resulting image file. The \texttt{interpolation} parameter selects the
+interpolation method. Currently, the \texttt{bilinear} option provides
+the highest quality interpolation.
+
+\subsection{Process - Convert FFT Polar Dialog}
+The paramters for this option are the same as 
+\helprefn{convertpolardialog}{Convert Polar Dialog}. For this command,
+though, the projections are Fourier transformed prior to conversion to
+polar image.
+
+\subsection{Reconstruct - Filtered Backprojection Dialog}
+This dialog sets the parameters for reconstructing an image from projections
+using the Filtered Backprojection technique. The parameters are identical
+to those for the \helprefn{pjrec}{pjrec} program.
 
 \section{Plot Menus}
+\subsection{File - Properties}
+
+\subsection{File - Save}
+Plot files can be saved. They are saved in an ASCII text format.
+
+\subsection{View Menu}
+These commands set the scaling for the y-axis.
+\subsubsection{Set}
+\subsubsection{Auto}
+\subsubsection{Full}
+