Clarified the beam_center_x,y documentation regarding length. As agre…

…ed upon at the February, 20, 2017 hangout.
nexusformat · Feb 21, 2017 · 015eb0b · 015eb0b
1 parent 5fa7910
commit 015eb0b
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 12 deletions.
diff --git a/applications/NXcanSAS.nxdl.xml b/applications/NXcanSAS.nxdl.xml
@@ -891,7 +891,9 @@
             Position of the beam center on the detector.
 
             This is the x position where the direct beam would hit the detector plane.
-            This is a length and can be outside of the actual detector.  The value can any 
+            This is a length and can be outside of the actual
+	    detector.  The length can be in physical units or pixels
+	    as documented by the units attribute. The value can be any 
             real number (positive, zero, or negative).
           </doc>
         </field>
@@ -901,7 +903,8 @@
             Position of the beam center on the detector.
 
             This is the y position where the direct beam would hit the detector plane.
-            This is a length and can be outside of the actual detector.  The value can any 
+            This is a length and can be outside of the actual detector.  The length can be in physical units or pixels
+	    as documented by the units attribute. The value can any 
             real number (positive, zero, or negative).
           </doc>
         </field>

diff --git a/applications/NXmx.nxdl.xml b/applications/NXmx.nxdl.xml
@@ -309,7 +309,8 @@
 						<doc>
 							This is the x position where the direct beam would hit the
 							detector. This is a length and can be outside of the actual 
-							detector.
+							detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
 						</doc>
 					</field>
 
@@ -318,7 +319,8 @@
 						<doc>
 							This is the y position where the direct beam would hit the
 							detector. This is a length and can be outside of the actual 
-							detector.
+							detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
 						</doc>
 					</field>
 

diff --git a/applications/NXsas.nxdl.xml b/applications/NXsas.nxdl.xml
@@ -129,13 +129,17 @@
 		<field name="beam_center_x" type="NX_FLOAT" units="NX_LENGTH">
 			<doc>
 				This is the x position where the direct beam would hit the detector. This is a
-				length and can be outside of the actual detector.
+				length and can be outside of the
+				actual detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
 			</doc>
 		</field>
         <field name="beam_center_y" type="NX_FLOAT" units="NX_LENGTH">
 			<doc>
 				This is the y position where the direct beam would hit the detector. This is a
-				length and can be outside of the actual detector.
+				length and can be outside of the
+				actual detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
 			</doc>
 		</field>
       </group>

diff --git a/applications/NXsastof.nxdl.xml b/applications/NXsastof.nxdl.xml
@@ -114,13 +114,17 @@
         <field name="beam_center_x" type="NX_FLOAT" units="NX_LENGTH">
                <doc>
 	               This is the x position where the direct beam would hit the detector. This is a
-	               length and can be outside of the actual detector.
+	               length and can be outside of the actual
+		       detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
                </doc>
         </field>
         <field name="beam_center_y" type="NX_FLOAT" units="NX_LENGTH">
                  <doc>
 	                 This is the y position where the direct beam would hit the detector. This is a
-	                 length and can be outside of the actual detector.
+	                 length and can be outside of the actual
+			 detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
                  </doc>
        </field>
       </group>

diff --git a/applications/NXxrot.nxdl.xml b/applications/NXxrot.nxdl.xml
@@ -50,12 +50,14 @@
           <field name="beam_center_x" type="NX_FLOAT" units="NX_LENGTH">
            <doc>
               This is the x position where the direct beam would hit the detector. This is a
-              length and can be outside of the actual detector.
+              length and can be outside of the actual detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
             </doc></field>
         <field name="beam_center_y" type="NX_FLOAT" units="NX_LENGTH">
             <doc>
                 This is the y position where the direct beam would hit the detector. This is a
-                length and can be outside of the actual detector.
+                length and can be outside of the actual detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
         </doc></field>        
       </group>
       <group type="NXattenuator" name="attenuator">

diff --git a/base_classes/NXdetector.nxdl.xml b/base_classes/NXdetector.nxdl.xml
@@ -494,14 +494,18 @@
   <field name="beam_center_x" type="NX_FLOAT" units="NX_LENGTH">
     <doc>
 	    This is the x position where the direct beam would hit the detector.
-	    This is a length and can be outside of the actual detector.
+	    This is a length and can be outside of the actual
+	    detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
     </doc>
   </field>
 
   <field name="beam_center_y" type="NX_FLOAT" units="NX_LENGTH">
     <doc>
 	    This is the y position where the direct beam would hit the detector.
-	    This is a length and can be outside of the actual detector.
+	    This is a length and can be outside of the actual
+	    detector. The length can be in physical units or pixels
+	    as documented by the units attribute.
     </doc>
   </field>