r537: no message
[ctsim.git] / doc / ctsim-gui.tex
index a790baac9839ff0ee9e9f8b81f20aab206fee222..9436faf3e712ebe90b5c997b5c70d5fd8cfea3a3 100644 (file)
@@ -1,9 +1,9 @@
 \chapter{The Graphical User Interface}\label{ctsim}\index{ctsim}%
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+\setheader{{\it CHAPTER \thechapter}}{}{}{\ctsimheadtitle}{}{{\it CHAPTER \thechapter}}%
 \ctsimfooter%
 
 
-\section{Overview}
+\section{Overview}\index{Graphical shell}
 \ctsim\ is the graphical shell for the CTSim project. It utilizes
 using the \urlref{wxWindows}{http://www.wxwindows.org} library for
 cross-platform compatibility. The graphical shell is compatible
@@ -18,7 +18,7 @@ automatically open. \ctsim\ can open projection files, image
 files, phantom files, and plot files.
 
 
-\section{File Types Support}
+\section{File Types Support}\index{File types}
 
 Phantom and plot files are stored as ASCII text. In contrast,
 image and projection files are stored in binary format.
@@ -62,7 +62,27 @@ files for easy cross-platform support.
 These commands are present on the menus for all of the windows of
 \ctsim.
 
-\subsection{Preferences...}
+\subsection{Create Phantom...}\index{Create phantom dialog}
+This command brings up a dialog box showing the phantoms that are pre-programmed
+into \ctsim. After selecting one of these phantoms, the new window with that
+phantom will be generated. The pre-programmed phantoms are:
+
+\begin{description}\itemsep=0pt
+\item[Herman] The Herman head phantom\cite{HERMAN80}
+    \item[Shepp-Logan] The head phantom of Shepp \& Logan\cite{SHEPP74}
+\item[Unit pulse] A phantom that has a value of \texttt{1} for the
+center of the phantom and \texttt{0} everywhere else.
+\end{description}
+
+\subsection{Create Filter...}\index{Create filter dialog}
+This command brings up a dialog box showing the pre-programmed filters
+of \ctsim. This command will create a 2-dimensional image of the selected filter.
+The center of the filter is at the center of the image.
+
+These filters can be created in their natural frequency domain or in their spatial domain.
+
+
+\subsection{Preferences...}\index{Preferences}
 This command displays a dialog box that allows users to control
 the behavior of \ctsim. These options are saved across \ctsim sessions.
 Under Microsoft Windows environments, they are stored in the registry.
@@ -112,7 +132,7 @@ Displays the properties of a phantom which includes:
 \item A list of all component phantom elements
 \end{itemize}
 
-\subsection{Rasterize Dialog}
+\subsection{Rasterize Dialog}\index{Rasterize}
 This creates an image file from a phantom. Technically, it
 converts the phantom from a vector (infinite resolution) object
 into a 2-dimension array of floating-point pixels. The parameters
@@ -128,7 +148,7 @@ per pixel in both the x and y directions. For example, if the
 pixel in the image file 9 samples (3 x 3) are averaged.}
 \end{twocollist}
 
-\subsection{Projection Dialog}
+\subsection{Projection Dialog}\index{Projection collection}
 This creates a projection file from a phantom. The options
 available when collecting projections are:
 
@@ -182,7 +202,7 @@ Properties of image files include
   \item Image file labels
 \end{itemize}
 
-\subsection{File - Export}
+\subsection{File - Export}\index{Image export}
 This command allows for exporting image files to a standard
 graphics file format. This is helpful when you want to take an
 image and import it into another application. The current
@@ -260,7 +280,7 @@ include:
 \item Color scale
 \end{itemize}
 
-\subsection{Filter}
+\subsection{Filter}\index{Image filter}
 These commands filter and modify the image.
 
 \subsubsection{Arithmetic}
@@ -304,12 +324,13 @@ The displayed properties include:
 \item The variables used when generating the projections from the phantom
 \end{itemize}
 
-\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 Polar Dialog}\label{convertpolardialog}\index{Polar conversion}
+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 parameters for this option are the same as \helprefn{Convert
@@ -317,7 +338,7 @@ Polar Dialog}{convertpolardialog}. For this command, though, the
 projections are Fourier transformed prior to conversion to polar
 image.
 
-\subsection{Reconstruct - Filtered Backprojection Dialog}
+\subsection{Reconstruct - Filtered Backprojection Dialog}\index{Reconstruction dialog}
 This dialog sets the parameters for reconstructing an image from projections
 using the Filtered Backprojection technique.
 
@@ -384,7 +405,7 @@ technique. A setting of \texttt{idiff} 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.
+\texttt{inverse-fourier} is the best method.
 \begin{itemize}\itemsep=0pt
 \item direct
 \item inverse-fourier
@@ -398,11 +419,22 @@ frequency-based filtering. A setting of \texttt{1} is optimal.}
 
 \section{Plot Menus}
 \subsection{File - Properties}
-The displayed properties include
+The displayed properties include the number of curves in the plot
+and the number of points per curve. Additionally, the EZPlot
+commands used to format the plot are displayed.
 
 \subsection{View Menu}
 These commands set the scaling for the y-axis. They are analogous
 to the options used for setting the intensity scale for images.
+
 \subsubsection{Set}
+This command sets the upper and lower limits for the y-axis.
+
 \subsubsection{Auto}
+This command automatically sets the upper and lower limits for the
+y-axis. Please refer to the \texttt{View - Auto} documentation for
+image files for the details.
+
 \subsubsection{Full}
+The command resets the upper and lower limits of the y-axis to the
+minimum and maximum values of the curves.