r113: *** empty log message ***

[ctsim.git] / README

diff --git a/README b/README
index a149b8722692f33420215b50703537137f0167d3..2028fad4630beaca2f793f051886aa0fc03956d1 100644 (file)
--- a/README
+++ b/README
@@ -38,7 +38,7 @@ OVERVIEW
 --------
 
 CTSim simulates the collection of x-rays by a CT scanner. These x-rays
-of objects are called projections or raysums.
+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.
@@ -51,20 +51,20 @@ based on a image file format used by the Jet Propulsion Laboratory
 THE PROGRAMS
 ------------
 
-phm2sdf - generates an SDF image of a phantom object
+phm2if - generates an image file of a phantom object
 
-phm2rs - Simulates the collection of CT data, or raysums, of a phantom
+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 raysum file and writes a SDF
+reconstruction from projections. Reads a projection file and writes a SDF
 file.
 
-rs2sdf - Converts raysum data to a raw sinugram image
+pj2if - Converts projection data to a raw sinugram image
 
-sdf2img - Converts an SDF file to a variety of 8-bit image formats
+if2img - Converts an image file to a variety of 8-bit and 16-bit image formats
 
-sdfinfo - Show statistics and history labels of SDF files
+ifinfo - Show statistics and history labels of SDF files
 
 TYPICAL USAGE
 -------------
@@ -75,9 +75,9 @@ Create a phantom image and viewable image file
   phm2sdf ...
   sdf2img ...
 
-Simulate CT data collection and create a viewable image of raw raysums
-  phm2rs ...
-  rs2sdf ...
+Simulate CT data collection and create a viewable image of raw projections
+  phm2pj ...
+  pj2sdf ...
   sdf2img ...
 
 Perform CT reconstruction and create viewable image file
@@ -90,52 +90,6 @@ INSTALL file.
 
 There is a sample shell script installed called 'sample-ctrec'.
 
-HDF FILE FORMAT
-===============
-
-If the HDF library is compiled into CTSim, it will be used for the
-raysum and image files.
-
-Reconstruction Groups
----------------------
-Group Name="Recon"
-  SubDataset="ReconParam"
-  SubGroup="Proj"
-    SubDataset="Raysum"
-    SubDataset="Geometry"
-  SubGroup="Phantom"
-    SubDataset "FImage"
-  SubGroup="Reconstr"
-    SubDataset "FImage"
-
-Image Dataset
--------------
-Name="FImage"
-DataType: FLOAT
-Attributes: 
-  "XSize" DOUBLE : X size of pixel in world coordinates
-  "YSize" DOUBLE : Y size of pixel in world coordinates
-
-
-Raysum Group
--------------
-Group Name="Proj"
-Proj Dataset
-  Name="Raysum"
-  DataType: FLOAT
-  Dim: 2 (nviews x ndet)
-  Attributes:
-Geometry Dataset
-  Name="Geometry"
-  DataType: FLOAT
-  Dim: 1  (nviews x 1)
-  Data: For each view, store view_angle
-  Attributes: 
-    "GEOMCODE" INT : Geometry Code
-    "DETSTART"
-    "DETINC"
-    "ROTSTART"
-    "ROTINC"
 
 CLOSING
 =======
@@ -146,3 +100,4 @@ Kevin M. Rosenberg, M.D.
 kevin@rosenberg.net
 
 
+