r491: no message
[ctsim.git] / doc / ctsim-gui.tex
1 \chapter{ctsim - 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 is
7 written using the wxLibrary for cross-platform compatibility with GTK,
8 Motif, and Microsoft Windows. It includes all of the functionality of
9 the command-line tool \ctsimtext\ as well as image processing and visualization features.
10
11 \ctsim\ can open projection files, image files, phantom definition files, and plotfiles.
12
13 \usage
14 ctsim [OPTIONS] [files to open...]
15
16 \section{Files Supported}
17 \subsection{Phantom}
18 Phantom files are supported. Besides loading phantom files from
19 the disk, the Herman and Shepp-Logan phantoms are built-in to CTSim.
20 Phantom files can be read and stored on the disk. However, a text
21 editor is required to create and edit these files.
22  
23 \subsection{Image}
24 Image files are 2-dimensional files stored a 4-byte floating point values.
25 They are stored in little-endian format and \ctsim\ incorporates routines
26 to read and write files correctly on both big and little endian architextures.
27
28 Images files can be either real or complex valued. Typically, all images
29 are real except for images that have been processed by Fourier transforms.
30
31 \subsection{Projection}
32 Projection files are created from Phantom files during the projection process.
33 Numerous options are available for creation of the these files.
34
35 \subsection{Plot}
36 Plot files are created by CTSim during analysis of image files. They can be
37 read and stored on the disk. They are stored as ASCII files for easy
38 cross-platform support.
39
40 \section{Phantom Menus}
41
42 \subsection{Rasterize Dialog}
43 This creates an image file from a phantom. Technically, it converts
44 the phantom from a vector (infinite resolution) object into defined resolution
45 image. The parameters to set are:
46
47 x-size   Number of columns in image file
48 y-size   Number of rows in image file
49 samples  Numbers of samples taken per pixel in the x and y directions.
50          For example, if the nsamples is set to \texttt{3}, then for every
51          pixel in the image file, 9 samples (3 x 3) are averaged.
52
53 \subsection{Projection Dialog}
54 This creates a projection file from a phantom.
55
56 \section{Image Menus}
57 \subsection{File - Properties}
58 \subsection{View}
59 \subsection{Image}
60 These commands create a new image.
61 \subsection{Filter}
62 These commands filter image.
63
64 \subsection{Anaylze}
65
66 \section{Projection Menus}
67 \subsection{Convert Polar Dialog}
68 \subsection{Convert FFT Polar Dialog}
69 \subsection{Filtered Backprojection Dialog}
70
71 \section{Plot Menus}
72 \subsection{File - Properties}
73 \subsection{File - Save}
74 Plot files can be saved. They are saved in an ASCII text format.
75
76 \subsection{View Menu}
77 \subsubsection{Set}
78 \subsubsection{Auto}
79 \subsubsection{Full}
80