Changeset 3977


Ignore:
Timestamp:
May 13, 2019 3:23:40 PM (2 years ago)
Author:
toby
Message:

Update help info for Sample Parms & add help button

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIctrlGUI.py

    r3973 r3977  
    3939                                   a filter to help search through choices.
    4040:class:`HelpButton`                Creates a button labeled with a "?" that when pressed
    41                                    displays help text in a modal message window.
     41                                   displays help text in a modal message window
     42                                   or web browser.
    4243:class:`MultiColumnSelection`      A dialog that builds a multicolumn table, word wrapping
    4344                                   is used for the 2nd, 3rd,... columns.
     
    44594460class HelpButton(wx.Button):
    44604461    '''Create a help button that displays help information.
    4461     The text is displayed in a modal message window.
     4462    The text can be displayed in a modal message window or it can be
     4463    a reference to a location in the gsasII.html help web page, in which
     4464    case that page is opened in a web browser.
    44624465
    44634466    TODO: it might be nice if it were non-modal: e.g. it stays around until
     
    44654468    me.
    44664469
    4467     :param parent: the panel which will be the parent of the button
     4470    :param parent: the panel/frame where the button will be placed
    44684471    :param str msg: the help text to be displayed
     4472    :param str helpIndex: location of the help information in the gsasII.html
     4473      help file in the form of an anchor string. The URL will be
     4474      constructed from: location + gsasII.html + "#" + helpIndex
    44694475    '''
    4470     def __init__(self,parent,msg):
     4476    def __init__(self,parent,msg='',helpIndex=''):
    44714477        if sys.platform == "darwin":
    44724478            wx.Button.__init__(self,parent,wx.ID_HELP)
     
    44764482        self.msg=StripIndents(msg)
    44774483        self.parent = parent
     4484        self.helpIndex = helpIndex
    44784485    def _onClose(self,event):
    44794486        self.dlg.EndModal(wx.ID_CANCEL)
    44804487    def _onPress(self,event):
    44814488        'Respond to a button press by displaying the requested text'
     4489        if self.helpIndex:
     4490            ShowHelp(self.helpIndex,self.parent)
     4491            return
    44824492        #dlg = wx.MessageDialog(self.parent,self.msg,'Help info',wx.OK)
    44834493        self.dlg = wx.Dialog(self.parent,wx.ID_ANY,'Help information',
  • trunk/GSASIIpwdGUI.py

    r3914 r3977  
    27522752    mainSizer = G2frame.dataWindow.GetSizer()
    27532753    topSizer = wx.BoxSizer(wx.HORIZONTAL)
    2754     topSizer.Add((-1,-1),0,WACV)
     2754    topSizer.Add((-1,-1),1,WACV|wx.EXPAND)
    27552755    topSizer.Add(wx.StaticText(G2frame.dataWindow,label=' Sample and Experimental Parameters'))
    2756     topSizer.Add((-1,-1),0,WACV)
    2757     mainSizer.Add(topSizer,0,WACV)
     2756    # add help button to bring up help web page
     2757    helpkey = G2frame.dataWindow.helpKey
     2758    topSizer.Add((30,-1))
     2759    topSizer.Add(G2G.HelpButton(G2frame.dataWindow,helpIndex=helpkey))
     2760    topSizer.Add((-1,-1),1,WACV|wx.EXPAND)
     2761    mainSizer.Add(topSizer,0,WACV|wx.EXPAND)
    27582762    nameSizer = wx.BoxSizer(wx.HORIZONTAL)
    27592763    nameSizer.Add(wx.StaticText(G2frame.dataWindow,wx.ID_ANY,' Instrument Name '),0,WACV)
  • trunk/help/gsasII.html

    r3743 r3977  
    32143214side of the window in the "Data Editing" section,
    32153215where information in that item can be viewed or edited. For example, the <a
    3216 href="#Sample_Parameters">&quot;Sample Parameters&quot;</a> item under a ‘PWDR’
     3216href="#PWDR_Sample_Parameters">&quot;Sample Parameters&quot;</a> item under a ‘PWDR’
    32173217entry contains information about how data were collected, such as the sample
    3218 temperature <a href="#Sample_Parameters">(see below)</a>. The arrow keys (up
     3218temperature <a href="#PWDR_Sample_Parameters">(see below)</a>. The arrow keys (up
    32193219&amp; down) move the selection to successive entries in the data tree; both the
    32203220data window and the associated plot (if any) will change.<o:p></o:p></span></p>
     
    47094709
    47104710<p class=MsoNormal style='margin-left:.5in'><span style='mso-fareast-font-family:
    4711 "Times New Roman"'>This window show the various sample dependent parameters for
    4712 this powder pattern. The presence of a refine button indicates that a
     4711"Times New Roman"'>This window shows the various sample-dependent parameters for
     4712the selected powder pattern. The presence of a refine button indicates that a
    47134713parameter can be refined (all others are fixed.) All values shown in
    47144714this window can be edited.
     
    47274727class=MsoHyperlink></span></span></p>
    47284728
    4729 <h5 style='margin-left:.5in'>
    4730 What can I do here?</a></h5>
    4731 
    4732 <h5 style='margin-left:1.0in;text-indent:-.25in;mso-list:l10 level1 lfo21'><span
    4733 style='mso-bookmark:Powder_Peaks'><![if !supportLists]><span
    4734 class=MsoHyperlink><span style='mso-fareast-font-family:"Times New Roman";
    4735 color:windowtext;font-weight:normal;mso-bidi-font-weight:bold;text-decoration:
    4736 none;text-underline:none'><span style='mso-list:Ignore'>1.<span
    4737 style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span></span></span></span><![endif]><span
    4738 style='mso-fareast-font-family:"Times New Roman";color:windowtext;font-weight:
    4739 normal;mso-bidi-font-weight:bold'>Menu ‘</span></span><span style='mso-bookmark:
    4740 Powder_Peaks'><span style='mso-fareast-font-family:"Times New Roman";
    4741 color:windowtext'>File’</span></span><span style='mso-bookmark:Powder_Peaks'><span
    4742 style='mso-fareast-font-family:"Times New Roman";color:windowtext;font-weight:
    4743 normal;mso-bidi-font-weight:bold'> – <span class=MsoHyperlink><span
    4744 style='color:windowtext;text-decoration:none;text-underline:none'><o:p></o:p></span></span></span></span></h5>
    4745 
    4746 <h5 style='margin-left:1.5in;text-indent:-.25in;mso-list:l10 level2 lfo21;
    4747 tab-stops:list 1.0in'><span style='mso-bookmark:Powder_Peaks'><![if !supportLists]><span
    4748 class=MsoHyperlink><span style='mso-fareast-font-family:"Times New Roman";
    4749 color:windowtext;font-weight:normal;mso-bidi-font-weight:bold;text-decoration:
    4750 none;text-underline:none'><span style='mso-list:Ignore'>a.<span
    4751 style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span></span></span></span><![endif]><span
    4752 style='mso-fareast-font-family:"Times New Roman";color:windowtext'>Load</span></span><span
    4753 style='mso-bookmark:Powder_Peaks'><span style='mso-fareast-font-family:"Times New Roman";
    4754 color:windowtext;font-weight:normal;mso-bidi-font-weight:bold'> – this loads
    4755 sample parameters from a previously saved .<span class=SpellE>samprm</span>
    4756 file.<span class=MsoHyperlink><span style='color:windowtext;text-decoration:
    4757 none;text-underline:none'><o:p></o:p></span></span></span></span></h5>
    4758 
    4759 <h5 style='margin-left:1.5in;text-indent:-.25in;mso-list:l10 level2 lfo21;
    4760 tab-stops:list 1.0in'><span style='mso-bookmark:Powder_Peaks'><![if !supportLists]><span
    4761 class=MsoHyperlink><span style='mso-fareast-font-family:"Times New Roman";
    4762 color:windowtext;font-weight:normal;mso-bidi-font-weight:bold;text-decoration:
    4763 none;text-underline:none'><span style='mso-list:Ignore'>b.<span
    4764 style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </span></span></span></span><![endif]><span
    4765 style='mso-fareast-font-family:"Times New Roman";color:windowtext'>Save</span></span><span
    4766 style='mso-bookmark:Powder_Peaks'><span style='mso-fareast-font-family:"Times New Roman";
    4767 color:windowtext;font-weight:normal;mso-bidi-font-weight:bold'> – this saves
    4768 the sample parameters to a file with the extension ’.samprm’. A file dialog box
    4769 will appear to ask for the file name.<span class=MsoHyperlink><span
    4770 style='color:windowtext;text-decoration:none;text-underline:none'><o:p></o:p></span></span></span></span></h5>
    4771 
    4772 <p class=MsoListParagraphCxSpFirst style='margin-left:1.5in;mso-add-space:auto;
    4773 text-indent:-.25in;mso-list:l10 level2 lfo21;tab-stops:list 1.0in'><span
    4774 style='mso-bookmark:Powder_Peaks'><![if !supportLists]><span
    4775 class=MsoHyperlink><span style='mso-fareast-font-family:"Times New Roman";
    4776 color:windowtext;text-decoration:none;text-underline:none'><span
    4777 style='mso-list:Ignore'>c.<span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    4778 </span></span></span></span><![endif]><b style='mso-bidi-font-weight:normal'><span
    4779 style='mso-fareast-font-family:"Times New Roman"'>Copy</span></b></span><span
    4780 style='mso-bookmark:Powder_Peaks'><span style='mso-fareast-font-family:"Times New Roman"'>
    4781 – this copies the sample parameters shown to other selected powder patterns. If
    4782 used, a dialog box (Copy parameters) will appear showing the list of available
    4783 powder patterns, you can copy the sample parameters to any or all of them; select
    4784 ‘All’ to copy them to all patterns. Then select ‘OK’ to do the copy; ‘Cancel’
    4785 to cancel the operation. <span class=MsoHyperlink><span style='color:windowtext;
    4786 text-decoration:none;text-underline:none'><o:p></o:p></span></span></span></span></p>
    4787 
    4788 <p class=MsoListParagraphCxSpLast style='margin-left:1.5in;mso-add-space:auto;
    4789 text-indent:-.25in;mso-list:l10 level2 lfo21;tab-stops:list 1.0in'><span
    4790 style='mso-bookmark:Powder_Peaks'><![if !supportLists]><span
    4791 class=MsoHyperlink><span style='mso-fareast-font-family:"Times New Roman";
    4792 color:windowtext;text-decoration:none;text-underline:none'><span
    4793 style='mso-list:Ignore'>d.<span style='font:7.0pt "Times New Roman"'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
    4794 </span></span></span></span><![endif]><b style='mso-bidi-font-weight:normal'><span
    4795 style='mso-fareast-font-family:"Times New Roman"'>Copy flags</span></b></span><span
    4796 style='mso-bookmark:Powder_Peaks'><span style='mso-fareast-font-family:"Times New Roman"'>
    4797 - – this copies the sample parameter refinement flags shown to other selected
    4798 powder patterns. If used, a dialog box (Copy refinement flags) will appear
    4799 showing the list of available powder patterns, you can copy the sample
    4800 parameter refinement flags to any or all of them; select ‘All’ to copy them to
    4801 all patterns. Then select ‘OK’ to do the copy; ‘Cancel’ to cancel the
    4802 operation. <span class=MsoHyperlink><span style='color:windowtext;text-decoration:
    4803 none;text-underline:none'><o:p></o:p></span></span></span></span></p>
     4729<h5 style='margin-left:.5in'>What can I do here?</h5>
     4730
     4731<p style='margin-left:1.0in'><B>Command</B> Menu items</p>
     4732
     4733<p style='margin-left:1.1in'>In this window you can change
     4734parameters associated with a histogram or set them to be refined. The
     4735histogram scale factor is usually refined.
     4736For <B>Debye-Scherrer</B> mode the "Sample X displacement"
     4737is also ususally refined but the "Sample Y displacement" can only be
     4738refined when data are collected over a two-theta range that extends to
     4739greater than ~140 degrees (typically for CW Neutron). Sample absorption should not be
     4740refined when all atomic displacement parameters (Uiso or Uaniso
     4741values) are varied, as the correlation is very high. For
     4742<B>Bragg-Brentano</B>, "Sample displacement" is usually refined and for low-Z
     4743samples "Sample transparency" is usually refined. "Surface roughness"
     4744parameters are not usually refined.
     4745
     4746Remaining parameters are of use for texture or parametric studies and
     4747may be changed with the menu commands described here.
     4748</p>
     4749
     4750
     4751<DL style='margin-left:1.25in'>
     4752  <DT>Set scale</DT><DD>Rescales a pattern by multiplying by the
     4753    current scale factor.
     4754  </DD>
     4755 
     4756  <DT>Load</DT><DD>
     4757    This loads sample parameters from a previously saved .<span
     4758  class=SpellE>samprm</span> file. </DD>
     4759
     4760  <DT>Save</DT><DD>
     4761    This saves the sample parameters to a file with the extension
     4762    ’.samprm’. A file dialog box will appear to ask for the name of
     4763    the file to be written. </DD>
     4764
     4765<DT>Copy</DT><DD>
     4766  This copies the sample parameters shown to other selected powder
     4767  patterns. If used, a dialog box (Copy parameters) will appear
     4768  showing the list of available powder patterns, you can copy the
     4769  sample parameters to any or all of them; select ‘All’ to copy them
     4770  to all patterns. Then select ‘OK’ to do the copy; ‘Cancel’
     4771  to cancel the operation.
     4772</DD>
     4773
     4774<DT>Copy selected...</DT><DD>
     4775  This copies only the sample parameter that are selected to other
     4776  selected powder patterns, but is otherwise similar to "Copy".
     4777  </DD>
     4778 
     4779  <DT>Copy flags</DT><DD>
     4780    This copies the sample parameter refinement flags shown to other
     4781    selected powder patterns. If used, a dialog box (Copy refinement
     4782    flags) will appear showing the list of available powder patterns,
     4783    you can copy the sample parameter refinement flags to any or all
     4784    of them; select ‘All’ to copy them to all patterns. Then select
     4785    ‘OK’ to do the copy; ‘Cancel’ to cancel the operation.
     4786  </DD>
     4787 
     4788  <DT>Set one value</DT><DD>
     4789    This is used to set a single selected sample parameter for a
     4790    selected set of PWDR histograms. The same value can be used for
     4791    all histograms or a dialog can be used to provide a table where
     4792    you can set the values differently for each of selected
     4793    histograms.
     4794  </DD>
     4795 
     4796  <DT>Load all</DT><DD>
     4797    Reads a file containing a table of sample parameters and copies
     4798    them to matching PWDR entries. The file will look something like
     4799    the example here:
     4800<blockquote><PRE>
     4801#filename       temperature pressure ignore-me  humidity
     4802LaB6_dc250.tif      100          1      test       .2
     4803LaB6_dc300.tif      150          1      test       .25
     4804</PRE></blockquote>
     4805    Note that the first line(s) in the file can be a header, but each
     4806    header line must start marked with a hash (#). A header is not
     4807    required. "Columns" in the table are separated by one or more
     4808    delimiters (which may be a comma, tab or space). Note that columns
     4809    do not need to be aligned, as long as each entry is spaced by at
     4810    least one delimiter. The first column in the table is used to
     4811    look up PWDR entries where the initial space-delimited string
     4812    after the PWDR tag ("myfile" in "PWRD myfile AZM=180...") must
     4813    match the table. Subsequent columns can then be mapped to
     4814    sample parameters or can be ignored, using a dialog window.
     4815  </DD>
     4816 
     4817  <DT>Rescale all</DT><DD>
     4818    Allows a series of selected PWDR histograms to be put on a common
     4819    scale by integrating them over a specific two-theta region and
     4820    then scaling them so that the integration range will match the
     4821    first pattern.
     4822  </DD>
     4823 
     4824  </DL>
     4825   
    48044826
    48054827<h4 style='margin-left:0.25in'><a name="PWDR_Peak_List"></a><u>
     
    71567178<hr size=2 width="100%" align=center>
    71577179
    7158 <!-- hhmts start -->Last modified: Tue Nov 20 21:31:35 CST 2018 <!-- hhmts end -->
     7180<!-- hhmts start -->Last modified: Mon May 13 12:33:41 CDT 2019 <!-- hhmts end -->
    71597181
    71607182</div>
Note: See TracChangeset for help on using the changeset viewer.