X-Git-Url: http://git.kpe.io/?p=ctsim.git;a=blobdiff_plain;f=README;h=9146dbcc7324d5dfde810a0200a6f59a3f32da90;hp=1bf5d38cb84d6349506de1fb56f68e0bd42b4054;hb=bf055865d682c7ff942b36315985711a2c5e5793;hpb=44ba9ce559d2d52cbd7bbea6bcd76242840fd3eb

diff --git a/README b/README
index 1bf5d38..9146dbc 100644
--- a/README
+++ b/README
@@ -1,17 +1,25 @@
-COPYRIGHT
-=========
-This program is written by Kevin M. Rosenberg, M.D.
+OVERVIEW
+========
 
-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.
+CTSim simulates the process of collecting tomographic X-ray data of
+phantom objects. These X-ray data through the objects are called
+projections. CTSim reconstructs the original phantom image from the
+projections using a variety of algorithms.
+
+CTSim is open-source and is covered by the GNU Public License (GPL). 
+
+Please enjoy CTSim. I'd like to hear any feedback
+
+Kevin M. Rosenberg, M.D.
+kevin@rosenberg.net
 
 
 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
+written using Lattice C and MS-DOS. I used 8086 assembly language to
+code convolution and backprojection routes and also to write graphics
 directly to an IBM EGA video adapter.
 
 In 1999, I ported CTsim to GNU/Linux. In April 2000, the source code 
@@ -20,30 +28,17 @@ 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
-beowulf cluster.
+WHERE
+=====
 
-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.
+The official home for CTsim is http://www.ctsim.org.
 
-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
+FEATURES
 ========
 
-CTSim simulates the collection of x-rays by a CT scanner. These x-rays
-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.
+Several standard phantom objects are built-in. Other phantoms can be
+loaded from ASCII files.
 
 CTsim uses cross-platform compatible file formats for projection data and 
 image data.
@@ -52,54 +47,76 @@ image data.
 THE PROGRAMS
 ============
 
+ctsim - a graphical user interface for most functions. This programs
+has all of the functionality of the command line tools except for
+image comparison functions.
+
 phm2if - generates an image file of a phantom object
 
-phm2pj - Simulates the collection of CT data, or projections, of a phantom
-object
+phm2pj - Simulates the collection of CT data, or projections, of a
+phantom object
 
-ctrec - Performs an CT reconstruction, also known as image
-reconstruction from projections. Reads a projection file and writes a SDF
-file.
+pjrec - Performs an CT reconstruction, also known as image
+reconstruction from projections. Reads a projection file and writes a
+SDF file.
 
 pj2if - Converts projection data to a raw sinugram image
 
-if2img - Converts an image file to a variety of 8-bit and 16-bit image formats
+pjinfo - Show information on a projection file
+
+ifexport - Converts an image file to a variety of 8-bit and 16-bit image
+formats
 
-ifinfo - Show statistics and history labels of SDF files
+if1 - Performs operations on a single image file
+
+if2 - Performs operations on two image files, such as comparisons
+
+ifinfo - Show statistics and history labels of image files
 
 
 TYPICAL USAGE
 =============
 
+Graphical User Interface
+------------------------
+
+Use ctsim.
+
+
+Command Line Interface
+----------------------
+
 When evaluating CT simulation, in general, these steps are followed:
 
 Create a phantom image and viewable image file
   phm2if ...
-  if2img ...
+  ifexport ...
 
 Simulate CT data collection and create a viewable image of raw projections
   phm2pj ...
   pj2if ...
-  if2img ...
+  ifexport ...
 
 Perform CT reconstruction and create viewable image file
-  ctrec ...
-  if2img ...
+  pjrec ...
+  ifexport ...
+
+Display image information and comparative statistics
+  ifinfo ...
 
-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-ctsim.sh' 
+in the tools direction that performs the above commands.
 
 These functions can be invoked via a web interface with a CGI program 
 as described in the INSTALL file.
 
 
-CLOSING
-=======
-
-Please enjoy CTSim. I'd like to hear any feedback
-
-Kevin M. Rosenberg, M.D.
-kevin@rosenberg.net
+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.