r221: *** empty log message ***
[ctsim.git] / README
1 COPYRIGHT
2 =========
3 This program is written by Kevin M. Rosenberg, M.D.
4
5 It is covered by the GNU General Public License (GPL) which
6 allows copying and modifying this code with restrictions. See the
7 file COPYING for complete details.
8
9
10 HISTORY
11 =======
12
13 CTSim development began in 1983 while I was in medical school.  It was
14 written using Lattice C and MS-DOS. I used assembly language to write
15 directly to an IBM EGA video adapter.
16
17 In 1999, I ported CTsim to GNU/Linux. In April 2000, the source code 
18 for CTSim was published on the Internet.
19
20 In June 2000, entire code for revised and converted to C++.
21
22
23 STATUS 
24 ======
25
26 The official home for CTsim is http://www.ctsim.org. From this site,
27 you can download the CTsim source code and use CTSim online using a
28 beowulf cluster.
29
30 I would be very pleased to have other developers join me in the
31 development of CTSim. Please see the TODO list for the most obvious
32 ideas.
33
34 Interactive graphics have not yet been implemented. I am still researching 
35 cross-platform tools to create a graphical interface with interactive
36 graphics of the simulation and reconstruction processes.
37
38
39 OVERVIEW
40 ========
41
42 CTSim simulates the collection of x-rays by a CT scanner. These x-rays
43 of objects are called projections.
44
45 Phantom objects are defined. Several built-in phantoms are included,
46 as well as an extension to load files of phantom definitions.
47
48 CTsim uses cross-platform compatible file formats for projection data and 
49 image data.
50
51
52 THE PROGRAMS
53 ============
54
55 ctsim - a graphical user interface for all functions. Currently, this is
56 still under development and incomplete compared to command-line tools.
57
58 phm2if - generates an image file of a phantom object
59
60 phm2pj - Simulates the collection of CT data, or projections, of a phantom
61 object
62
63 ctrec - Performs an CT reconstruction, also known as image
64 reconstruction from projections. Reads a projection file and writes a SDF
65 file.
66
67 pj2if - Converts projection data to a raw sinugram image
68
69 if2img - Converts an image file to a variety of 8-bit and 16-bit image formats
70
71 ifinfo - Show statistics and history labels of SDF files
72
73
74 TYPICAL USAGE
75 =============
76
77 Graphical User Interface
78 ------------------------
79
80 Use ctsim, but most functions are not yet incorporated.
81
82 Command Line Interface
83 ----------------------
84
85 When evaluating CT simulation, in general, these steps are followed:
86
87 Create a phantom image and viewable image file
88   phm2if ...
89   if2img ...
90
91 Simulate CT data collection and create a viewable image of raw projections
92   phm2pj ...
93   pj2if ...
94   if2img ...
95
96 Perform CT reconstruction and create viewable image file
97   ctrec ...
98   if2img ...
99
100 Display image information and comparative statistics
101   ifinfo ...
102
103 There is a sample shell script installed called 'sample-ctsim.sh' 
104 in the tools direction that performs the above commands.
105
106 These functions can be invoked via a web interface with a CGI program 
107 as described in the INSTALL file.
108
109
110 CLOSING
111 =======
112
113 Please enjoy CTSim. I'd like to hear any feedback
114
115 Kevin M. Rosenberg, M.D.
116 kevin@rosenberg.net
117
118
119