X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=doc%2Fctsim-gui.tex;h=8d675de29f81518b0ad58ac0b034f220553023bd;hp=420e56d5220a60acadba111912d1b731772316e6;hb=d3fa225aa232e132cc198672c4fc148f96a1ab8c;hpb=b9bf8146ab0f2400166d1fd2d4c1614ea37a2c45 diff --git a/doc/ctsim-gui.tex b/doc/ctsim-gui.tex index 420e56d..8d675de 100644 --- a/doc/ctsim-gui.tex +++ b/doc/ctsim-gui.tex @@ -1,54 +1,72 @@ -\chapter{ctsim - the Graphical User Interface}\label{ctsim}\index{ctsim}% +\chapter{The Graphical User Interface}\label{ctsim}\index{ctsim}% \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage}% \section{Overview} -\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 \ctsimtext\ as well as image processing and visualization features. +\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 +with Microsoft Windows, \urlref{GTK}{http://www.gtk.org}, and +\urlref{Motif}{http://www.openmotif.org} graphical environments. +This graphical includes all of the functionality of the +command-line interface \helprefn{\ctsimtext}{ctsimtext} as well as +great 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 files, and +plotfiles. -\usage -ctsim [OPTIONS] [files to open...] +\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. + +\section{File Types Support} + +Phantom and plot files are stored as ASCII text. In contrast, +image and projection files are stored in binary format. \ctsim\ +incorporates logic so that binary files are cross-platform +compatible between both little and big endian architectures. -\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. +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. -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{Image} +Image files are 2-dimensional files that store 4-byte floating +point values. Images files can be either real or complex valued. +Typically, all images are real except for images that have been +processed by Fourier transforms. As you might expect, +complex-valued images are twice the size of real-valued images +since both a real and imaginary component need to be store. \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. +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. +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 +to set are: + +\begin{twocollist} +%\twocolitemruled{\textbf{Parameter}}{\textbf{Options}} +\twocolitem{\texttt{X size}}{Number of columns in image file} +\twocolitem{\texttt{Y size}}{Number of rows in image file} +\twocolitem{\texttt{Samples per pixel}}{Numbers of samples taken +per pixel in both the x and y directions. For example, if the +\texttt{Samples per pixel} is set to \texttt{3}, then for every +pixel in the image file 9 samples (3 x 3) are averaged.} +\end{twocollist} \subsection{Projection Dialog} This creates a projection file from a phantom. @@ -56,11 +74,11 @@ 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} +\begin{itemize}\itemsep=0pt + \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. @@ -79,16 +97,16 @@ 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 +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. +The parameters 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 @@ -106,4 +124,3 @@ These commands set the scaling for the y-axis. \subsubsection{Set} \subsubsection{Auto} \subsubsection{Full} -