From 0c51c857255a37fa91b65d48bb2afec927bfae3e Mon Sep 17 00:00:00 2001
From: rivers <rivers@dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b>
Date: Mon, 9 Aug 2010 16:08:00 +0000
Subject: [PATCH] Documented new FalseColor feature

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

diff --git a/documentation/NDPluginColorConvert.html b/documentation/NDPluginColorConvert.html
index 3eb2cb2..0fa5144 100755
--- a/documentation/NDPluginColorConvert.html
+++ b/documentation/NDPluginColorConvert.html
@@ -10,7 +10,7 @@
     <h1>
       areaDetector Plugin NDPluginColorConvert</h1>
     <h2>
-      March 28, 2010</h2>
+      August 8, 2010</h2>
     <h2>
       Mark Rivers</h2>
     <h2>
@@ -85,6 +85,28 @@
           <br />
           mbbi</td>
       </tr>
+      <tr>
+        <td>
+          NDPluginColorConvertFalseColor</td>
+        <td>
+          asynInt32</td>
+        <td>
+          r/w</td>
+        <td>
+          The false color map index. There are currently 2 false color maps defined, Rainbow
+          and Iron. Additional color maps can easily be added in the future.</td>
+        <td>
+          FALSE_COLOR</td>
+        <td>
+          $(P)$(R)FalseColor
+          <br />
+          $(P)$(R)FalseColor_RBV
+        </td>
+        <td>
+          mbbo
+          <br />
+          mbbi</td>
+      </tr>
     </tbody>
   </table>
   <p>
@@ -96,6 +118,9 @@
     <li>RGB2 to mono, RGB1 or RGB3</li>
     <li>RGB3 to mono, RGB1 or RGB2</li>
   </ul>
+  <p>
+    When converting from 8-bit mono to RGB1, RGB2 or RGB3 a false-color map will be
+    applied if FalseColor is not zero.</p>
   <p>
     The Bayer color conversion supports the 4 Bayer formats (NDBayerRGGB, NDBayerGBRG,
     NDBayerGRBG, NDBayerBGGR) defined in NDArray.h. If the input color mode and output
@@ -136,7 +161,8 @@
   <ul>
     <li>The Bayer color conversion is done using a library function provided in the Prosilica
       library. The source code for this function is not provided, and the binaries are
-      only available on Linux and Windows.  All other conversions are supported on all platforms.</li>
+      only available on Linux and Windows. All other conversions are supported on all
+      platforms.</li>
     <li>YUV color conversion is not supported. This may be added in a future release.</li>
   </ul>
 </body>