Changeset 2602 for trunk/help/gsasII.html

Timestamp:

Dec 25, 2016 9:43:21 PM (5 years ago)

Author:

toby

Message:

redo drawing and editing of masks, document; add transfer angles to Integration controls

File:

• trunk/help/gsasII.html (modified) (3 diffs)

trunk/help/gsasII.html

@@ -3169 +3169 @@
 that can be selected, cut &amp; pasted into a document. <o:p></o:p></span></p>
 
+<h3><a name=Tutorials><strong>Macintosh
+notes</strong></a><strong>:<o:p></o:p></strong></h3>
+
+GSAS-II can be run on Windows, Linux and Macintosh/OS X computers, but
+due to the different nature of the Mac, the program behaves slightly
+differently. On Windows and Linux, there are two menu bars: (A) found
+at the top of the GSAS-II data tree and (B) on GSAS-II data editing
+window. The latter changes, based on which data item is selected in
+the data tree. On the Mac, these menus are combined located on the
+location that has been configured for menus (usually at the top of the
+screen). The main manu and the data editing menu (if present) are
+separated by a vertical bar.
+<P>
+GSAS-II uses both the left and right buttons on a two-button mouse. If
+a mac has a two or three-button mouse attached, these mouse buttons will be
+used on the other platforms. If using a Mac touchpad or single-button
+mouse, the control-key should be held down to simulate use of the
+right mouse button. The left button click is generated otherwise.  
+
 <h2><a name=Programmers><strong>Programmers documentation</strong></a><strong>:<o:p></o:p></strong></h2>
 
@@ -5505 +5524 @@
 
 <p class=MsoNormal style='margin-left:.5in'><span style='mso-fareast-font-family:
-"Times New Roman"'>This window... <span class=MsoHyperlink><span
+"Times New Roman"'>This window displays calibration values needed to
+convert pixel locations to two-theta and azimuth. Also shown are
+controls that determine how integration is performed.
+<P class=MsoNormal style='margin-left:.5in'>
+Menu command for this window are used to perform calibration (fitting
+the calibration values from a diffraction pattern image taken with a
+calibrant) and for integration. Other menu commands allow the values
+on the window to be saved to a file, read from a file or copied to
+other images. The "Xfer Angles" menu command scales the current
+integration range for other images located at different detector
+distances. 
+
+
+<span class=MsoHyperlink><span
 style='color:windowtext;text-decoration:none;text-underline:none'><o:p></o:p></span></span></span></p>
 
-<h4 style='margin-left:.5in'>Ma<a name="Image_Masks"></a>sks</h4>
+<h4 style='margin-left:.5in'><a name="Image_Masks">Masks</a></h4>
 
 <p class=MsoNormal style='margin-left:.5in'><span style='mso-fareast-font-family:
