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.
  35
  36
  37 FEATURES
  38 ========
  39
  40 Several standard phantom objects are built-in. Other phantoms can be
  41 loaded from ASCII files.
  42
  43 CTsim uses cross-platform compatible file formats for projection data and
  44 image data.
  45
  46
  47 THE PROGRAMS
  48 ============
  49
  50 ctsim - a graphical user interface for most functions. This programs
  51 has all of the functionality of the command line tools except for
  52 image comparison functions.
  53
  54 phm2if - generates an image file of a phantom object
  55
  56 phm2pj - Simulates the collection of CT data, or projections, of a
  57 phantom object
  58
  59 pjrec - Performs an CT reconstruction, also known as image
  60 reconstruction from projections. Reads a projection file and writes a
  61 SDF file.
  62
  63 pj2if - Converts projection data to a raw sinugram image
  64
  65 pjinfo - Show information on a projection file
  66
  67 ifexport - Converts an image file to a variety of 8-bit and 16-bit image
  68 formats
  69
  70 if1 - Performs operations on a single image file
  71
  72 if2 - Performs operations on two image files, such as comparisons
  73
  74 ifinfo - Show statistics and history labels of image files
  75
  76
  77 TYPICAL USAGE
  78 =============
  79
  80 Graphical User Interface
  81 ------------------------
  82
  83 Use ctsim.
  84
  85
  86 Command Line Interface
  87 ----------------------
  88
  89 When evaluating CT simulation, in general, these steps are followed:
  90
  91 Create a phantom image and viewable image file
  92   phm2if ...
  93   ifexport ...
  94
  95 Simulate CT data collection and create a viewable image of raw projections
  96   phm2pj ...
  97   pj2if ...
  98   ifexport ...
  99
 100 Perform CT reconstruction and create viewable image file
 101   pjrec ...
 102   ifexport ...
 103
 104 Display image information and comparative statistics
 105   ifinfo ...
 106
 107 There is a sample shell script installed called 'sample-ctsim.sh'
 108 in the tools direction that performs the above commands.
 109
 110 These functions can be invoked via a web interface with a CGI program
 111 as described in the INSTALL file.
 112
 113
 114 COPYRIGHT
 115 =========
 116 This program is written by Kevin M. Rosenberg, M.D.
 117
 118 It is covered by the GNU General Public License (GPL) which
 119 allows copying and modifying this code with restrictions. See the
 120 file COPYING for complete details.
 121
 122