r520: no message
[ctsim.git] / doc / ctsim-gui.tex
1 \chapter{The Graphical User Interface}\label{ctsim}\index{ctsim}%
2 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}%
4
5 \section{Overview}
6 \ctsim\ is the graphical shell for the CTSim project. It utilizes
7 using the \urlref{wxWindows}{http://www.wxwindows.org} library for
8 cross-platform compatibility. The graphical shell is compatible
9 with Microsoft Windows, \urlref{GTK}{http://www.gtk.org}, and
10 \urlref{Motif}{http://www.openmotif.org} graphical environments.
11 This graphical includes all of the functionality of the
12 command-line interface \helprefn{\ctsimtext}{ctsimtext} as well as
13 great image processing and visualization features.
14
15 \ctsim\ can open projection files, image files, phantom files, and
16 plotfiles.
17
18 \usage \texttt{ctsim [files to open...]
19
20 You can invoke \ctsim\ by itself on the command line, or include
21 any number of files that you want \ctsim\ to automatically open.
22
23 \section{File Types Support}
24
25 Phantom and plot files are stored as ASCII text. In contrast,
26 image and projection files are stored in binary format. \ctsim\
27 incorporates logic so that binary files are cross-platform
28 compatible between both little and big endian architectures.
29
30 \subsection{Phantom}
31 Besides loading phantom files from the disk, the Herman and
32 Shepp-Logan phantoms are built-in to \ctsim. Phantom files can be
33 read and stored on the disk. However, a text editor is required to
34 create and edit these files.
35
36 \subsection{Image}
37 Image files are 2-dimensional files that store 4-byte floating
38 point values. Images files can be either real or complex valued.
39 Typically, all images are real except for images that have been
40 processed by Fourier transforms. As you might expect,
41 complex-valued images are twice the size of real-valued images
42 since both a real and imaginary component need to be store.
43
44 \subsection{Projection}
45 Projection files are created from Phantom files during the projection process.
46 Numerous options are available for creation of the these files.
47
48 \subsection{Plot}
49 Plot files are created by \ctsim\ during analysis of image files.
50 They can be read and stored on the disk. They are stored as ASCII
51 files for easy cross-platform support.
52
53 \section{Phantom Menus}
54
55 \subsection{Rasterize Dialog}
56 This creates an image file from a phantom. Technically, it
57 converts the phantom from a vector (infinite resolution) object
58 into a 2-dimension array of floating-point pixels. The parameters
59 to set are:
60
61 \begin{twocollist}
62 %\twocolitemruled{\textbf{Parameter}}{\textbf{Options}}
63 \twocolitem{\texttt{X size}}{Number of columns in image file}
64 \twocolitem{\texttt{Y size}}{Number of rows in image file}
65 \twocolitem{\texttt{Samples per pixel}}{Numbers of samples taken
66 per pixel in both the x and y directions. For example, if the
67 \texttt{Samples per pixel} is set to \texttt{3}, then for every
68 pixel in the image file 9 samples (3 x 3) are averaged.}
69 \end{twocollist}
70
71 \subsection{Projection Dialog}
72 This creates a projection file from a phantom.
73
74 \section{Image Menus}
75 \subsection{File - Properties}
76 Properties of image files include
77 \begin{itemize}\itemsep=0pt
78   \item Whether the image is real or complex valued
79   \item Numeric statistics
80   \item Image file labels
81 \end{itemize}
82
83 \subsection{View}
84 These options are for change the intensity scale for viewing the image.
85 They do not change the image data.
86
87 \subsection{Image}
88 These commands create a new image based upon the current image,
89 and for some commands, also a comparison image.
90
91 \subsection{Filter}
92 These commands filter image.
93
94 \subsection{Anaylze}
95 These commands are used for analyzing an image.
96
97 \section{Projection Menus}
98 \subsection{Process - Convert Polar Dialog}\label{convertpolardialog}
99 The parameters are \texttt{xsize}, \texttt{ysize}, and \texttt{interpolation}.
100 The \texttt{xsize} and \texttt{ysize} parameters set the size of the
101 resulting image file. The \texttt{interpolation} parameter selects the
102 interpolation method. Currently, the \texttt{bilinear} option provides
103 the highest quality interpolation.
104
105 \subsection{Process - Convert FFT Polar Dialog}
106 The parameters for this option are the same as
107 \helprefn{convertpolardialog}{Convert Polar Dialog}. For this
108 command, though, the projections are Fourier transformed prior to
109 conversion to polar image.
110
111 \subsection{Reconstruct - Filtered Backprojection Dialog}
112 This dialog sets the parameters for reconstructing an image from projections
113 using the Filtered Backprojection technique. The parameters are identical
114 to those for the \helprefn{pjrec}{pjrec} program.
115
116 \section{Plot Menus}
117 \subsection{File - Properties}
118
119 \subsection{File - Save}
120 Plot files can be saved. They are saved in an ASCII text format.
121
122 \subsection{View Menu}
123 These commands set the scaling for the y-axis.
124 \subsubsection{Set}
125 \subsubsection{Auto}
126 \subsubsection{Full}