From e1c65a449d41a8086de63c8a0554976c0a104d79 Mon Sep 17 00:00:00 2001
From: hammonds <hammonds@dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b>
Date: Thu, 12 Aug 2010 21:24:57 +0000
Subject: [PATCH] Add some documentation for dynamic noise.

git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@11324 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
---
 documentation/simDetectorDoc.html | 50 +++++++++++++++++++++++++++++--
 1 file changed, 48 insertions(+), 2 deletions(-)

diff --git a/documentation/simDetectorDoc.html b/documentation/simDetectorDoc.html
index 517ad7c..5a5ef6d 100755
--- a/documentation/simDetectorDoc.html
+++ b/documentation/simDetectorDoc.html
@@ -215,6 +215,26 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          SimNoise</td>
+        <td>
+          asynInt32</td>
+        <td>
+          r/w</td>
+        <td>
+          Used to introduce randomness.  Each affected pixel is assigned a scaling factor.<br/>
+          scalingFactor = 1.0 + (rand()%noise +1)/100.0
+        </td>
+        <td>
+          SIM_NOISE</td>
+        <td>
+          $(P)$(R)Noise<br />
+          $(P)$(R)Noise_RBV</td>
+        <td>
+          longout<br />
+          longin</td>
+      </tr>
       <tr>
 		<td><b>Parameters for Peak Array</b></td>
       </tr>
@@ -362,6 +382,26 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          SimPeakHeightVariation</td>
+        <td>
+          asynInt32</td>
+        <td>
+          r/w</td>
+        <td>
+          Used to introduce randomness.  Each gaussian peak in the array is assigned a scaling factor.<br/>
+          scalingFactor = 1.0 + (rand()%peakVariation +1)/100.0
+        </td>
+        <td>
+          SIM_PEAK_HEIGHT_VARIATION</td>
+        <td>
+          $(P)$(R)PeakVariation<br />
+          $(P)$(R)PeakVariation_RBV</td>
+        <td>
+          longout<br />
+          longin</td>
+      </tr>
 
     </tbody>
   </table>
@@ -394,10 +434,16 @@
 			start location for the first peak in PeakStartX & PeakStartY.  The size of the peak is
 			controlled by PeakWidthX and PeakWidthY.  The array is specified by giving the number of
 			peaks in each direction with PeakNumX and PeakNumY and the step size between peak centroids
-			with PeakStepX and PeakStepY.
+			with PeakStepX and PeakStepY.  Note that data for each peak is only added to the image over a
+			range of four times the PeakWidth in any direction (in the interest of speed).
 		</p>
 		<p>
-			Some random behavior and RGB implementation will be added later.
+			Dynamic behavior can be introduced into the system by changing PeakVariation and Noise
+			records.  PeakVariation introduces variation on each pixel in the array and Noise introduces
+			variation in each pixel.
+		</p>
+		<p>
+			RGB implementation will be added later.
 		</p>
   <h3 id="Rings">Array of Rings</h3>
 		<p>