source: sphinxdocs/build/html/GSASIIGUI.html @ 1709

Last change on this file since 1709 was 1709, checked in by toby, 8 years ago

change sphinx docs links; rebuild & fixing minor formatting
  • Property svn:mime-type set to text/html
File size: 50.6 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>GSAS-II GUI Submodules &mdash; GSAS-II 0.2.0 documentation</title>
10   
11    <link rel="stylesheet" href="_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    './',
17        VERSION:     '0.2.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="_static/jquery.js"></script>
24    <script type="text/javascript" src="_static/underscore.js"></script>
25    <script type="text/javascript" src="_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="GSAS-II 0.2.0 documentation" href="index.html" />
28    <link rel="next" title="GSAS-II Structure Submodules" href="GSASIIstruc.html" />
29    <link rel="prev" title="GSAS-II GUI Routines" href="GSASIIGUIr.html" /> 
30  </head>
31  <body>
32    <div class="related">
33      <h3>Navigation</h3>
34      <ul>
35        <li class="right" style="margin-right: 10px">
36          <a href="genindex.html" title="General Index"
37             accesskey="I">index</a></li>
38        <li class="right" >
39          <a href="py-modindex.html" title="Python Module Index"
40             >modules</a> |</li>
41        <li class="right" >
42          <a href="GSASIIstruc.html" title="GSAS-II Structure Submodules"
43             accesskey="N">next</a> |</li>
44        <li class="right" >
45          <a href="GSASIIGUIr.html" title="GSAS-II GUI Routines"
46             accesskey="P">previous</a> |</li>
47        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="module-GSASIIphsGUI">
57<span id="gsas-ii-gui-submodules"></span><h1><em>GSAS-II GUI Submodules</em><a class="headerlink" href="#module-GSASIIphsGUI" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="gsasiiphsgui-phase-gui">
59<h2><em>GSASIIphsGUI: Phase GUI</em><a class="headerlink" href="#gsasiiphsgui-phase-gui" title="Permalink to this headline">¶</a></h2>
60<p>Module to create the GUI for display of phase information
61in the data display window when a phase is selected.
62Phase information is stored in one or more
63<a class="reference internal" href="GSASIIobj.html#phase-table"><em>Phase Tree Item</em></a> objects.
64Note that there are functions
65that respond to some tabs in the phase GUI in other modules
66(such as GSASIIddata).</p>
67<dl class="function">
68<dt id="GSASIIphsGUI.UpdatePhaseData">
69<tt class="descclassname">GSASIIphsGUI.</tt><tt class="descname">UpdatePhaseData</tt><big>(</big><em>G2frame</em>, <em>Item</em>, <em>data</em>, <em>oldPage</em><big>)</big><a class="reference internal" href="_modules/GSASIIphsGUI.html#UpdatePhaseData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIphsGUI.UpdatePhaseData" title="Permalink to this definition">¶</a></dt>
70<dd><p>Create the data display window contents when a phase is clicked on
71in the main (data tree) window.
72Called only from <a class="reference internal" href="GSASIIGUIr.html#GSASIIgrid.MovePatternTreeToGrid" title="GSASIIgrid.MovePatternTreeToGrid"><tt class="xref py py-meth docutils literal"><span class="pre">GSASIIgrid.MovePatternTreeToGrid()</span></tt></a>,
73which in turn is called from <a class="reference internal" href="GSASII.html#GSASII.GSASII.OnPatternTreeSelChanged" title="GSASII.GSASII.OnPatternTreeSelChanged"><tt class="xref py py-meth docutils literal"><span class="pre">GSASII.GSASII.OnPatternTreeSelChanged()</span></tt></a>
74when a tree item is selected.</p>
75<table class="docutils field-list" frame="void" rules="none">
76<col class="field-name" />
77<col class="field-body" />
78<tbody valign="top">
79<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
80<li><strong>G2frame</strong> (<em>wx.frame</em>) &#8211; the main GSAS-II frame object</li>
81<li><strong>Item</strong> (<em>wx.TreeItemId</em>) &#8211; the tree item that was selected</li>
82<li><strong>data</strong> (<em>dict</em>) &#8211; all the information on the phase in a dictionary</li>
83<li><strong>oldPage</strong> (<em>int</em>) &#8211; This sets a tab to select when moving
84from one phase to another, in which case the same tab is selected
85to display first. This is set only when the previous data tree
86selection is a phase, if not the value is None. The default action
87is to bring up the General tab.</li>
88</ul>
89</td>
90</tr>
91</tbody>
92</table>
93</dd></dl>
94
95</div>
96<span class="target" id="module-GSASIIddataGUI"></span><div class="section" id="gsasiiddatagui-phase-diffraction-data-gui">
97<h2><em>GSASIIddataGUI: Phase Diffraction Data GUI</em><a class="headerlink" href="#gsasiiddatagui-phase-diffraction-data-gui" title="Permalink to this headline">¶</a></h2>
98<p>Module to create the GUI for display of diffraction data * phase
99information that is shown in the data display window
100(when a phase is selected.)</p>
101<dl class="function">
102<dt id="GSASIIddataGUI.UpdateDData">
103<tt class="descclassname">GSASIIddataGUI.</tt><tt class="descname">UpdateDData</tt><big>(</big><em>G2frame</em>, <em>DData</em>, <em>data</em>, <em>hist=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIddataGUI.html#UpdateDData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIddataGUI.UpdateDData" title="Permalink to this definition">¶</a></dt>
104<dd><p>Display the Diffraction Data associated with a phase
105(items where there is a value for each histogram and phase)</p>
106<table class="docutils field-list" frame="void" rules="none">
107<col class="field-name" />
108<col class="field-body" />
109<tbody valign="top">
110<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
111<li><strong>G2frame</strong> (<em>wx.frame</em>) &#8211; the main GSAS-II frame object</li>
112<li><strong>DData</strong> (<em>wx.ScrolledWindow</em>) &#8211; notebook page to be used for the display</li>
113<li><strong>data</strong> (<em>dict</em>) &#8211; all the information on the phase in a dictionary</li>
114</ul>
115</td>
116</tr>
117</tbody>
118</table>
119</dd></dl>
120
121</div>
122<span class="target" id="module-GSASIIElemGUI"></span><div class="section" id="gsasiielemgui-gui-to-select-and-delete-element-lists">
123<h2><em>GSASIIElemGUI: GUI to select and delete element lists</em><a class="headerlink" href="#gsasiielemgui-gui-to-select-and-delete-element-lists" title="Permalink to this headline">¶</a></h2>
124<p>Module to select elements from a periodic table and
125to delete an element from a list of selected elements.</p>
126<dl class="class">
127<dt id="GSASIIElemGUI.DeleteElement">
128<em class="property">class </em><tt class="descclassname">GSASIIElemGUI.</tt><tt class="descname">DeleteElement</tt><big>(</big><em>parent</em>, <em>choice</em><big>)</big><a class="reference internal" href="_modules/GSASIIElemGUI.html#DeleteElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIElemGUI.DeleteElement" title="Permalink to this definition">¶</a></dt>
129<dd><p>Delete element from selected set widget</p>
130<dl class="method">
131<dt id="GSASIIElemGUI.DeleteElement.ElButton">
132<tt class="descname">ElButton</tt><big>(</big><em>id</em>, <em>name</em>, <em>pos</em><big>)</big><a class="reference internal" href="_modules/GSASIIElemGUI.html#DeleteElement.ElButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIElemGUI.DeleteElement.ElButton" title="Permalink to this definition">¶</a></dt>
133<dd><p>Needs a doc string</p>
134</dd></dl>
135
136</dd></dl>
137
138<dl class="class">
139<dt id="GSASIIElemGUI.PickElement">
140<em class="property">class </em><tt class="descclassname">GSASIIElemGUI.</tt><tt class="descname">PickElement</tt><big>(</big><em>parent</em>, <em>oneOnly=False</em>, <em>ifNone=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIElemGUI.html#PickElement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIElemGUI.PickElement" title="Permalink to this definition">¶</a></dt>
141<dd><p>Makes periodic table widget for picking element - caller maintains element list</p>
142<dl class="method">
143<dt id="GSASIIElemGUI.PickElement.ElButton">
144<tt class="descname">ElButton</tt><big>(</big><em>name</em>, <em>pos</em>, <em>tip</em>, <em>color</em><big>)</big><a class="reference internal" href="_modules/GSASIIElemGUI.html#PickElement.ElButton"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIElemGUI.PickElement.ElButton" title="Permalink to this definition">¶</a></dt>
145<dd><p>Needs a doc string</p>
146</dd></dl>
147
148</dd></dl>
149
150<dl class="class">
151<dt id="GSASIIElemGUI.PickElements">
152<em class="property">class </em><tt class="descclassname">GSASIIElemGUI.</tt><tt class="descname">PickElements</tt><big>(</big><em>parent</em>, <em>list</em><big>)</big><a class="reference internal" href="_modules/GSASIIElemGUI.html#PickElements"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIElemGUI.PickElements" title="Permalink to this definition">¶</a></dt>
153<dd><p>Makes periodic table widget for picking elements - caller maintains element list</p>
154</dd></dl>
155
156</div>
157<span class="target" id="module-GSASIIconstrGUI"></span><div class="section" id="gsasiiconstrgui-constraint-gui-routines">
158<h2><em>GSASIIconstrGUI: Constraint GUI routines</em><a class="headerlink" href="#gsasiiconstrgui-constraint-gui-routines" title="Permalink to this headline">¶</a></h2>
159<p>Used to define constraints and rigid bodies.</p>
160<dl class="class">
161<dt id="GSASIIconstrGUI.ConstraintDialog">
162<em class="property">class </em><tt class="descclassname">GSASIIconstrGUI.</tt><tt class="descname">ConstraintDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>text</em>, <em>data</em>, <em>separator='*'</em>, <em>varname=''</em>, <em>varyflag=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIconstrGUI.html#ConstraintDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIconstrGUI.ConstraintDialog" title="Permalink to this definition">¶</a></dt>
163<dd><p>Window to edit Constraint values</p>
164</dd></dl>
165
166<dl class="class">
167<dt id="GSASIIconstrGUI.MultiIntegerDialog">
168<em class="property">class </em><tt class="descclassname">GSASIIconstrGUI.</tt><tt class="descname">MultiIntegerDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompts</em>, <em>values</em><big>)</big><a class="reference internal" href="_modules/GSASIIconstrGUI.html#MultiIntegerDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIconstrGUI.MultiIntegerDialog" title="Permalink to this definition">¶</a></dt>
169<dd><p>Input a series of integers based on prompts</p>
170</dd></dl>
171
172<dl class="function">
173<dt id="GSASIIconstrGUI.UpdateConstraints">
174<tt class="descclassname">GSASIIconstrGUI.</tt><tt class="descname">UpdateConstraints</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIconstrGUI.html#UpdateConstraints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIconstrGUI.UpdateConstraints" title="Permalink to this definition">¶</a></dt>
175<dd><p>Called when Constraints tree item is selected.
176Displays the constraints in the data window</p>
177</dd></dl>
178
179<dl class="function">
180<dt id="GSASIIconstrGUI.UpdateRigidBodies">
181<tt class="descclassname">GSASIIconstrGUI.</tt><tt class="descname">UpdateRigidBodies</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIconstrGUI.html#UpdateRigidBodies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIconstrGUI.UpdateRigidBodies" title="Permalink to this definition">¶</a></dt>
182<dd><p>Called when Rigid bodies tree item is selected.
183Displays the rigid bodies in the data window</p>
184</dd></dl>
185
186</div>
187<span class="target" id="module-GSASIIimgGUI"></span><div class="section" id="gsasiiimggui-image-gui">
188<h2><em>GSASIIimgGUI: Image GUI</em><a class="headerlink" href="#gsasiiimggui-image-gui" title="Permalink to this headline">¶</a></h2>
189<p>Control image display and processing</p>
190<dl class="function">
191<dt id="GSASIIimgGUI.CleanupMasks">
192<tt class="descclassname">GSASIIimgGUI.</tt><tt class="descname">CleanupMasks</tt><big>(</big><em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimgGUI.html#CleanupMasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimgGUI.CleanupMasks" title="Permalink to this definition">¶</a></dt>
193<dd><p>If a mask creation is not completed, an empty mask entry is created in the
194masks array. This cleans them out. It is called when the masks page is first loaded
195and before saving them or after reading them in. This should also probably be done
196before they are used for integration.</p>
197</dd></dl>
198
199<dl class="function">
200<dt id="GSASIIimgGUI.UpdateImageControls">
201<tt class="descclassname">GSASIIimgGUI.</tt><tt class="descname">UpdateImageControls</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>masks</em><big>)</big><a class="reference internal" href="_modules/GSASIIimgGUI.html#UpdateImageControls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimgGUI.UpdateImageControls" title="Permalink to this definition">¶</a></dt>
202<dd><p>Shows and handles the controls on the &#8220;Image Controls&#8221;
203data tree entry</p>
204</dd></dl>
205
206<dl class="function">
207<dt id="GSASIIimgGUI.UpdateMasks">
208<tt class="descclassname">GSASIIimgGUI.</tt><tt class="descname">UpdateMasks</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimgGUI.html#UpdateMasks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimgGUI.UpdateMasks" title="Permalink to this definition">¶</a></dt>
209<dd><p>Shows and handles the controls on the &#8220;Masks&#8221; data tree entry</p>
210</dd></dl>
211
212<dl class="function">
213<dt id="GSASIIimgGUI.UpdateStressStrain">
214<tt class="descclassname">GSASIIimgGUI.</tt><tt class="descname">UpdateStressStrain</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimgGUI.html#UpdateStressStrain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimgGUI.UpdateStressStrain" title="Permalink to this definition">¶</a></dt>
215<dd><p>Shows and handles the controls on the &#8220;Stress/Strain&#8221;
216data tree entry</p>
217</dd></dl>
218
219</div>
220<span class="target" id="module-GSASIIpwdGUI"></span><div class="section" id="gsasiipwdgui-powder-pattern-gui-routines">
221<h2><em>GSASIIpwdGUI: Powder Pattern GUI routines</em><a class="headerlink" href="#gsasiipwdgui-powder-pattern-gui-routines" title="Permalink to this headline">¶</a></h2>
222<p>Used to define GUI controls for the routines that interact
223with the powder histogram (PWDR) data tree items.</p>
224<dl class="function">
225<dt id="GSASIIpwdGUI.CopyPlotCtrls">
226<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">CopyPlotCtrls</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#CopyPlotCtrls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.CopyPlotCtrls" title="Permalink to this definition">¶</a></dt>
227<dd><p>Global copy: Copy plot controls from current histogram to others.</p>
228</dd></dl>
229
230<dl class="function">
231<dt id="GSASIIpwdGUI.CopySelectedHistItems">
232<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">CopySelectedHistItems</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#CopySelectedHistItems"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.CopySelectedHistItems" title="Permalink to this definition">¶</a></dt>
233<dd><p>Global copy: Copy items from current histogram to others.</p>
234</dd></dl>
235
236<dl class="function">
237<dt id="GSASIIpwdGUI.GetHistsLikeSelected">
238<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">GetHistsLikeSelected</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#GetHistsLikeSelected"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.GetHistsLikeSelected" title="Permalink to this definition">¶</a></dt>
239<dd><p>Get the histograms that match the current selected one:
240The histogram prefix and data type (PXC etc.), the number of
241wavelengths and the instrument geometry (Debye-Scherrer etc.)
242must all match. The current histogram is not included in the list.</p>
243<table class="docutils field-list" frame="void" rules="none">
244<col class="field-name" />
245<col class="field-body" />
246<tbody valign="top">
247<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>G2frame</strong> (<em>wx.Frame</em>) &#8211; pointer to main GSAS-II data tree</td>
248</tr>
249</tbody>
250</table>
251</dd></dl>
252
253<dl class="function">
254<dt id="GSASIIpwdGUI.IsHistogramInAnyPhase">
255<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">IsHistogramInAnyPhase</tt><big>(</big><em>G2frame</em>, <em>histoName</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#IsHistogramInAnyPhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.IsHistogramInAnyPhase" title="Permalink to this definition">¶</a></dt>
256<dd><p>Needs a doc string</p>
257</dd></dl>
258
259<dl class="function">
260<dt id="GSASIIpwdGUI.SetCopyNames">
261<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">SetCopyNames</tt><big>(</big><em>histName</em>, <em>dataType</em>, <em>addNames=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#SetCopyNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.SetCopyNames" title="Permalink to this definition">¶</a></dt>
262<dd><p>Determine the items in the sample parameters that should be copied,
263depending on the histogram type and the instrument type.</p>
264</dd></dl>
265
266<dl class="function">
267<dt id="GSASIIpwdGUI.SetDefaultSASDModel">
268<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">SetDefaultSASDModel</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#SetDefaultSASDModel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.SetDefaultSASDModel" title="Permalink to this definition">¶</a></dt>
269<dd><p>Fills in default items for the SASD Models dictionary</p>
270</dd></dl>
271
272<dl class="function">
273<dt id="GSASIIpwdGUI.SetDefaultSample">
274<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">SetDefaultSample</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#SetDefaultSample"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.SetDefaultSample" title="Permalink to this definition">¶</a></dt>
275<dd><p>Fills in default items for the Sample dictionary</p>
276</dd></dl>
277
278<dl class="function">
279<dt id="GSASIIpwdGUI.SetDefaultSubstances">
280<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">SetDefaultSubstances</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#SetDefaultSubstances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.SetDefaultSubstances" title="Permalink to this definition">¶</a></dt>
281<dd><p>Fills in default items for the SASD Substances dictionary</p>
282</dd></dl>
283
284<dl class="function">
285<dt id="GSASIIpwdGUI.SetupSampleLabels">
286<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">SetupSampleLabels</tt><big>(</big><em>histName</em>, <em>dataType</em>, <em>histType</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#SetupSampleLabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.SetupSampleLabels" title="Permalink to this definition">¶</a></dt>
287<dd><p>Setup a list of labels and number formatting for use in
288labeling sample parameters.
289:param str histName: Name of histogram, (&#8220;PWDR ...&#8221;)
290:param str dataType:</p>
291</dd></dl>
292
293<dl class="function">
294<dt id="GSASIIpwdGUI.UpdateBackground">
295<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateBackground</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateBackground"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateBackground" title="Permalink to this definition">¶</a></dt>
296<dd><p>respond to selection of PWDR background data tree item.</p>
297</dd></dl>
298
299<dl class="function">
300<dt id="GSASIIpwdGUI.UpdateIndexPeaksGrid">
301<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateIndexPeaksGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateIndexPeaksGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateIndexPeaksGrid" title="Permalink to this definition">¶</a></dt>
302<dd><p>respond to selection of PWDR Index Peak List data
303tree item.</p>
304</dd></dl>
305
306<dl class="function">
307<dt id="GSASIIpwdGUI.UpdateInstrumentGrid">
308<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateInstrumentGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateInstrumentGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateInstrumentGrid" title="Permalink to this definition">¶</a></dt>
309<dd><p>respond to selection of PWDR/SASD Instrument Parameters
310data tree item.</p>
311</dd></dl>
312
313<dl class="function">
314<dt id="GSASIIpwdGUI.UpdateLimitsGrid">
315<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateLimitsGrid</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>plottype</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateLimitsGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateLimitsGrid" title="Permalink to this definition">¶</a></dt>
316<dd><p>respond to selection of PWDR Limits data tree item.</p>
317</dd></dl>
318
319<dl class="function">
320<dt id="GSASIIpwdGUI.UpdateModelsGrid">
321<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateModelsGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateModelsGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateModelsGrid" title="Permalink to this definition">¶</a></dt>
322<dd><p>respond to selection of SASD Models data tree item.</p>
323</dd></dl>
324
325<dl class="function">
326<dt id="GSASIIpwdGUI.UpdatePDFGrid">
327<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdatePDFGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdatePDFGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdatePDFGrid" title="Permalink to this definition">¶</a></dt>
328<dd><p>respond to selection of PWDR PDF data tree item.</p>
329</dd></dl>
330
331<dl class="function">
332<dt id="GSASIIpwdGUI.UpdatePeakGrid">
333<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdatePeakGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdatePeakGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdatePeakGrid" title="Permalink to this definition">¶</a></dt>
334<dd><p>respond to selection of PWDR powder peaks data tree item.</p>
335</dd></dl>
336
337<dl class="function">
338<dt id="GSASIIpwdGUI.UpdateReflectionGrid">
339<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateReflectionGrid</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>HKLF=False</em>, <em>Name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateReflectionGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateReflectionGrid" title="Permalink to this definition">¶</a></dt>
340<dd><p>respond to selection of PWDR Reflections data tree item by displaying
341a table of reflections in the data window.</p>
342</dd></dl>
343
344<dl class="function">
345<dt id="GSASIIpwdGUI.UpdateSampleGrid">
346<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateSampleGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateSampleGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateSampleGrid" title="Permalink to this definition">¶</a></dt>
347<dd><p>respond to selection of PWDR/SASD Sample Parameters
348data tree item.</p>
349</dd></dl>
350
351<dl class="function">
352<dt id="GSASIIpwdGUI.UpdateSubstanceGrid">
353<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateSubstanceGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateSubstanceGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateSubstanceGrid" title="Permalink to this definition">¶</a></dt>
354<dd><p>respond to selection of SASD Substance data tree item.</p>
355</dd></dl>
356
357<dl class="function">
358<dt id="GSASIIpwdGUI.UpdateUnitCellsGrid">
359<tt class="descclassname">GSASIIpwdGUI.</tt><tt class="descname">UpdateUnitCellsGrid</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIpwdGUI.html#UpdateUnitCellsGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIpwdGUI.UpdateUnitCellsGrid" title="Permalink to this definition">¶</a></dt>
360<dd><p>respond to selection of PWDR Unit Cells data tree item.</p>
361</dd></dl>
362
363</div>
364<span class="target" id="module-GSASIIrestrGUI"></span><div class="section" id="gsasiirestrgui-restraint-gui-routines">
365<h2><em>GSASIIrestrGUI: Restraint GUI routines</em><a class="headerlink" href="#gsasiirestrgui-restraint-gui-routines" title="Permalink to this headline">¶</a></h2>
366<p>Used to define restraints.</p>
367<dl class="function">
368<dt id="GSASIIrestrGUI.UpdateRestraints">
369<tt class="descclassname">GSASIIrestrGUI.</tt><tt class="descname">UpdateRestraints</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>Phases</em>, <em>phaseName</em><big>)</big><a class="reference internal" href="_modules/GSASIIrestrGUI.html#UpdateRestraints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIrestrGUI.UpdateRestraints" title="Permalink to this definition">¶</a></dt>
370<dd><p>Respond to selection of the Restraints item on the
371data tree</p>
372</dd></dl>
373
374</div>
375<span class="target" id="module-GSASIIexprGUI"></span><div class="section" id="gsasiiexprgui-expression-handling">
376<h2><em>GSASIIexprGUI: Expression Handling</em><a class="headerlink" href="#gsasiiexprgui-expression-handling" title="Permalink to this headline">¶</a></h2>
377<p>This module defines a class for defining an expression in terms of values
378in a parameter dictionary via a wx.Dialog. The dialog creates a <tt class="xref py py-class docutils literal"><span class="pre">GSASII.ExpressionObj</span></tt>
379which is used to evaluate the expression against a supplied parameter dictionary.</p>
380<p>The expression is parsed to find variables used in the expression and then
381the user is asked to assign parameters from the dictionary to each variable.</p>
382<p>Default expressions are read from file DefaultExpressions.txt using
383<a class="reference internal" href="GSASIIutil.html#GSASIIpath.LoadConfigFile" title="GSASIIpath.LoadConfigFile"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIpath.LoadConfigFile()</span></tt></a>.</p>
384<dl class="class">
385<dt id="GSASIIexprGUI.ExpressionDialog">
386<em class="property">class </em><tt class="descclassname">GSASIIexprGUI.</tt><tt class="descname">ExpressionDialog</tt><big>(</big><em>parent</em>, <em>parmDict</em>, <em>exprObj=None</em>, <em>header='Enter restraint expression here'</em>, <em>wintitle='Expression Editor'</em>, <em>fit=True</em>, <em>VarLabel=None</em>, <em>depVarDict=None</em>, <em>ExtraButton=None</em>, <em>usedVars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog" title="Permalink to this definition">¶</a></dt>
387<dd><p>A wx.Dialog that allows a user to input an arbitrary expression
388to be evaluated and possibly minimized.</p>
389<p>To do this, the user assigns a new (free) or existing
390GSAS-II parameter to each parameter label used in the expression.
391The free parameters can optionally be designated to be refined.
392For example, is an expression is used such as:</p>
393<div class="highlight-python"><div class="highlight"><pre><span class="s">&#39;A*np.exp(-B/C)&#39;</span>
394</pre></div>
395</div>
396<p>then A, B and C can each be assigned as Free parameter with a user-selected
397value or to any existing GSAS-II variable in the parameter dictionary.
398As the expression is entered it is checked for validity.</p>
399<p>After the <a class="reference internal" href="#GSASIIexprGUI.ExpressionDialog" title="GSASIIexprGUI.ExpressionDialog"><tt class="xref py py-class docutils literal"><span class="pre">ExpressionDialog</span></tt></a> object is created, use <a class="reference internal" href="#GSASIIexprGUI.ExpressionDialog.Show" title="GSASIIexprGUI.ExpressionDialog.Show"><tt class="xref py py-meth docutils literal"><span class="pre">Show()</span></tt></a> to
400run it and obtain a <a class="reference internal" href="GSASIIobj.html#GSASIIobj.ExpressionObj" title="GSASIIobj.ExpressionObj"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIobj.ExpressionObj</span></tt></a> object with the user
401input.</p>
402<table class="docutils field-list" frame="void" rules="none">
403<col class="field-name" />
404<col class="field-body" />
405<tbody valign="top">
406<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
407<li><strong>parent</strong> (<em>wx.Frame</em>) &#8211; The parent of the Dialog. Can be None,
408but better is to provide the name of the Frame where the dialog
409is called.</li>
410<li><strong>parmDict</strong> (<em>dict</em>) &#8211; a dict with defined parameters and their values. Each value
411may be a list with parameter values and a refine flag or may just contain
412the parameter value (non-float/int values in dict are ignored)</li>
413<li><strong>exprObj</strong> (<em>str</em>) &#8211; a <a class="reference internal" href="GSASIIobj.html#GSASIIobj.ExpressionObj" title="GSASIIobj.ExpressionObj"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIobj.ExpressionObj</span></tt></a> object with an expression and
414label assignments or None (default)</li>
415<li><strong>wintitle</strong> (<em>str</em>) &#8211; String placed on title bar of dialog;
416defaults to &#8220;Expression Editor&#8221;</li>
417<li><strong>header</strong> (<em>str</em>) &#8211; String placed at top of dialog to tell the user
418what they will do here; default is &#8220;Enter restraint expression here&#8221;</li>
419<li><strong>fit</strong> (<em>bool</em>) &#8211; determines if the expression will be used in fitting (default=True).
420If set to False, and refinement flags are not shown
421and Free parameters are not offered as an assignment option.</li>
422<li><strong>VarLabel</strong> (<em>str</em>) &#8211; an optional variable label to include before the expression
423input. Ignored if None (default)</li>
424<li><strong>depVarDict</strong> (<em>list</em>) &#8211; a dict of choices for the dependent variable to be
425fitted to the expression and their values. Ignored if None (default).</li>
426<li><strong>ExtraButton</strong> (<em>list</em>) &#8211; a list with two terms that define [0]: the label
427for an extra button and [1] the callback routine to be used when the
428button is pressed. The button will only be enabled when the OK button can be
429used (meaning the equation/expression is valid). The default is None, meaning this
430will not be used.</li>
431<li><strong>usedVars</strong> (<em>list</em>) &#8211; defines a list of previously used variable names. These names
432will not be reused as defaults for new free variables.
433(The default is an empty list).</li>
434</ul>
435</td>
436</tr>
437</tbody>
438</table>
439<dl class="method">
440<dt id="GSASIIexprGUI.ExpressionDialog.CheckVars">
441<tt class="descname">CheckVars</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.CheckVars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.CheckVars" title="Permalink to this definition">¶</a></dt>
442<dd><p>Check that appropriate variables are defined for each
443symbol used in <tt class="xref py py-data docutils literal"><span class="pre">self.expr</span></tt></p>
444<table class="docutils field-list" frame="void" rules="none">
445<col class="field-name" />
446<col class="field-body" />
447<tbody valign="top">
448<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a text error message or None if all needed input is present</td>
449</tr>
450</tbody>
451</table>
452</dd></dl>
453
454<dl class="method">
455<dt id="GSASIIexprGUI.ExpressionDialog.GetDepVar">
456<tt class="descname">GetDepVar</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.GetDepVar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.GetDepVar" title="Permalink to this definition">¶</a></dt>
457<dd><p>Returns the name of the dependent variable, when depVarDict is used.</p>
458</dd></dl>
459
460<dl class="method">
461<dt id="GSASIIexprGUI.ExpressionDialog.OnChar">
462<tt class="descname">OnChar</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.OnChar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.OnChar" title="Permalink to this definition">¶</a></dt>
463<dd><p>Called as each character is entered. Cancels any running timer
464and starts a new one. The timer causes a check of syntax after 2 seconds
465without input.
466Disables the OK button until a validity check is complete.</p>
467</dd></dl>
468
469<dl class="method">
470<dt id="GSASIIexprGUI.ExpressionDialog.OnChoice">
471<tt class="descname">OnChoice</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.OnChoice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.OnChoice" title="Permalink to this definition">¶</a></dt>
472<dd><p>Respond to a selection of a variable type for a label in
473an expression</p>
474</dd></dl>
475
476<dl class="method">
477<dt id="GSASIIexprGUI.ExpressionDialog.OnDepChoice">
478<tt class="descname">OnDepChoice</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.OnDepChoice"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.OnDepChoice" title="Permalink to this definition">¶</a></dt>
479<dd><p>Respond to a selection of a variable type for a label in
480an expression</p>
481</dd></dl>
482
483<dl class="method">
484<dt id="GSASIIexprGUI.ExpressionDialog.OnValidate">
485<tt class="descname">OnValidate</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.OnValidate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.OnValidate" title="Permalink to this definition">¶</a></dt>
486<dd><p>Respond to a press of the Validate button or when a variable
487is associated with a label (in <a class="reference internal" href="#GSASIIexprGUI.ExpressionDialog.OnChoice" title="GSASIIexprGUI.ExpressionDialog.OnChoice"><tt class="xref py py-meth docutils literal"><span class="pre">OnChoice()</span></tt></a>)</p>
488</dd></dl>
489
490<dl class="method">
491<dt id="GSASIIexprGUI.ExpressionDialog.Repaint">
492<tt class="descname">Repaint</tt><big>(</big><em>exprObj</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.Repaint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.Repaint" title="Permalink to this definition">¶</a></dt>
493<dd><p>Redisplay the variables and continue the validation</p>
494</dd></dl>
495
496<dl class="method">
497<dt id="GSASIIexprGUI.ExpressionDialog.RestartTimer">
498<tt class="descname">RestartTimer</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.RestartTimer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.RestartTimer" title="Permalink to this definition">¶</a></dt>
499<dd><p>Cancels any running timer and starts a new one.
500The timer causes a check of syntax after 2 seconds unless there is further input.
501Disables the OK button until a validity check is complete.</p>
502</dd></dl>
503
504<dl class="method">
505<dt id="GSASIIexprGUI.ExpressionDialog.SelectG2var">
506<tt class="descname">SelectG2var</tt><big>(</big><em>sel</em>, <em>var</em>, <em>parmList</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.SelectG2var"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.SelectG2var" title="Permalink to this definition">¶</a></dt>
507<dd><p>Offer a selection of a GSAS-II variable.</p>
508<table class="docutils field-list" frame="void" rules="none">
509<col class="field-name" />
510<col class="field-body" />
511<tbody valign="top">
512<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sel</strong> (<em>int</em>) &#8211; Determines the type of variable to be selected.
513where 1 is used for Phase variables, and 2 for Histogram/Phase vars,
5143 for Histogram vars and 4 for Global vars.</td>
515</tr>
516<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a variable name or None (if Cancel is pressed)</td>
517</tr>
518</tbody>
519</table>
520</dd></dl>
521
522<dl class="method">
523<dt id="GSASIIexprGUI.ExpressionDialog.Show">
524<tt class="descname">Show</tt><big>(</big><em>mode=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.Show"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.Show" title="Permalink to this definition">¶</a></dt>
525<dd><p>Call to use the dialog after it is created.</p>
526<table class="docutils field-list" frame="void" rules="none">
527<col class="field-name" />
528<col class="field-body" />
529<tbody valign="top">
530<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None (On Cancel) or a new <a class="reference internal" href="GSASIIobj.html#GSASIIobj.ExpressionObj" title="GSASIIobj.ExpressionObj"><tt class="xref py py-class docutils literal"><span class="pre">ExpressionObj</span></tt></a></td>
531</tr>
532</tbody>
533</table>
534</dd></dl>
535
536<dl class="attribute">
537<dt id="GSASIIexprGUI.ExpressionDialog.defSize">
538<tt class="descname">defSize</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.defSize" title="Permalink to this definition">¶</a></dt>
539<dd><p>Starting size for dialog</p>
540</dd></dl>
541
542<dl class="attribute">
543<dt id="GSASIIexprGUI.ExpressionDialog.depVarDict">
544<tt class="descname">depVarDict</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.depVarDict" title="Permalink to this definition">¶</a></dt>
545<dd><p>dict for dependent variables</p>
546</dd></dl>
547
548<dl class="attribute">
549<dt id="GSASIIexprGUI.ExpressionDialog.dependentVar">
550<tt class="descname">dependentVar</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.dependentVar" title="Permalink to this definition">¶</a></dt>
551<dd><p>name for dependent variable selection, when depVarDict is specified</p>
552</dd></dl>
553
554<dl class="attribute">
555<dt id="GSASIIexprGUI.ExpressionDialog.expr">
556<tt class="descname">expr</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.expr" title="Permalink to this definition">¶</a></dt>
557<dd><p>Expression as a text string</p>
558</dd></dl>
559
560<dl class="attribute">
561<dt id="GSASIIexprGUI.ExpressionDialog.exprVarLst">
562<tt class="descname">exprVarLst</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.exprVarLst" title="Permalink to this definition">¶</a></dt>
563<dd><p>A list containing the variables utilized in the current expression.
564Placed into a <a class="reference internal" href="GSASIIobj.html#GSASIIobj.ExpressionObj" title="GSASIIobj.ExpressionObj"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIobj.ExpressionObj</span></tt></a> object when the dialog is closed
565with &#8220;OK&#8221;, saving any changes.</p>
566</dd></dl>
567
568<dl class="attribute">
569<dt id="GSASIIexprGUI.ExpressionDialog.parmDict">
570<tt class="descname">parmDict</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.parmDict" title="Permalink to this definition">¶</a></dt>
571<dd><p>A copy of the G2 parameter dict (parmDict) except only numerical
572values are included and only the value (not the vary flag, if present)
573is included.</p>
574</dd></dl>
575
576<dl class="method">
577<dt id="GSASIIexprGUI.ExpressionDialog.setEvalResult">
578<tt class="descname">setEvalResult</tt><big>(</big><em>msg</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.setEvalResult"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.setEvalResult" title="Permalink to this definition">¶</a></dt>
579<dd><p>Show a string in the expression result area</p>
580</dd></dl>
581
582<dl class="method">
583<dt id="GSASIIexprGUI.ExpressionDialog.showError">
584<tt class="descname">showError</tt><big>(</big><em>msg1</em>, <em>msg2=''</em>, <em>msg3=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#ExpressionDialog.showError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.showError" title="Permalink to this definition">¶</a></dt>
585<dd><p>Show an error message of 1 to 3 sections. The second
586section is shown in an equally-spaced font.</p>
587<table class="docutils field-list" frame="void" rules="none">
588<col class="field-name" />
589<col class="field-body" />
590<tbody valign="top">
591<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
592<li><strong>msg1</strong> (<em>str</em>) &#8211; msg1 is shown in a the standard font</li>
593<li><strong>msg2</strong> (<em>str</em>) &#8211; msg2 is shown in a equally-spaced (wx.MODERN) font</li>
594<li><strong>msg3</strong> (<em>str</em>) &#8211; msg3 is shown in a the standard font</li>
595</ul>
596</td>
597</tr>
598</tbody>
599</table>
600</dd></dl>
601
602<dl class="attribute">
603<dt id="GSASIIexprGUI.ExpressionDialog.usedVars">
604<tt class="descname">usedVars</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.usedVars" title="Permalink to this definition">¶</a></dt>
605<dd><p>variable names that have been used and should not be reused by default</p>
606</dd></dl>
607
608<dl class="attribute">
609<dt id="GSASIIexprGUI.ExpressionDialog.varName">
610<tt class="descname">varName</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varName" title="Permalink to this definition">¶</a></dt>
611<dd><p>Name assigned to each variable</p>
612</dd></dl>
613
614<dl class="attribute">
615<dt id="GSASIIexprGUI.ExpressionDialog.varRefflag">
616<tt class="descname">varRefflag</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varRefflag" title="Permalink to this definition">¶</a></dt>
617<dd><p>Refinement flag for a variable (Free parameters only)</p>
618</dd></dl>
619
620<dl class="attribute">
621<dt id="GSASIIexprGUI.ExpressionDialog.varSelect">
622<tt class="descname">varSelect</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varSelect" title="Permalink to this definition">¶</a></dt>
623<dd><p>A dict that shows the variable type for each label
624found in the expression.</p>
625<ul class="simple">
626<li>If the value is None or is not defined, the value is not assigned.</li>
627<li>If the value is 0, then the varible is &#8220;free&#8221; &#8211; a new refineable
628parameter.</li>
629<li>Values above 1 determine what variables will be shown
630when the option is selected.</li>
631</ul>
632</dd></dl>
633
634<dl class="attribute">
635<dt id="GSASIIexprGUI.ExpressionDialog.varValue">
636<tt class="descname">varValue</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varValue" title="Permalink to this definition">¶</a></dt>
637<dd><p>Value for a variable (Free parameters only)</p>
638</dd></dl>
639
640</dd></dl>
641
642<dl class="function">
643<dt id="GSASIIexprGUI.IndexParmDict">
644<tt class="descclassname">GSASIIexprGUI.</tt><tt class="descname">IndexParmDict</tt><big>(</big><em>parmDict</em>, <em>wildcard</em><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#IndexParmDict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.IndexParmDict" title="Permalink to this definition">¶</a></dt>
645<dd><p>Separate the parameters in parmDict into list of keys by parameter
646type.</p>
647<table class="docutils field-list" frame="void" rules="none">
648<col class="field-name" />
649<col class="field-body" />
650<tbody valign="top">
651<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
652<li><strong>parmDict</strong> (<em>dict</em>) &#8211; a dict with GSAS-II parameters</li>
653<li><strong>wildcard</strong> (<em>bool</em>) &#8211; True if wildcard versions of parameters should
654be generated and added to the lists</li>
655</ul>
656</td>
657</tr>
658<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a dict of lists where key 1 is a list of phase parameters,
6592 is histogram/phase parms, 3 is histogram parms and 4 are global parameters</p>
660</td>
661</tr>
662</tbody>
663</table>
664</dd></dl>
665
666<dl class="function">
667<dt id="GSASIIexprGUI.LoadDefaultExpressions">
668<tt class="descclassname">GSASIIexprGUI.</tt><tt class="descname">LoadDefaultExpressions</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIexprGUI.html#LoadDefaultExpressions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIexprGUI.LoadDefaultExpressions" title="Permalink to this definition">¶</a></dt>
669<dd><p>Read a configuration file with default expressions from all files named
670DefaultExpressions.txt found in the path. Duplicates are removed and
671expressions are sorted alphabetically</p>
672</dd></dl>
673
674</div>
675</div>
676
677
678          </div>
679        </div>
680      </div>
681      <div class="sphinxsidebar">
682        <div class="sphinxsidebarwrapper">
683            <p class="logo"><a href="index.html">
684              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
685            </a></p>
686  <h3><a href="index.html">Table Of Contents</a></h3>
687  <ul>
688<li><a class="reference internal" href="#"><em>GSAS-II GUI Submodules</em></a><ul>
689<li><a class="reference internal" href="#gsasiiphsgui-phase-gui"><em>GSASIIphsGUI: Phase GUI</em></a></li>
690<li><a class="reference internal" href="#gsasiiddatagui-phase-diffraction-data-gui"><em>GSASIIddataGUI: Phase Diffraction Data GUI</em></a></li>
691<li><a class="reference internal" href="#gsasiielemgui-gui-to-select-and-delete-element-lists"><em>GSASIIElemGUI: GUI to select and delete element lists</em></a></li>
692<li><a class="reference internal" href="#gsasiiconstrgui-constraint-gui-routines"><em>GSASIIconstrGUI: Constraint GUI routines</em></a></li>
693<li><a class="reference internal" href="#gsasiiimggui-image-gui"><em>GSASIIimgGUI: Image GUI</em></a></li>
694<li><a class="reference internal" href="#gsasiipwdgui-powder-pattern-gui-routines"><em>GSASIIpwdGUI: Powder Pattern GUI routines</em></a></li>
695<li><a class="reference internal" href="#gsasiirestrgui-restraint-gui-routines"><em>GSASIIrestrGUI: Restraint GUI routines</em></a></li>
696<li><a class="reference internal" href="#gsasiiexprgui-expression-handling"><em>GSASIIexprGUI: Expression Handling</em></a></li>
697</ul>
698</li>
699</ul>
700
701  <h4>Previous topic</h4>
702  <p class="topless"><a href="GSASIIGUIr.html"
703                        title="previous chapter"><em>GSAS-II GUI Routines</em></a></p>
704  <h4>Next topic</h4>
705  <p class="topless"><a href="GSASIIstruc.html"
706                        title="next chapter"><em>GSAS-II Structure  Submodules</em></a></p>
707  <h3>This Page</h3>
708  <ul class="this-page-menu">
709    <li><a href="_sources/GSASIIGUI.txt"
710           rel="nofollow">Show Source</a></li>
711  </ul>
712<div id="searchbox" style="display: none">
713  <h3>Quick search</h3>
714    <form class="search" action="search.html" method="get">
715      <input type="text" name="q" />
716      <input type="submit" value="Go" />
717      <input type="hidden" name="check_keywords" value="yes" />
718      <input type="hidden" name="area" value="default" />
719    </form>
720    <p class="searchtip" style="font-size: 90%">
721    Enter search terms or a module, class or function name.
722    </p>
723</div>
724<script type="text/javascript">$('#searchbox').show(0);</script>
725        </div>
726      </div>
727      <div class="clearer"></div>
728    </div>
729    <div class="related">
730      <h3>Navigation</h3>
731      <ul>
732        <li class="right" style="margin-right: 10px">
733          <a href="genindex.html" title="General Index"
734             >index</a></li>
735        <li class="right" >
736          <a href="py-modindex.html" title="Python Module Index"
737             >modules</a> |</li>
738        <li class="right" >
739          <a href="GSASIIstruc.html" title="GSAS-II Structure Submodules"
740             >next</a> |</li>
741        <li class="right" >
742          <a href="GSASIIGUIr.html" title="GSAS-II GUI Routines"
743             >previous</a> |</li>
744        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
745      </ul>
746    </div>
747    <div class="footer">
748        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
749      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
750    </div>
751  </body>
752</html>
Note: See TracBrowser for help on using the repository browser.