r57: Added G2 library support

[ctsim.git] / README

diff --git a/README b/README
index 30cca644c069f0aa47ca0bf86407f83ec2c33730..a149b8722692f33420215b50703537137f0167d3 100644 (file)
--- a/README
+++ b/README
@@ -90,9 +90,55 @@ 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
--------
+=======
 
 Please enjoy CTSim. I'd like to hear any feedback