r1883: *** empty log message ***
[ctsim.git] / doc / ctsim-gui.tex
index 240855eb8a7d4ac93e61ba4bbb70b2e26e9fe8b4..a7fe7dc98dd9838b98177135c87b176c535f0c2a 100644 (file)
@@ -5,17 +5,16 @@
 
 \ctsim\ is the graphical shell for the CTSim project. This shell uses
 the \urlref{wxWindows}{http://www.wxwindows.org} library for
-cross-platform compatibility. The graphical shell is compatible
-with Microsoft Windows, \urlref{GTK}{http://www.gtk.org}, and
+cross-platform compatibility. The graphical shell is compatible with
+Microsoft Windows, \urlref{GTK}{http://www.gtk.org}, and
 \urlref{Motif}{http://www.openmotif.org} graphical environments.
 
 \section{Starting CTSim}
 \usage \texttt{ctsim [files to open...]}
 
-You can invoke \ctsim\ by itself on the command line, or include
-any number of files that you want \ctsim\ to
-automatically open. \ctsim\ can open projection files, image
-files, phantom files, and plot files.
+You can invoke \ctsim\ by itself on the command line, or include any
+number of files that you want \ctsim\ to automatically open. \ctsim\
+can open projection files, image files, phantom files, and plot files.
 
 On Microsoft Windows platforms, the simplest way to invoke \ctsim\ is
 via the \emph{Start} menu under the \emph{Programs} sub-menu.
@@ -142,6 +141,7 @@ At a setting of \texttt{0.54}, the Hamming filter is the same as the Hanning
 window.}
 \twocolitem{\textbf{Bandwidth}}{Sets the bandwidth of the filter.}
 \end{twocollist}
+
 \begin{twocollist}
 \twocolitem{\textbf{Axis (input) Scale}}{Sets the scale for the filter input. By default, the input to the filter is
 the distance in pixels from the center of the image. By changing this value, one can set a scale the input to the filter.
@@ -176,6 +176,19 @@ new installations. With this option set, \ctsim\ will log more events than
 usual. There extra events are not important for viewing with typical operation of
 \ctsim.}
 
+\twocolitem{\textbf{Show startup tips}}{This option is initially turned on in
+new installations. With this option set, \ctsim\ will display
+helpful tips when \ctsim\ is started.}
+
+\twocolitem{\textbf{Run background tasks}}{This option is initially turned off in
+new installations. With this option set, \ctsim\ execute lengthy calculations in the
+background. A background window will appear when processes are running in the background
+and will disappear when no background processes are executing. This background window shows
+the status and progress of all background processes. 
+\textbf{NOTE:} Due to limitations of \texttt{wxWindows}, this function is
+only supported on Microsoft Windows.
+}
+
 \end{twocollist}
 
 \subsection{File - Open}
@@ -199,6 +212,12 @@ Allows the saving of the contents of the active window to any file name.
 \subsection{Help - Contents}
 This command displays the online help.
 
+\subsection{Help - Tips}
+This command displays a dialog with tips on using \ctsim.
+
+\subsection{Help - Quick Start}
+This command displays a recommend approach to helping new users learn to use \ctsim.
+
 \subsection{Help - About}
 This command shows the version number and operating environment of \ctsim.
 
@@ -465,6 +484,10 @@ The displayed properties include:
 \item The parameters used when generating the projections from the phantom.
 \end{itemize}
 
+\subsection{Process - Convert Rectangular}
+The commands takes the projection data and creates an image file using
+the projection data.
+
 \subsection{Process - Convert Polar}\label{IDH_DLG_POLAR}\index{Polar conversion}
 This command creates an image file with the polar conversion of the projection data.
 The parameters to set are:
@@ -477,12 +500,27 @@ Currently, the \texttt{bilinear} option provides the highest
 quality interpolation.}
 \end{twocollist}
 
-\subsection{Process - Convert FFT Polar}
+\subsection{Convert - Convert FFT Polar}
 The parameters for this option are the same as the \helprefn{Convert
 Polar Dialog}{convertpolardialog}. For this command, though, the
 projections are Fourier transformed prior to conversion to polar
 image.
 
+\subsection{Convert - Interpolate to Parallel}
+This command filters divergent projection data (equiangular or
+equilinear) and interpolates (or rebins) to estimate the projection
+data if the projections had been collected with parallel geometry.
+
+\subsection{Analyze - Plot Histogram}
+Plots a histogram of projection data attenuations.
+
+\subsection{Analyze - Plot T-Theta Sampling}
+Plots a 2-dimensional scattergram showing the \texttt{T} and
+\texttt{Theta} values for each data point in the projection data.
+This is especially instructive when scanning with divergent
+geometries and the scan ratio is close to \texttt{1}.
+
+
 \subsection{Reconstruct - Filtered Backprojection}\label{IDH_DLG_RECONSTRUCTION}\index{Dialog!Reconstruction}
 This command displays a dialog to set the parameters for reconstructing an image from projections
 using the filtered backprojection technique. The parameters available are:
@@ -571,8 +609,19 @@ frequency-based filtering. A setting of \texttt{1} is optimal whereas
 a setting of \texttt{0} disables zero padding. Settings greater than \texttt{1}
 perform larger amounts of zero padding but without any significant benefit.}
 
+\twocolitem{\textbf{ROI}}{These four settings control the
+\textit{region of interest} for the reconstruction. The default values
+match the dimensions of the entire phantom. By constraining the ROI to
+be a smaller square, the reconstruction will be magnified.}
+
 \end{twocollist}
 
+\subsection{Reconstruct - Filtered Backprojection (Rebin to Parallel)}\label{IDH_DLG_RECONSTRUCTION_REBIN}\index{Dialog!Reconstruction_Rebin}
+The command reconstructs the projection data via filtered backprojection
+as described above. As opposed to the above command, this command also
+rebins divergent projection data to parallel prior to reconstruction.
+This greatly speeds reconstruction of divergent geometry projections.
+
 \section{Plot Menus}
 \subsection{File - Properties}
 The displayed properties include: