r227: *** empty log message ***

[ctsim.git] / README

diff --git a/README b/README
index 56ab90b7520f220f70f11786ab8254cb8014b8f1..d2bd46564bcebddcef3b73e3a5ead14a29a583f3 100644 (file)
--- a/README
+++ b/README
@@ -31,10 +31,6 @@ 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.
 
-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
 ========
@@ -52,25 +48,41 @@ 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
+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
+pjinfo - Show information on a projection file
+
+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
@@ -83,14 +95,14 @@ Simulate CT data collection and create a viewable image of raw projections
   if2img ...
 
 Perform CT reconstruction and create viewable image file
-  ctrec ...
+  pjrec ...
   if2img ...
 
 Display image information and comparative statistics
   ifinfo ...
 
-There is a sample shell script installed called 'sample-ctsim.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.