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