r110: *** 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 HISTORY
10 ------
11
12 CTSim development began in 1983 while I was in medical school.  It was
13 written using Lattice C and MS-DOS. I used assembly language to write
14 directly to an IBM EGA video adapter.
15
16 In 1999, I ported CTsim to GNU/Linux. In April 2000, the source code 
17 for CTSim was published on the Internet.
18
19 STATUS 
20 ------
21
22 The official home for CTsim is http://www.ctsim.org. From this site,
23 you can download the CTsim source code and use CTSim online using a
24 beowulf cluster.
25
26 I would be very pleased to have other developers join me in the
27 development of CTSim. Please see the TODO list for the most obvious
28 ideas.
29
30 In this release, the main issue that needs addressing is the inclusion
31 of old graphic library code. This code is not being used by
32 CTSim. Compilation warnings will occur in these files. Please ignore
33 these warnings. In the next major release of CTSim, there will be
34 support for interactive graphics. I just need to write the low-level
35 drivers to support X-window rather than IBM EGA hardware.
36
37 OVERVIEW
38 --------
39
40 CTSim simulates the collection of x-rays by a CT scanner. These x-rays
41 of objects are called projections or raysums.
42
43 Phantom objects are defined. Several built-in phantoms are included,
44 as well as an extension to load files of phantom definitions.
45
46 CTsim uses .sdf (standard data files) to represent 2-dimensional image
47 data. It uses a 32-bit floating-point pixel format. SDF is loosely
48 based on a image file format used by the Jet Propulsion Laboratory
49 (JPL). It supports multiple text labels per image.
50
51 THE PROGRAMS
52 ------------
53
54 phm2sdf - generates an SDF image of a phantom object
55
56 phm2rs - Simulates the collection of CT data, or raysums, of a phantom
57 object
58
59 ctrec - Performs an CT reconstruction, also known as image
60 reconstruction from projections. Reads a raysum file and writes a SDF
61 file.
62
63 rs2sdf - Converts raysum data to a raw sinugram image
64
65 sdf2img - Converts an SDF file to a variety of 8-bit image formats
66
67 sdfinfo - Show statistics and history labels of SDF files
68
69 TYPICAL USAGE
70 -------------
71
72 When evaluating CT simulation, in general, these steps are followed:
73
74 Create a phantom image and viewable image file
75   phm2sdf ...
76   sdf2img ...
77
78 Simulate CT data collection and create a viewable image of raw raysums
79   phm2rs ...
80   rs2sdf ...
81   sdf2img ...
82
83 Perform CT reconstruction and create viewable image file
84   ctrec ...
85   sdf2img ...
86
87 These functions are convert output image to a PNG file performed by
88 the CGI program ctsim.cgi which can be installed as described in
89 INSTALL file.
90
91 There is a sample shell script installed called 'sample-ctrec'.
92
93
94 CLOSING
95 =======
96
97 Please enjoy CTSim. I'd like to hear any feedback
98
99 Kevin M. Rosenberg, M.D.
100 kevin@rosenberg.net
101
102
103