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
  35 OVERVIEW
  36 ========
  37
  38 CTSim simulates the collection of x-rays by a CT scanner. These x-rays
  39 of objects are called projections.
  40
  41 Phantom objects are defined. Several built-in phantoms are included,
  42 as well as an extension to load files of phantom definitions.
  43
  44 CTsim uses cross-platform compatible file formats for projection data and
  45 image data.
  46
  47
  48 THE PROGRAMS
  49 ============
  50
  51 ctsim - a graphical user interface for most functions. This programs
  52 has all of the functionality of the command line tools except for
  53 image comparison functions.
  54
  55 phm2if - generates an image file of a phantom object
  56
  57 phm2pj - Simulates the collection of CT data, or projections, of a
  58 phantom object
  59
  60 pjrec - Performs an CT reconstruction, also known as image
  61 reconstruction from projections. Reads a projection file and writes a
  62 SDF file.
  63
  64 pj2if - Converts projection data to a raw sinugram image
  65
  66 if2img - Converts an image file to a variety of 8-bit and 16-bit image
  67 formats
  68
  69 pjinfo - Show information on a projection file
  70
  71 ifinfo - Show statistics and history labels of image files
  72
  73
  74 TYPICAL USAGE
  75 =============
  76
  77 Graphical User Interface
  78 ------------------------
  79
  80 Use ctsim.
  81
  82
  83 Command Line Interface
  84 ----------------------
  85
  86 When evaluating CT simulation, in general, these steps are followed:
  87
  88 Create a phantom image and viewable image file
  89   phm2if ...
  90   if2img ...
  91
  92 Simulate CT data collection and create a viewable image of raw projections
  93   phm2pj ...
  94   pj2if ...
  95   if2img ...
  96
  97 Perform CT reconstruction and create viewable image file
  98   pjrec ...
  99   if2img ...
 100
 101 Display image information and comparative statistics
 102   ifinfo ...
 103
 104 There is a sample shell script installed called 'sample-ctsim.sh'
 105 in the tools direction that performs the above commands.
 106
 107 These functions can be invoked via a web interface with a CGI program
 108 as described in the INSTALL file.
 109
 110
 111 CLOSING
 112 =======
 113
 114 Please enjoy CTSim. I'd like to hear any feedback
 115
 116 Kevin M. Rosenberg, M.D.
 117 kevin@rosenberg.net
 118
 119
 120