r115: *** empty log message ***

[ctsim.git] / README

diff --git a/README b/README
index 2028fad4630beaca2f793f051886aa0fc03956d1..1bf5d38cb84d6349506de1fb56f68e0bd42b4054 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,14 @@
 COPYRIGHT
----------
+=========
 This program is written by Kevin M. Rosenberg, M.D.
 
 It is covered by the GNU General Public License (GPL) which
 allows copying and modifying this code with restrictions. See the
 file COPYING for complete details.
 
+
 HISTORY
-------
+=======
 
 CTSim development began in 1983 while I was in medical school.  It was
 written using Lattice C and MS-DOS. I used assembly language to write
@@ -16,8 +17,11 @@ directly to an IBM EGA video adapter.
 In 1999, I ported CTsim to GNU/Linux. In April 2000, the source code 
 for CTSim was published on the Internet.
 
+In June 2000, entire code for revised and converted to C++.
+
+
 STATUS 
-------
+======
 
 The official home for CTsim is http://www.ctsim.org. From this site,
 you can download the CTsim source code and use CTSim online using a
@@ -27,15 +31,13 @@ I would be very pleased to have other developers join me in the
 development of CTSim. Please see the TODO list for the most obvious
 ideas.
 
-In this release, the main issue that needs addressing is the inclusion
-of old graphic library code. This code is not being used by
-CTSim. Compilation warnings will occur in these files. Please ignore
-these warnings. In the next major release of CTSim, there will be
-support for interactive graphics. I just need to write the low-level
-drivers to support X-window rather than IBM EGA hardware.
+Interactive graphics have not yet been implemented. I am still researching 
+cross-platform tools to create a graphical interface with interactive
+graphics of the simulation and reconstruction processes.
+
 
 OVERVIEW
---------
+========
 
 CTSim simulates the collection of x-rays by a CT scanner. These x-rays
 of objects are called projections.
@@ -43,13 +45,12 @@ of objects are called projections.
 Phantom objects are defined. Several built-in phantoms are included,
 as well as an extension to load files of phantom definitions.
 
-CTsim uses .sdf (standard data files) to represent 2-dimensional image
-data. It uses a 32-bit floating-point pixel format. SDF is loosely
-based on a image file format used by the Jet Propulsion Laboratory
-(JPL). It supports multiple text labels per image.
+CTsim uses cross-platform compatible file formats for projection data and 
+image data.
+
 
 THE PROGRAMS
-------------
+============
 
 phm2if - generates an image file of a phantom object
 
@@ -66,29 +67,30 @@ if2img - Converts an image file to a variety of 8-bit and 16-bit image formats
 
 ifinfo - Show statistics and history labels of SDF files
 
+
 TYPICAL USAGE
--------------
+=============
 
 When evaluating CT simulation, in general, these steps are followed:
 
 Create a phantom image and viewable image file
-  phm2sdf ...
-  sdf2img ...
+  phm2if ...
+  if2img ...
 
 Simulate CT data collection and create a viewable image of raw projections
   phm2pj ...
-  pj2sdf ...
-  sdf2img ...
+  pj2if ...
+  if2img ...
 
 Perform CT reconstruction and create viewable image file
   ctrec ...
-  sdf2img ...
+  if2img ...
 
-These functions are convert output image to a PNG file performed by
-the CGI program ctsim.cgi which can be installed as described in
-INSTALL file.
+There is a sample shell script installed called 'sample-ctrec.sh' that performs 
+the above commands.n
 
-There is a sample shell script installed called 'sample-ctrec'.
+These functions can be invoked via a web interface with a CGI program 
+as described in the INSTALL file.
 
 
 CLOSING