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

Last change on this file since 1708 was 1513, checked in by toby, 11 years ago

update and rebuild docs
  • Property svn:mime-type set to text/html
File size: 49.4 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><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.UpdateImageControls">
192<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>
193<dd><p>Shows and handles the controls on the &#8220;Image Controls&#8221;
194data tree entry</p>
195</dd></dl>
196
197<dl class="function">
198<dt id="GSASIIimgGUI.UpdateMasks">
199<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>
200<dd><p>Shows and handles the controls on the &#8220;Masks&#8221;
201data tree entry</p>
202</dd></dl>
203
204<dl class="function">
205<dt id="GSASIIimgGUI.UpdateStressStrain">
206<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>
207<dd><p>Shows and handles the controls on the &#8220;Stress/Strain&#8221;
208data tree entry</p>
209</dd></dl>
210
211</div>
212<span class="target" id="module-GSASIIpwdGUI"></span><div class="section" id="gsasiipwdgui-powder-pattern-gui-routines">
213<h2><em>GSASIIpwdGUI: Powder Pattern GUI routines</em><a class="headerlink" href="#gsasiipwdgui-powder-pattern-gui-routines" title="Permalink to this headline">¶</a></h2>
214<p>Used to define GUI controls for the routines that interact
215with the powder histogram (PWDR) data tree items.</p>
216<dl class="function">
217<dt id="GSASIIpwdGUI.CopySelectedHistItems">
218<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>
219<dd><p>Global copy: Copy items from current histogram to others.
220This is called from the menubar and is available only when the top histogram tree entry
221is selected.</p>
222</dd></dl>
223
224<dl class="function">
225<dt id="GSASIIpwdGUI.GetHistsLikeSelected">
226<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>
227<dd><p>Get the histograms that match the current selected one:
228The histogram prefix and data type (PXC etc.), the number of
229wavelengths and the instrument geometry (Debye-Scherrer etc.)
230must all match. The current histogram is not included in the list.</p>
231<table class="docutils field-list" frame="void" rules="none">
232<col class="field-name" />
233<col class="field-body" />
234<tbody valign="top">
235<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>
236</tr>
237</tbody>
238</table>
239</dd></dl>
240
241<dl class="function">
242<dt id="GSASIIpwdGUI.IsHistogramInAnyPhase">
243<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>
244<dd><p>Needs a doc string</p>
245</dd></dl>
246
247<dl class="function">
248<dt id="GSASIIpwdGUI.SetCopyNames">
249<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>
250<dd><p>Determine the items in the sample parameters that should be copied,
251depending on the histogram type and the instrument type.</p>
252</dd></dl>
253
254<dl class="function">
255<dt id="GSASIIpwdGUI.SetDefaultSASDModel">
256<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>
257<dd><p>Fills in default items for the SASD Models dictionary</p>
258</dd></dl>
259
260<dl class="function">
261<dt id="GSASIIpwdGUI.SetDefaultSample">
262<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>
263<dd><p>Fills in default items for the Sample dictionary</p>
264</dd></dl>
265
266<dl class="function">
267<dt id="GSASIIpwdGUI.SetDefaultSubstances">
268<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>
269<dd><p>Fills in default items for the SASD Substances dictionary</p>
270</dd></dl>
271
272<dl class="function">
273<dt id="GSASIIpwdGUI.SetupSampleLabels">
274<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>
275<dd><p>Setup a list of labels and number formatting for use in
276labeling sample parameters.
277:param str histName: Name of histogram, (&#8220;PWDR ...&#8221;)
278:param str dataType:</p>
279</dd></dl>
280
281<dl class="function">
282<dt id="GSASIIpwdGUI.UpdateBackground">
283<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>
284<dd><p>respond to selection of PWDR background data tree item.</p>
285</dd></dl>
286
287<dl class="function">
288<dt id="GSASIIpwdGUI.UpdateIndexPeaksGrid">
289<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>
290<dd><p>respond to selection of PWDR Index Peak List data
291tree item.</p>
292</dd></dl>
293
294<dl class="function">
295<dt id="GSASIIpwdGUI.UpdateInstrumentGrid">
296<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>
297<dd><p>respond to selection of PWDR/SASD Instrument Parameters
298data tree item.</p>
299</dd></dl>
300
301<dl class="function">
302<dt id="GSASIIpwdGUI.UpdateLimitsGrid">
303<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>
304<dd><p>respond to selection of PWDR Limits data tree item.</p>
305</dd></dl>
306
307<dl class="function">
308<dt id="GSASIIpwdGUI.UpdateModelsGrid">
309<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>
310<dd><p>respond to selection of SASD Models data tree item.</p>
311</dd></dl>
312
313<dl class="function">
314<dt id="GSASIIpwdGUI.UpdatePDFGrid">
315<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>
316<dd><p>respond to selection of PWDR PDF data tree item.</p>
317</dd></dl>
318
319<dl class="function">
320<dt id="GSASIIpwdGUI.UpdatePeakGrid">
321<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>
322<dd><p>respond to selection of PWDR powder peaks data tree item.</p>
323</dd></dl>
324
325<dl class="function">
326<dt id="GSASIIpwdGUI.UpdateReflectionGrid">
327<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>
328<dd><p>respond to selection of PWDR Reflections data tree item.</p>
329</dd></dl>
330
331<dl class="function">
332<dt id="GSASIIpwdGUI.UpdateSampleGrid">
333<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>
334<dd><p>respond to selection of PWDR/SASD Sample Parameters
335data tree item.</p>
336</dd></dl>
337
338<dl class="function">
339<dt id="GSASIIpwdGUI.UpdateSubstanceGrid">
340<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>
341<dd><p>respond to selection of SASD Substance data tree item.</p>
342</dd></dl>
343
344<dl class="function">
345<dt id="GSASIIpwdGUI.UpdateUnitCellsGrid">
346<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>
347<dd><p>respond to selection of PWDR Unit Cells data tree item.</p>
348</dd></dl>
349
350</div>
351<span class="target" id="module-GSASIIrestrGUI"></span><div class="section" id="gsasiirestrgui-restraint-gui-routines">
352<h2><em>GSASIIrestrGUI: Restraint GUI routines</em><a class="headerlink" href="#gsasiirestrgui-restraint-gui-routines" title="Permalink to this headline">¶</a></h2>
353<p>Used to define restraints.</p>
354<dl class="function">
355<dt id="GSASIIrestrGUI.UpdateRestraints">
356<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>
357<dd><p>Respond to selection of the Restraints item on the
358data tree</p>
359</dd></dl>
360
361</div>
362<span class="target" id="module-GSASIIexprGUI"></span><div class="section" id="gsasiiexprgui-expression-handling">
363<h2><em>GSASIIexprGUI: Expression Handling</em><a class="headerlink" href="#gsasiiexprgui-expression-handling" title="Permalink to this headline">¶</a></h2>
364<p>This module defines a class for defining an expression in terms of values
365in 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>
366which is used to evaluate the expression against a supplied parameter dictionary.</p>
367<p>The expression is parsed to find variables used in the expression and then
368the user is asked to assign parameters from the dictionary to each variable.</p>
369<p>Default expressions are read from file DefaultExpressions.txt using
370<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>
371<dl class="class">
372<dt id="GSASIIexprGUI.ExpressionDialog">
373<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>
374<dd><p>A wx.Dialog that allows a user to input an arbitrary expression
375to be evaluated and possibly minimized.</p>
376<p>To do this, the user assigns a new (free) or existing
377GSAS-II parameter to each parameter label used in the expression.
378The free parameters can optionally be designated to be refined.
379For example, is an expression is used such as:</p>
380<div class="highlight-python"><div class="highlight"><pre><span class="s">&#39;A*np.exp(-B/C)&#39;</span>
381</pre></div>
382</div>
383<p>then A, B and C can each be assigned as Free parameter with a user-selected
384value or to any existing GSAS-II variable in the parameter dictionary.
385As the expression is entered it is checked for validity.</p>
386<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
387run 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
388input.</p>
389<table class="docutils field-list" frame="void" rules="none">
390<col class="field-name" />
391<col class="field-body" />
392<tbody valign="top">
393<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
394<li><strong>parent</strong> (<em>wx.Frame</em>) &#8211; The parent of the Dialog. Can be None,
395but better is to provide the name of the Frame where the dialog
396is called.</li>
397<li><strong>parmDict</strong> (<em>dict</em>) &#8211; a dict with defined parameters and their values. Each value
398may be a list with parameter values and a refine flag or may just contain
399the parameter value (non-float/int values in dict are ignored)</li>
400<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
401label assignments or None (default)</li>
402<li><strong>wintitle</strong> (<em>str</em>) &#8211; String placed on title bar of dialog;
403defaults to &#8220;Expression Editor&#8221;</li>
404<li><strong>header</strong> (<em>str</em>) &#8211; String placed at top of dialog to tell the user
405what they will do here; default is &#8220;Enter restraint expression here&#8221;</li>
406<li><strong>fit</strong> (<em>bool</em>) &#8211; determines if the expression will be used in fitting (default=True).
407If set to False, and refinement flags are not shown
408and Free parameters are not offered as an assignment option.</li>
409<li><strong>VarLabel</strong> (<em>str</em>) &#8211; an optional variable label to include before the expression
410input. Ignored if None (default)</li>
411<li><strong>depVarDict</strong> (<em>list</em>) &#8211; a dict of choices for the dependent variable to be
412fitted to the expression and their values. Ignored if None (default).</li>
413<li><strong>ExtraButton</strong> (<em>list</em>) &#8211; a list with two terms that define [0]: the label
414for an extra button and [1] the callback routine to be used when the
415button is pressed. The button will only be enabled when the OK button can be
416used (meaning the equation/expression is valid). The default is None, meaning this
417will not be used.</li>
418<li><strong>usedVars</strong> (<em>list</em>) &#8211; defines a list of previously used variable names. These names
419will not be reused as defaults for new free variables.
420(The default is an empty list).</li>
421</ul>
422</td>
423</tr>
424</tbody>
425</table>
426<dl class="method">
427<dt id="GSASIIexprGUI.ExpressionDialog.CheckVars">
428<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>
429<dd><p>Check that appropriate variables are defined for each
430symbol used in <tt class="xref py py-data docutils literal"><span class="pre">self.expr</span></tt></p>
431<table class="docutils field-list" frame="void" rules="none">
432<col class="field-name" />
433<col class="field-body" />
434<tbody valign="top">
435<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>
436</tr>
437</tbody>
438</table>
439</dd></dl>
440
441<dl class="method">
442<dt id="GSASIIexprGUI.ExpressionDialog.GetDepVar">
443<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>
444<dd><p>Returns the name of the dependent variable, when depVarDict is used.</p>
445</dd></dl>
446
447<dl class="method">
448<dt id="GSASIIexprGUI.ExpressionDialog.OnChar">
449<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>
450<dd><p>Called as each character is entered. Cancels any running timer
451and starts a new one. The timer causes a check of syntax after 2 seconds
452without input.
453Disables the OK button until a validity check is complete.</p>
454</dd></dl>
455
456<dl class="method">
457<dt id="GSASIIexprGUI.ExpressionDialog.OnChoice">
458<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>
459<dd><p>Respond to a selection of a variable type for a label in
460an expression</p>
461</dd></dl>
462
463<dl class="method">
464<dt id="GSASIIexprGUI.ExpressionDialog.OnDepChoice">
465<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>
466<dd><p>Respond to a selection of a variable type for a label in
467an expression</p>
468</dd></dl>
469
470<dl class="method">
471<dt id="GSASIIexprGUI.ExpressionDialog.OnValidate">
472<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>
473<dd><p>Respond to a press of the Validate button or when a variable
474is 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>
475</dd></dl>
476
477<dl class="method">
478<dt id="GSASIIexprGUI.ExpressionDialog.Repaint">
479<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>
480<dd><p>Redisplay the variables and continue the validation</p>
481</dd></dl>
482
483<dl class="method">
484<dt id="GSASIIexprGUI.ExpressionDialog.RestartTimer">
485<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>
486<dd><p>Cancels any running timer and starts a new one.
487The timer causes a check of syntax after 2 seconds unless there is further input.
488Disables the OK button until a validity check is complete.</p>
489</dd></dl>
490
491<dl class="method">
492<dt id="GSASIIexprGUI.ExpressionDialog.SelectG2var">
493<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>
494<dd><p>Offer a selection of a GSAS-II variable.</p>
495<table class="docutils field-list" frame="void" rules="none">
496<col class="field-name" />
497<col class="field-body" />
498<tbody valign="top">
499<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.
500where 1 is used for Phase variables, and 2 for Histogram/Phase vars,
5013 for Histogram vars and 4 for Global vars.</td>
502</tr>
503<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>
504</tr>
505</tbody>
506</table>
507</dd></dl>
508
509<dl class="method">
510<dt id="GSASIIexprGUI.ExpressionDialog.Show">
511<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>
512<dd><p>Call to use the dialog after it is created.</p>
513<table class="docutils field-list" frame="void" rules="none">
514<col class="field-name" />
515<col class="field-body" />
516<tbody valign="top">
517<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>
518</tr>
519</tbody>
520</table>
521</dd></dl>
522
523<dl class="attribute">
524<dt id="GSASIIexprGUI.ExpressionDialog.defSize">
525<tt class="descname">defSize</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.defSize" title="Permalink to this definition">¶</a></dt>
526<dd><p>Starting size for dialog</p>
527</dd></dl>
528
529<dl class="attribute">
530<dt id="GSASIIexprGUI.ExpressionDialog.depVarDict">
531<tt class="descname">depVarDict</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.depVarDict" title="Permalink to this definition">¶</a></dt>
532<dd><p>dict for dependent variables</p>
533</dd></dl>
534
535<dl class="attribute">
536<dt id="GSASIIexprGUI.ExpressionDialog.dependentVar">
537<tt class="descname">dependentVar</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.dependentVar" title="Permalink to this definition">¶</a></dt>
538<dd><p>name for dependent variable selection, when depVarDict is specified</p>
539</dd></dl>
540
541<dl class="attribute">
542<dt id="GSASIIexprGUI.ExpressionDialog.expr">
543<tt class="descname">expr</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.expr" title="Permalink to this definition">¶</a></dt>
544<dd><p>Expression as a text string</p>
545</dd></dl>
546
547<dl class="attribute">
548<dt id="GSASIIexprGUI.ExpressionDialog.exprVarLst">
549<tt class="descname">exprVarLst</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.exprVarLst" title="Permalink to this definition">¶</a></dt>
550<dd><p>A list containing the variables utilized in the current expression.
551Placed 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
552with &#8220;OK&#8221;, saving any changes.</p>
553</dd></dl>
554
555<dl class="attribute">
556<dt id="GSASIIexprGUI.ExpressionDialog.parmDict">
557<tt class="descname">parmDict</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.parmDict" title="Permalink to this definition">¶</a></dt>
558<dd><p>A copy of the G2 parameter dict (parmDict) except only numerical
559values are included and only the value (not the vary flag, if present)
560is included.</p>
561</dd></dl>
562
563<dl class="method">
564<dt id="GSASIIexprGUI.ExpressionDialog.setEvalResult">
565<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>
566<dd><p>Show a string in the expression result area</p>
567</dd></dl>
568
569<dl class="method">
570<dt id="GSASIIexprGUI.ExpressionDialog.showError">
571<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>
572<dd><p>Show an error message of 1 to 3 sections. The second
573section is shown in an equally-spaced font.</p>
574<table class="docutils field-list" frame="void" rules="none">
575<col class="field-name" />
576<col class="field-body" />
577<tbody valign="top">
578<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
579<li><strong>msg1</strong> (<em>str</em>) &#8211; msg1 is shown in a the standard font</li>
580<li><strong>msg2</strong> (<em>str</em>) &#8211; msg2 is shown in a equally-spaced (wx.MODERN) font</li>
581<li><strong>msg3</strong> (<em>str</em>) &#8211; msg3 is shown in a the standard font</li>
582</ul>
583</td>
584</tr>
585</tbody>
586</table>
587</dd></dl>
588
589<dl class="attribute">
590<dt id="GSASIIexprGUI.ExpressionDialog.usedVars">
591<tt class="descname">usedVars</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.usedVars" title="Permalink to this definition">¶</a></dt>
592<dd><p>variable names that have been used and should not be reused by default</p>
593</dd></dl>
594
595<dl class="attribute">
596<dt id="GSASIIexprGUI.ExpressionDialog.varName">
597<tt class="descname">varName</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varName" title="Permalink to this definition">¶</a></dt>
598<dd><p>Name assigned to each variable</p>
599</dd></dl>
600
601<dl class="attribute">
602<dt id="GSASIIexprGUI.ExpressionDialog.varRefflag">
603<tt class="descname">varRefflag</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varRefflag" title="Permalink to this definition">¶</a></dt>
604<dd><p>Refinement flag for a variable (Free parameters only)</p>
605</dd></dl>
606
607<dl class="attribute">
608<dt id="GSASIIexprGUI.ExpressionDialog.varSelect">
609<tt class="descname">varSelect</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varSelect" title="Permalink to this definition">¶</a></dt>
610<dd><p>A dict that shows the variable type for each label
611found in the expression.</p>
612<ul class="simple">
613<li>If the value is None or is not defined, the value is not assigned.</li>
614<li>If the value is 0, then the varible is &#8220;free&#8221; &#8211; a new refineable
615parameter.</li>
616<li>Values above 1 determine what variables will be shown
617when the option is selected.</li>
618</ul>
619</dd></dl>
620
621<dl class="attribute">
622<dt id="GSASIIexprGUI.ExpressionDialog.varValue">
623<tt class="descname">varValue</tt><em class="property"> = None</em><a class="headerlink" href="#GSASIIexprGUI.ExpressionDialog.varValue" title="Permalink to this definition">¶</a></dt>
624<dd><p>Value for a variable (Free parameters only)</p>
625</dd></dl>
626
627</dd></dl>
628
629<dl class="function">
630<dt id="GSASIIexprGUI.IndexParmDict">
631<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>
632<dd><p>Separate the parameters in parmDict into list of keys by parameter
633type.</p>
634<table class="docutils field-list" frame="void" rules="none">
635<col class="field-name" />
636<col class="field-body" />
637<tbody valign="top">
638<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
639<li><strong>parmDict</strong> (<em>dict</em>) &#8211; a dict with GSAS-II parameters</li>
640<li><strong>wildcard</strong> (<em>bool</em>) &#8211; True if wildcard versions of parameters should
641be generated and added to the lists</li>
642</ul>
643</td>
644</tr>
645<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,
6462 is histogram/phase parms, 3 is histogram parms and 4 are global parameters</p>
647</td>
648</tr>
649</tbody>
650</table>
651</dd></dl>
652
653<dl class="function">
654<dt id="GSASIIexprGUI.LoadDefaultExpressions">
655<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>
656<dd><p>Read a configuration file with default expressions from all files named
657DefaultExpressions.txt found in the path. Duplicates are removed and
658expressions are sorted alphabetically</p>
659</dd></dl>
660
661</div>
662</div>
663
664
665          </div>
666        </div>
667      </div>
668      <div class="sphinxsidebar">
669        <div class="sphinxsidebarwrapper">
670            <p class="logo"><a href="index.html">
671              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
672            </a></p>
673  <h3><a href="index.html">Table Of Contents</a></h3>
674  <ul>
675<li><a class="reference internal" href="#"><em>GSAS-II GUI Submodules</em></a><ul>
676<li><a class="reference internal" href="#gsasiiphsgui-phase-gui"><em>GSASIIphsGUI: Phase GUI</em></a></li>
677<li><a class="reference internal" href="#gsasiiddatagui-phase-diffraction-data-gui"><em>GSASIIddataGUI: Phase Diffraction Data GUI</em></a></li>
678<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>
679<li><a class="reference internal" href="#gsasiiconstrgui-constraint-gui-routines"><em>GSASIIconstrGUI: Constraint GUI routines</em></a></li>
680<li><a class="reference internal" href="#gsasiiimggui-image-gui"><em>GSASIIimgGUI: Image GUI</em></a></li>
681<li><a class="reference internal" href="#gsasiipwdgui-powder-pattern-gui-routines"><em>GSASIIpwdGUI: Powder Pattern GUI routines</em></a></li>
682<li><a class="reference internal" href="#gsasiirestrgui-restraint-gui-routines"><em>GSASIIrestrGUI: Restraint GUI routines</em></a></li>
683<li><a class="reference internal" href="#gsasiiexprgui-expression-handling"><em>GSASIIexprGUI: Expression Handling</em></a></li>
684</ul>
685</li>
686</ul>
687
688  <h4>Previous topic</h4>
689  <p class="topless"><a href="GSASIIGUIr.html"
690                        title="previous chapter"><em>GSAS-II GUI Routines</em></a></p>
691  <h4>Next topic</h4>
692  <p class="topless"><a href="GSASIIstruc.html"
693                        title="next chapter"><em>GSAS-II Structure  Submodules</em></a></p>
694  <h3>This Page</h3>
695  <ul class="this-page-menu">
696    <li><a href="_sources/GSASIIGUI.txt"
697           rel="nofollow">Show Source</a></li>
698  </ul>
699<div id="searchbox" style="display: none">
700  <h3>Quick search</h3>
701    <form class="search" action="search.html" method="get">
702      <input type="text" name="q" />
703      <input type="submit" value="Go" />
704      <input type="hidden" name="check_keywords" value="yes" />
705      <input type="hidden" name="area" value="default" />
706    </form>
707    <p class="searchtip" style="font-size: 90%">
708    Enter search terms or a module, class or function name.
709    </p>
710</div>
711<script type="text/javascript">$('#searchbox').show(0);</script>
712        </div>
713      </div>
714      <div class="clearer"></div>
715    </div>
716    <div class="related">
717      <h3>Navigation</h3>
718      <ul>
719        <li class="right" style="margin-right: 10px">
720          <a href="genindex.html" title="General Index"
721             >index</a></li>
722        <li class="right" >
723          <a href="py-modindex.html" title="Python Module Index"
724             >modules</a> |</li>
725        <li class="right" >
726          <a href="GSASIIstruc.html" title="GSAS-II Structure Submodules"
727             >next</a> |</li>
728        <li class="right" >
729          <a href="GSASIIGUIr.html" title="GSAS-II GUI Routines"
730             >previous</a> |</li>
731        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
732      </ul>
733    </div>
734    <div class="footer">
735        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
736      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
737    </div>
738  </body>
739</html>
Note: See TracBrowser for help on using the repository browser.