-"Times New Roman"'>This window... <span class=MsoHyperlink><span
+"Times New Roman"'>
+Image masks are used designate areas of an image that should not be
+included in the integration, typically used due to detector
+irregularities, shadows of the beamstop, single-crystal peaks from a
+mounting, etc. Masks can be created with a menu command or with
+keyboard/mouse shortcuts. 
+
+There are five types of masks:<OL>
+<LI style='margin-left:.5in'>Spot masks: occlude a circle with a 
+  selected center and diameter in image coordinates (mm).
+<P style='margin-left:.25in'><B>Create Spot masks</B> with a menu command and then by clicking on 
+  the location on the image that should be masked. Or, there are also
+  three ways to create spot masks with the keyboard:
+ <UL>
+<LI style='margin-left:.2in'>Press the 's' key and then click on the mask location.   
+<LI style='margin-left:.2in'>Press the 'm' key and
+   then click successively on multiple locations for spot masks. Press the 'm' key again
+   to stop adding spot masks.
+<LI style='margin-left:.2in'>Move the mouse to the position for a
+   new spot mask and press the 't' key. (Note that
+   this can be used while the plot is in Zoom or Pan mode.) 
+</UL>
+<P style='margin-left:.25in'><B>Edit Spot mask location</B> by left-clicking inside
+  or on the edge the of the mask and then drag the spot mask to a new
+  location.
+<P style='margin-left:.25in'><B>Edit Spot mask radius</B> by <a href="#Mac_rightclick">right-clicking*</a> inside
+  the mask and then dragging to change the mask size.
+
+<LI style='margin-left:.5in'>Ring masks: occludes a specific Bragg
+  reflection (a ring placed relative to the image center). The
+  location and thickness of the ring are specified in degrees
+  2-theta.
+<P style='margin-left:.25in'><B>Create Ring masks</B> with a menu command and then by clicking on 
+  the location on the image that should be masked. Or, by pressing the
+  'r' key and then clicking at the appropriate radius. Initially the
+  mask is given a thickness of 0.1 degrees. 
+<P style='margin-left:.25in'><B>Edit Ring mask location</B> by
+  left-clicking on either the inner or outer circle and drag the
+  circle to the new radius. 
+<P style='margin-left:.25in'><B>Edit Ring mask thickness</B> by
+  <a href="#Mac_rightclick">right-clicking*</a> either on the inner or outer circle and drag the
+  the circle change spacing between the inner and outer circle.
+
+<LI style='margin-left:.5in'>Arc masks: occludes a section of a Bragg
+  reflection, similar to a ring mask, except that in addition to the
+  location and thickness of the ring (in degrees
+  2-theta), the starting and ending
+  azimuthal angles are also specified in degrees.
+
+<P style='margin-left:.25in'><B>Create Arc masks</B> with a menu command and then by clicking on 
+  the location on the image that should be masked. Or, by pressing the
+  'a' key and then clicking at the appropriate radius. Initially the
+  mask is given a thickness of 0.1 degrees and an azimuthal range of
+  10 degrees.  
+<P style='margin-left:.25in'><B>Edit Arc mask location</B> by
+  left-clicking on either the inner or outer circle and drag the
+  circle to the new radius. Alternately, left-click on the upper or
+  lower arc limit (the straight lines) and drag them to rotate the
+  center of the arc azimuthal range to a new position. 
+<P style='margin-left:.25in'><B>Edit Arc mask thickness or range</B> by
+  <a href="#Mac_rightclick">right-clicking*</a> either on the inner or outer circle and drag the
+  the circle change spacing between the inner and outer
+  circle. Alternately, <a href="#Mac_rightclick">right-click*</a> on the upper or
+  lower arc limit (the straight lines) and drag them to change the
+  arc azimuthal range.
+
+<LI style='margin-left:.5in'>Polygon masks: occludes an arbitary
+  region created by line segments joining a series of points
+  specified in image coordinates (mm). Pixels inside the polygon mask are not
+  used for integration. 
+<P style='margin-left:.25in'><B>Create Polygon masks</B> with a menu
+  command and then by left-clicking successively on the vertices of the
+  polygon shape surrounding pixels to be excluded. After the last
+  point is defined, <a href="#Mac_rightclick">right-click*</a>
+  anywhere to close the mask. Alternately, press the 'p' key and then
+  left-click, as before, to define the mask and  <a
+  href="#Mac_rightclick">right-click*</a> anywhere to close the mask.
+<P style='margin-left:.25in'><B>Edit Polygon mask</B> by
+  left-clicking on any point at a vertex in the polygon mask and drag
+  that point to a new position. If the vertex is dragged to the same
+  position as any other vertex in the mask the dragged point is deleted.
+<P style='margin-left:.25in'><B>Add a point to Polygon mask</B> by
+  <a href="#Mac_rightclick">right-clicking*</a> on any vertex and dragging. A new
+  point is added to the mask immediately after the selected point at
+  the position where the mouse is released.
+
+<LI style='margin-left:.5in'>The Frame mask: occludes an arbitary
+  region created by line segments joining a series of points
+  specified in image coordinates (mm). Typically a point is placed
+  near each corner of the image. Only pixels inside the frame mask are
+  used for integration. Only one frame mask can be defined.
+<P style='margin-left:.25in'><B>Create a Frame mask</B> with a menu
+  command and then by left-clicking successively on the vertices of a
+  polygon. After the last point is defined, <a href="#Mac_rightclick">right-click*</a>
+  anywhere to close the frame mask. Alternately, press the 'f' key and then
+  left-click, as before, to define the mask and  <a
+  href="#Mac_rightclick">right-click*</a> anywhere to close the mask.
+  Note that if a Frame mask already exists, using the 'f' key or the
+  "Create Frame" menu item causes the existing frame mask to be deleted.
+<P style='margin-left:.25in'><B>Edit the Frame mask</B> by
+  left-clicking on any point at a vertex in the frame mask and drag
+  that point to a new position. If the vertex is dragged to the same
+  position as any other vertex in the mask the dragged point is deleted.
+<P style='margin-left:.25in'><B>Add a point to the Frame mask</B> by
+  <a href="#Mac_rightclick">right-clicking*</a> on any vertex and dragging. A new
+  point is added to the mask immediately after the selected point at
+  the position where the mouse is released.
+</OL>
+<P style='margin-left:.5in'>The frame mask, if defined, is displayed in green, while
+the other types of masks are shown in red. <a name="Mac_rightclick">*</a>Note that on a Mac with a
+  one-button mouse, a right-click is generated by pressing the control
+  button while clicking the mouse. 
+<span class=MsoHyperlink><span
 style='color:windowtext;text-decoration:none;text-underline:none'><o:p></o:p></span></span></span></p>
 
@@ -7496 +7640 @@
 style='mso-bookmark:Pawley'><o:p>&nbsp;</o:p></span></p>
 
-<p class=MsoNormal style='margin-left:.5in'><span style='mso-bookmark:Pawley'><!-- hhmts start -->Last
-modified: Mon Oct 31 17:35:19 CDT 2016 <!-- hhmts end --></span></p>
+<p class=MsoNormal style='margin-left:.5in'><span style='mso-bookmark:Pawley'><!-- hhmts start -->Last modified: Sun Dec 25 21:30:18 CST 2016 <!-- hhmts end --></span></p>
 
 </div>