source: sphinxdocs/build/html/GSASII.html @ 2010

Last change on this file since 2010 was 2010, checked in by toby, 7 years ago

update docs

  • Property svn:mime-type set to text/html
File size: 48.0 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 Main Module &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="GSASIIobj: Data objects" href="GSASIIobj.html" />
29    <link rel="prev" title="GSAS-II Developer’s Documentation" href="index.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="GSASIIobj.html" title="GSASIIobj: Data objects"
43             accesskey="N">next</a> |</li>
44        <li class="right" >
45          <a href="index.html" title="GSAS-II Developer’s Documentation"
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  <span class="target" id="module-GSASII"></span><div class="section" id="gsas-ii-main-module">
57<h1><em>GSAS-II Main Module</em><a class="headerlink" href="#gsas-ii-main-module" title="Permalink to this headline">¶</a></h1>
58<p>Main routines for the GSAS-II program</p>
59<dl class="class">
60<dt id="GSASII.GSASII">
61<em class="property">class </em><tt class="descclassname">GSASII.</tt><tt class="descname">GSASII</tt><big>(</big><em>parent</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII" title="Permalink to this definition">¶</a></dt>
62<dd><p>Define the main GSAS-II frame and its associated menu items</p>
63<dl class="method">
64<dt id="GSASII.GSASII.Bind">
65<tt class="descname">Bind</tt><big>(</big><em>eventtype</em>, <em>handler</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.Bind" title="Permalink to this definition">¶</a></dt>
66<dd><p>Override the Bind function so that we can wrap calls that will be logged.</p>
67<p>N.B. This is a bit kludgy. Menu bindings with an id are wrapped and
68menu bindings with an object and no id are not.</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="GSASII.GSASII.CheckNotebook">
73<tt class="descname">CheckNotebook</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.CheckNotebook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.CheckNotebook" title="Permalink to this definition">¶</a></dt>
74<dd><p>Make sure the data tree has the minimally expected controls.</p>
75</dd></dl>
76
77<dl class="class">
78<dt id="GSASII.GSASII.CopyDialog">
79<em class="property">class </em><tt class="descname">CopyDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>text</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.CopyDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.CopyDialog" title="Permalink to this definition">¶</a></dt>
80<dd><p>Creates a dialog for copying control settings between
81data tree items</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="GSASII.GSASII.EnableSeqRefineMenu">
86<tt class="descclassname">GSASII.</tt><tt class="descname">EnableSeqRefineMenu</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.EnableSeqRefineMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.EnableSeqRefineMenu" title="Permalink to this definition">¶</a></dt>
87<dd><p>Enable or disable the sequential refinement menu items based on the
88contents of the Controls &#8216;Seq Data&#8217; item (if present)</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="GSASII.GSASII.ErrorDialog">
93<tt class="descclassname">GSASII.</tt><tt class="descname">ErrorDialog</tt><big>(</big><em>title</em>, <em>message</em>, <em>parent=None</em>, <em>wtype=4</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.ErrorDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.ErrorDialog" title="Permalink to this definition">¶</a></dt>
94<dd><p>Display an error message</p>
95</dd></dl>
96
97<dl class="method">
98<dt id="GSASII.GSASII.ExitMain">
99<tt class="descclassname">GSASII.</tt><tt class="descname">ExitMain</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.ExitMain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.ExitMain" title="Permalink to this definition">¶</a></dt>
100<dd><p>Called if the main window is closed</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="GSASII.GSASII.FillMainMenu">
105<tt class="descclassname">GSASII.</tt><tt class="descname">FillMainMenu</tt><big>(</big><em>menubar</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.FillMainMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.FillMainMenu" title="Permalink to this definition">¶</a></dt>
106<dd><p>Define contents of the main GSAS-II menu for the (main) data tree window.
107For the mac, this is also called for the data item windows as well so that
108the main menu items are data menu as well.</p>
109</dd></dl>
110
111<dl class="method">
112<dt id="GSASII.GSASII.GetFileList">
113<tt class="descclassname">GSASII.</tt><tt class="descname">GetFileList</tt><big>(</big><em>fileType</em>, <em>skip=None</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetFileList"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetFileList" title="Permalink to this definition">¶</a></dt>
114<dd><p>Appears unused. Note routine of same name in GSASIIpwdGUI</p>
115</dd></dl>
116
117<dl class="method">
118<dt id="GSASII.GSASII.GetHKLFdatafromTree">
119<tt class="descclassname">GSASII.</tt><tt class="descname">GetHKLFdatafromTree</tt><big>(</big><em>HKLFname</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetHKLFdatafromTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetHKLFdatafromTree" title="Permalink to this definition">¶</a></dt>
120<dd><p>Returns single crystal data from GSASII tree</p>
121<table class="docutils field-list" frame="void" rules="none">
122<col class="field-name" />
123<col class="field-body" />
124<tbody valign="top">
125<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>HKLFname</strong> (<em>str</em>) &#8211; a single crystal histogram name as obtained
126from
127<tt class="xref py py-meth docutils literal"><span class="pre">GSASIIstruct.GetHistogramNames()</span></tt></td>
128</tr>
129<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">HKLFdata = single crystal data list of reflections</td>
130</tr>
131</tbody>
132</table>
133</dd></dl>
134
135<dl class="method">
136<dt id="GSASII.GSASII.GetHistogramNames">
137<tt class="descclassname">GSASII.</tt><tt class="descname">GetHistogramNames</tt><big>(</big><em>hType</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetHistogramNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetHistogramNames" title="Permalink to this definition">¶</a></dt>
138<dd><p>Returns a list of histogram names found in the GSASII data tree
139Note routine <a class="reference internal" href="GSASIIstruc.html#GSASIIstrIO.GetHistogramNames" title="GSASIIstrIO.GetHistogramNames"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrIO.GetHistogramNames()</span></tt></a> also exists to
140get same info from GPX file.</p>
141<table class="docutils field-list" frame="void" rules="none">
142<col class="field-name" />
143<col class="field-body" />
144<tbody valign="top">
145<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hType</strong> (<em>str</em>) &#8211; list of histogram types</td>
146</tr>
147<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of histogram names</td>
148</tr>
149</tbody>
150</table>
151</dd></dl>
152
153<dl class="method">
154<dt id="GSASII.GSASII.GetImportFile">
155<tt class="descclassname">GSASII.</tt><tt class="descname">GetImportFile</tt><big>(</big><em>message</em>, <em>defaultDir=''</em>, <em>defaultFile=''</em>, <em>style=1</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetImportFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetImportFile" title="Permalink to this definition">¶</a></dt>
156<dd><p>Defines a customized dialog that gets gets files from the appropriate
157Import directory (unless overridden with defaultDir). The default
158import directory is found in self.ImportDir, which will be set to
159the location of the (first) file entered in this dialog.</p>
160<table class="docutils field-list" frame="void" rules="none">
161<col class="field-name" />
162<col class="field-body" />
163<tbody valign="top">
164<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a list of files or an empty list</td>
165</tr>
166</tbody>
167</table>
168</dd></dl>
169
170<dl class="method">
171<dt id="GSASII.GSASII.GetPWDRdatafromTree">
172<tt class="descclassname">GSASII.</tt><tt class="descname">GetPWDRdatafromTree</tt><big>(</big><em>PWDRname</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetPWDRdatafromTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetPWDRdatafromTree" title="Permalink to this definition">¶</a></dt>
173<dd><p>Returns powder data from GSASII tree</p>
174<table class="docutils field-list" frame="void" rules="none">
175<col class="field-name" />
176<col class="field-body" />
177<tbody valign="top">
178<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>PWDRname</strong> (<em>str</em>) &#8211; a powder histogram name as obtained from
179<tt class="xref py py-meth docutils literal"><span class="pre">GSASIIstruct.GetHistogramNames()</span></tt></td>
180</tr>
181<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">PWDRdata = powder data dictionary with
182Powder data arrays, Limits, Instrument Parameters,
183Sample Parameters</td>
184</tr>
185</tbody>
186</table>
187</dd></dl>
188
189<dl class="method">
190<dt id="GSASII.GSASII.GetPhaseData">
191<tt class="descclassname">GSASII.</tt><tt class="descname">GetPhaseData</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetPhaseData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetPhaseData" title="Permalink to this definition">¶</a></dt>
192<dd><p>Returns a dict with defined phases.
193Note routine <a class="reference internal" href="GSASIIstruc.html#GSASIIstrIO.GetPhaseData" title="GSASIIstrIO.GetPhaseData"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrIO.GetPhaseData()</span></tt></a> also exists to
194get same info from GPX file.</p>
195</dd></dl>
196
197<dl class="method">
198<dt id="GSASII.GSASII.GetPhaseInfofromTree">
199<tt class="descclassname">GSASII.</tt><tt class="descname">GetPhaseInfofromTree</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetPhaseInfofromTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetPhaseInfofromTree" title="Permalink to this definition">¶</a></dt>
200<dd><p>Get the phase names and their rId values,
201also the histograms used in each phase.</p>
202<table class="docutils field-list" frame="void" rules="none">
203<col class="field-name" />
204<col class="field-body" />
205<tbody valign="top">
206<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(phaseRIdList, usedHistograms) where<ul class="simple">
207<li>phaseRIdList is a list of random Id values for each phase</li>
208<li>usedHistograms is a dict where the keys are the phase names
209and the values for each key are a list of the histogram names
210used in each phase.</li>
211</ul>
212</td>
213</tr>
214</tbody>
215</table>
216</dd></dl>
217
218<dl class="method">
219<dt id="GSASII.GSASII.GetPhaseNames">
220<tt class="descclassname">GSASII.</tt><tt class="descname">GetPhaseNames</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetPhaseNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetPhaseNames" title="Permalink to this definition">¶</a></dt>
221<dd><p>Returns a list of defined phases.
222Note routine <a class="reference internal" href="GSASIIstruc.html#GSASIIstrIO.GetPhaseNames" title="GSASIIstrIO.GetPhaseNames"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrIO.GetPhaseNames()</span></tt></a> also exists to
223get same info from GPX file.</p>
224</dd></dl>
225
226<dl class="method">
227<dt id="GSASII.GSASII.GetPowderIparm">
228<tt class="descclassname">GSASII.</tt><tt class="descname">GetPowderIparm</tt><big>(</big><em>rd</em>, <em>prevIparm</em>, <em>lastIparmfile</em>, <em>lastdatafile</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetPowderIparm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetPowderIparm" title="Permalink to this definition">¶</a></dt>
229<dd><p>Open and read an instrument parameter file for a data file
230Returns the list of parameters used in the data tree</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"><ul class="first simple">
236<li><strong>rd</strong> (<em>obj</em>) &#8211; the raw data (histogram) data object.</li>
237<li><strong>prevIparm</strong> (<em>str</em>) &#8211; not used</li>
238<li><strong>lastIparmfile</strong> (<em>str</em>) &#8211; Name of last instrument parameter
239file that was read, or a empty string.</li>
240<li><strong>lastdatafile</strong> (<em>str</em>) &#8211; Name of last data file that was read.</li>
241</ul>
242</td>
243</tr>
244<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list of two dicts, the first containing instrument parameters
245and the second used for TOf lookup tables for profile coeff.</p>
246</td>
247</tr>
248</tbody>
249</table>
250</dd></dl>
251
252<dl class="method">
253<dt id="GSASII.GSASII.GetUsedHistogramsAndPhasesfromTree">
254<tt class="descclassname">GSASII.</tt><tt class="descname">GetUsedHistogramsAndPhasesfromTree</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.GetUsedHistogramsAndPhasesfromTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.GetUsedHistogramsAndPhasesfromTree" title="Permalink to this definition">¶</a></dt>
255<dd><p>Returns all histograms that are found in any phase
256and any phase that uses a histogram.
257This also assigns numbers to used phases and histograms by the
258order they appear in the file.
259Note routine <tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrIO.GetUsedHistogramsAndPhasesfromTree()</span></tt> also exists to
260get same info from GPX file.</p>
261<table class="docutils field-list" frame="void" rules="none">
262<col class="field-name" />
263<col class="field-body" />
264<tbody valign="top">
265<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(Histograms,Phases)<ul class="simple">
266<li>Histograms = dictionary of histograms as {name:data,...}</li>
267<li>Phases = dictionary of phases that use histograms</li>
268</ul>
269</td>
270</tr>
271</tbody>
272</table>
273</dd></dl>
274
275<dl class="method">
276<dt id="GSASII.GSASII.MakeLSParmDict">
277<tt class="descclassname">GSASII.</tt><tt class="descname">MakeLSParmDict</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.MakeLSParmDict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.MakeLSParmDict" title="Permalink to this definition">¶</a></dt>
278<dd><p>Load all parameters used for computation from the tree into a
279dict of paired values [value, refine flag]. Note that this is
280different than the parmDict used in the refinement, which only has
281values.</p>
282<p>Note that similar things are done in
283<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ExportBaseclass.loadParmDict" title="GSASIIIO.ExportBaseclass.loadParmDict"><tt class="xref py py-meth docutils literal"><span class="pre">GSASIIIO.ExportBaseclass.loadParmDict()</span></tt></a> (from the tree) and
284<a class="reference internal" href="GSASIIstruc.html#GSASIIstrMain.Refine" title="GSASIIstrMain.Refine"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrMain.Refine()</span></tt></a> and <a class="reference internal" href="GSASIIstruc.html#GSASIIstrMain.SeqRefine" title="GSASIIstrMain.SeqRefine"><tt class="xref py py-func docutils literal"><span class="pre">GSASIIstrMain.SeqRefine()</span></tt></a> (from
285a GPX file).</p>
286<table class="docutils field-list" frame="void" rules="none">
287<col class="field-name" />
288<col class="field-body" />
289<tbody valign="top">
290<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">(parmDict,varyList) where:<ul class="simple">
291<li>parmDict is a dict with values and refinement flags
292for each parameter and</li>
293<li>varyList is a list of variables (refined parameters).</li>
294</ul>
295</td>
296</tr>
297</tbody>
298</table>
299</dd></dl>
300
301<dl class="method">
302<dt id="GSASII.GSASII.MenuBinding">
303<tt class="descclassname">GSASII.</tt><tt class="descname">MenuBinding</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.MenuBinding"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.MenuBinding" title="Permalink to this definition">¶</a></dt>
304<dd><p>Called when a menu is clicked upon; looks up the binding in table</p>
305</dd></dl>
306
307<dl class="method">
308<dt id="GSASII.GSASII.OnAddPhase">
309<tt class="descclassname">GSASII.</tt><tt class="descname">OnAddPhase</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnAddPhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnAddPhase" title="Permalink to this definition">¶</a></dt>
310<dd><p>Add a new, empty phase to the tree. Called by Data/Add Phase menu</p>
311</dd></dl>
312
313<dl class="method">
314<dt id="GSASII.GSASII.OnDataDelete">
315<tt class="descclassname">GSASII.</tt><tt class="descname">OnDataDelete</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnDataDelete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnDataDelete" title="Permalink to this definition">¶</a></dt>
316<dd><p>Delete one or more histograms from data tree. Called by the
317Data/DeleteData menu</p>
318</dd></dl>
319
320<dl class="method">
321<dt id="GSASII.GSASII.OnDeletePhase">
322<tt class="descclassname">GSASII.</tt><tt class="descname">OnDeletePhase</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnDeletePhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnDeletePhase" title="Permalink to this definition">¶</a></dt>
323<dd><p>Delete a phase from the tree. Called by Data/Delete Phase menu</p>
324</dd></dl>
325
326<dl class="method">
327<dt id="GSASII.GSASII.OnDummyPowder">
328<tt class="descclassname">GSASII.</tt><tt class="descname">OnDummyPowder</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnDummyPowder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnDummyPowder" title="Permalink to this definition">¶</a></dt>
329<dd><p>Called in response to Import/Powder Data/Simulate menu item
330to create a Dummy powder diffraction data set.</p>
331<p>Reads an instrument parameter file and then gets input from the user</p>
332</dd></dl>
333
334<dl class="method">
335<dt id="GSASII.GSASII.OnFileClose">
336<tt class="descclassname">GSASII.</tt><tt class="descname">OnFileClose</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnFileClose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnFileClose" title="Permalink to this definition">¶</a></dt>
337<dd><p>Clears the data tree in response to the
338File/New Project menu button. User is given option to save
339the project.</p>
340</dd></dl>
341
342<dl class="method">
343<dt id="GSASII.GSASII.OnFileExit">
344<tt class="descclassname">GSASII.</tt><tt class="descname">OnFileExit</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnFileExit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnFileExit" title="Permalink to this definition">¶</a></dt>
345<dd><p>Called in response to the File/Quit menu button</p>
346</dd></dl>
347
348<dl class="method">
349<dt id="GSASII.GSASII.OnFileOpen">
350<tt class="descclassname">GSASII.</tt><tt class="descname">OnFileOpen</tt><big>(</big><em>event</em>, <em>filename=None</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnFileOpen"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnFileOpen" title="Permalink to this definition">¶</a></dt>
351<dd><p>Gets a GSAS-II .gpx project file in response to the
352File/Open Project menu button</p>
353</dd></dl>
354
355<dl class="method">
356<dt id="GSASII.GSASII.OnFileSave">
357<tt class="descclassname">GSASII.</tt><tt class="descname">OnFileSave</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnFileSave"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnFileSave" title="Permalink to this definition">¶</a></dt>
358<dd><p>Save the current project in response to the
359File/Save Project menu button</p>
360</dd></dl>
361
362<dl class="method">
363<dt id="GSASII.GSASII.OnFileSaveas">
364<tt class="descclassname">GSASII.</tt><tt class="descname">OnFileSaveas</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnFileSaveas"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnFileSaveas" title="Permalink to this definition">¶</a></dt>
365<dd><p>Save the current project in response to the
366File/Save as menu button</p>
367</dd></dl>
368
369<dl class="method">
370<dt id="GSASII.GSASII.OnImageRead">
371<tt class="descclassname">GSASII.</tt><tt class="descname">OnImageRead</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImageRead"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImageRead" title="Permalink to this definition">¶</a></dt>
372<dd><p>Called to read in an image in any known format</p>
373</dd></dl>
374
375<dl class="method">
376<dt id="GSASII.GSASII.OnImageSum">
377<tt class="descclassname">GSASII.</tt><tt class="descname">OnImageSum</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImageSum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImageSum" title="Permalink to this definition">¶</a></dt>
378<dd><p>Sum together image data(?)</p>
379</dd></dl>
380
381<dl class="method">
382<dt id="GSASII.GSASII.OnImportGeneric">
383<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportGeneric</tt><big>(</big><em>reader</em>, <em>readerlist</em>, <em>label</em>, <em>multiple=False</em>, <em>usedRanIdList=</em>, <span class="optional">[</span><span class="optional">]</span><em>Preview=True</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportGeneric"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportGeneric" title="Permalink to this definition">¶</a></dt>
384<dd><p>Used to import Phases or datasets using reader objects
385subclassed from <a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportPhase" title="GSASIIIO.ImportPhase"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportPhase</span></tt></a>,
386<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportStructFactor" title="GSASIIIO.ImportStructFactor"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportStructFactor</span></tt></a>,
387<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportPowderData" title="GSASIIIO.ImportPowderData"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportPowderData</span></tt></a>,
388<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportSmallAngleData" title="GSASIIIO.ImportSmallAngleData"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportSmallAngleData</span></tt></a> or
389<a class="reference internal" href="GSASIIGUIr.html#GSASIIIO.ImportImage" title="GSASIIIO.ImportImage"><tt class="xref py py-class docutils literal"><span class="pre">GSASIIIO.ImportImage</span></tt></a>.
390If a specific reader is specified, only that method will be called,
391but if no reader is specified, every one that is potentially
392compatible (by file extension) will be tried on the file(s)
393selected in the Open File dialog.</p>
394<table class="docutils field-list" frame="void" rules="none">
395<col class="field-name" />
396<col class="field-body" />
397<tbody valign="top">
398<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
399<li><strong>reader</strong> (<em>readerobject</em>) &#8211; This will be a reference to
400a particular object to be used to read a file or None,
401if every appropriate reader should be used.</li>
402<li><strong>readerlist</strong> (<em>list</em>) &#8211; a list of reader objects appropriate for
403the current read attempt. At present, this will be either
404self.ImportPhaseReaderlist, self.ImportSfactReaderlist or
405self.ImportPowderReaderlist (defined in _init_Imports from
406the files found in the path), but in theory this list could
407be tailored. Used only when reader is None.</li>
408<li><strong>label</strong> (<em>str</em>) &#8211; string to place on the open file dialog:
409Open <cite>label</cite> input file</li>
410<li><strong>multiple</strong> (<em>bool</em>) &#8211; True if multiple files can be selected
411in the file dialog. False is default. At present True is used
412only for reading of powder data.</li>
413<li><strong>usedRanIdList</strong> (<em>list</em>) &#8211; an optional list of random Ids that
414have been used and should not be reused</li>
415<li><strong>Preview</strong> (<em>bool</em>) &#8211; indicates if a preview of the file should
416be shown. Default is True, but set to False for image files
417which are all binary.</li>
418</ul>
419</td>
420</tr>
421<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list of reader objects (rd_list) that were able
422to read the specified file(s). This list may be empty.</p>
423</td>
424</tr>
425</tbody>
426</table>
427</dd></dl>
428
429<dl class="method">
430<dt id="GSASII.GSASII.OnImportImage">
431<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportImage</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportImage" title="Permalink to this definition">¶</a></dt>
432<dd><p>Called in response to an Import/Image/... menu item
433to read an image from a file. Like all the other imports,
434dict self.ImportMenuId is used to look up the specific
435reader item associated with the menu item, which will be
436None for the last menu item, which is the &#8220;guess&#8221; option
437where all appropriate formats will be tried.</p>
438<p>A reader object is filled each time an image is read.</p>
439</dd></dl>
440
441<dl class="method">
442<dt id="GSASII.GSASII.OnImportPhase">
443<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportPhase</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportPhase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportPhase" title="Permalink to this definition">¶</a></dt>
444<dd><p>Called in response to an Import/Phase/... menu item
445to read phase information.
446dict self.ImportMenuId is used to look up the specific
447reader item associated with the menu item, which will be
448None for the last menu item, which is the &#8220;guess&#8221; option
449where all appropriate formats will be tried.</p>
450</dd></dl>
451
452<dl class="method">
453<dt id="GSASII.GSASII.OnImportPowder">
454<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportPowder</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportPowder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportPowder" title="Permalink to this definition">¶</a></dt>
455<dd><p>Called in response to an Import/Powder Data/... menu item
456to read a powder diffraction data set.
457dict self.ImportMenuId is used to look up the specific
458reader item associated with the menu item, which will be
459None for the last menu item, which is the &#8220;guess&#8221; option
460where all appropriate formats will be tried.</p>
461<p>Also reads an instrument parameter file for each dataset.</p>
462</dd></dl>
463
464<dl class="method">
465<dt id="GSASII.GSASII.OnImportSfact">
466<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportSfact</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportSfact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportSfact" title="Permalink to this definition">¶</a></dt>
467<dd><p>Called in response to an Import/Structure Factor/... menu item
468to read single crystal datasets.
469dict self.ImportMenuId is used to look up the specific
470reader item associated with the menu item, which will be
471None for the last menu item, which is the &#8220;guess&#8221; option
472where all appropriate formats will be tried.</p>
473</dd></dl>
474
475<dl class="method">
476<dt id="GSASII.GSASII.OnImportSmallAngle">
477<tt class="descclassname">GSASII.</tt><tt class="descname">OnImportSmallAngle</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnImportSmallAngle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnImportSmallAngle" title="Permalink to this definition">¶</a></dt>
478<dd><p>Called in response to an Import/Small Angle Data/... menu item
479to read a small angle diffraction data set.
480dict self.ImportMenuId is used to look up the specific
481reader item associated with the menu item, which will be
482None for the last menu item, which is the &#8220;guess&#8221; option
483where all appropriate formats will be tried.</p>
484</dd></dl>
485
486<dl class="method">
487<dt id="GSASII.GSASII.OnMacroRecordStatus">
488<tt class="descclassname">GSASII.</tt><tt class="descname">OnMacroRecordStatus</tt><big>(</big><em>event</em>, <em>setvalue=None</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnMacroRecordStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnMacroRecordStatus" title="Permalink to this definition">¶</a></dt>
489<dd><p>Called when the record macro menu item is used which toggles the
490value. Alternately a value to be set can be provided. Note that this
491routine is made more complex because on the Mac there are lots of menu
492items (listed in self.MacroStatusList) and this loops over all of them.</p>
493</dd></dl>
494
495<dl class="method">
496<dt id="GSASII.GSASII.OnMakePDFs">
497<tt class="descclassname">GSASII.</tt><tt class="descname">OnMakePDFs</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnMakePDFs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnMakePDFs" title="Permalink to this definition">¶</a></dt>
498<dd><p>Calculates PDFs</p>
499</dd></dl>
500
501<dl class="method">
502<dt id="GSASII.GSASII.OnPatternTreeItemActivated">
503<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeItemActivated</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeItemActivated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeItemActivated" title="Permalink to this definition">¶</a></dt>
504<dd><p>Called when a tree item is activated</p>
505</dd></dl>
506
507<dl class="method">
508<dt id="GSASII.GSASII.OnPatternTreeItemCollapsed">
509<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeItemCollapsed</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeItemCollapsed"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeItemCollapsed" title="Permalink to this definition">¶</a></dt>
510<dd><p>Called when a tree item is collapsed - all children will be collapsed</p>
511</dd></dl>
512
513<dl class="method">
514<dt id="GSASII.GSASII.OnPatternTreeItemDelete">
515<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeItemDelete</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeItemDelete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeItemDelete" title="Permalink to this definition">¶</a></dt>
516<dd><p>Called when a tree item is deleted &#8211; not sure what this does</p>
517</dd></dl>
518
519<dl class="method">
520<dt id="GSASII.GSASII.OnPatternTreeItemExpanded">
521<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeItemExpanded</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeItemExpanded"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeItemExpanded" title="Permalink to this definition">¶</a></dt>
522<dd><p>Called when a tree item is expanded</p>
523</dd></dl>
524
525<dl class="method">
526<dt id="GSASII.GSASII.OnPatternTreeKeyDown">
527<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeKeyDown</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeKeyDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeKeyDown" title="Permalink to this definition">¶</a></dt>
528<dd><p>Allows stepping through the tree with the up/down arrow keys</p>
529</dd></dl>
530
531<dl class="method">
532<dt id="GSASII.GSASII.OnPatternTreeSelChanged">
533<tt class="descclassname">GSASII.</tt><tt class="descname">OnPatternTreeSelChanged</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPatternTreeSelChanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPatternTreeSelChanged" title="Permalink to this definition">¶</a></dt>
534<dd><p>Called when a data tree item is selected</p>
535</dd></dl>
536
537<dl class="method">
538<dt id="GSASII.GSASII.OnPreferences">
539<tt class="descclassname">GSASII.</tt><tt class="descname">OnPreferences</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPreferences"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPreferences" title="Permalink to this definition">¶</a></dt>
540<dd><p>Edit the GSAS-II configuration variables</p>
541</dd></dl>
542
543<dl class="method">
544<dt id="GSASII.GSASII.OnPwdrSum">
545<tt class="descclassname">GSASII.</tt><tt class="descname">OnPwdrSum</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnPwdrSum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnPwdrSum" title="Permalink to this definition">¶</a></dt>
546<dd><p>Sum together powder data(?)</p>
547</dd></dl>
548
549<dl class="method">
550<dt id="GSASII.GSASII.OnReadPowderPeaks">
551<tt class="descclassname">GSASII.</tt><tt class="descname">OnReadPowderPeaks</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnReadPowderPeaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnReadPowderPeaks" title="Permalink to this definition">¶</a></dt>
552<dd><p>Bound to menu Data/Read Powder Peaks</p>
553</dd></dl>
554
555<dl class="method">
556<dt id="GSASII.GSASII.OnRefine">
557<tt class="descclassname">GSASII.</tt><tt class="descname">OnRefine</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnRefine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnRefine" title="Permalink to this definition">¶</a></dt>
558<dd><p>Perform a refinement.
559Called from the Calculate/Refine menu.</p>
560</dd></dl>
561
562<dl class="method">
563<dt id="GSASII.GSASII.OnRenameData">
564<tt class="descclassname">GSASII.</tt><tt class="descname">OnRenameData</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnRenameData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnRenameData" title="Permalink to this definition">¶</a></dt>
565<dd><p>Renames an existing phase. Called by Data/Rename Phase menu</p>
566</dd></dl>
567
568<dl class="method">
569<dt id="GSASII.GSASII.OnSeqRefine">
570<tt class="descclassname">GSASII.</tt><tt class="descname">OnSeqRefine</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnSeqRefine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnSeqRefine" title="Permalink to this definition">¶</a></dt>
571<dd><p>Perform a sequential refinement.
572Called from the Calculate/Sequential refine menu.</p>
573</dd></dl>
574
575<dl class="method">
576<dt id="GSASII.GSASII.OnSize">
577<tt class="descclassname">GSASII.</tt><tt class="descname">OnSize</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OnSize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OnSize" title="Permalink to this definition">¶</a></dt>
578<dd><p>Called when the main window is resized. Not sure why</p>
579</dd></dl>
580
581<dl class="method">
582<dt id="GSASII.GSASII.OpenPowderInstprm">
583<tt class="descclassname">GSASII.</tt><tt class="descname">OpenPowderInstprm</tt><big>(</big><em>instfile</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.OpenPowderInstprm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.OpenPowderInstprm" title="Permalink to this definition">¶</a></dt>
584<dd><p>Read a GSAS-II (new) instrument parameter file</p>
585<table class="docutils field-list" frame="void" rules="none">
586<col class="field-name" />
587<col class="field-body" />
588<tbody valign="top">
589<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>instfile</strong> (<em>str</em>) &#8211; name of instrument parameter file</td>
590</tr>
591</tbody>
592</table>
593</dd></dl>
594
595<dl class="method">
596<dt id="GSASII.GSASII.PreviewFile">
597<tt class="descclassname">GSASII.</tt><tt class="descname">PreviewFile</tt><big>(</big><em>filename</em>, <em>fp</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.PreviewFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.PreviewFile" title="Permalink to this definition">¶</a></dt>
598<dd><p>confirm we have the right file</p>
599</dd></dl>
600
601<dl class="method">
602<dt id="GSASII.GSASII.ReadPowderInstprm">
603<tt class="descclassname">GSASII.</tt><tt class="descname">ReadPowderInstprm</tt><big>(</big><em>instLines</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.ReadPowderInstprm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.ReadPowderInstprm" title="Permalink to this definition">¶</a></dt>
604<dd><p>Read lines from a GSAS-II (new) instrument parameter file</p>
605<table class="docutils field-list" frame="void" rules="none">
606<col class="field-name" />
607<col class="field-body" />
608<tbody valign="top">
609<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>instLines</strong> (<em>list</em>) &#8211; strings from GSAS-II parameter file; can be concatenated with &#8216;;&#8217;</td>
610</tr>
611</tbody>
612</table>
613</dd></dl>
614
615<dl class="method">
616<dt id="GSASII.GSASII.ReadPowderIparm">
617<tt class="descclassname">GSASII.</tt><tt class="descname">ReadPowderIparm</tt><big>(</big><em>instfile</em>, <em>bank</em>, <em>databanks</em>, <em>rd</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.ReadPowderIparm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.ReadPowderIparm" title="Permalink to this definition">¶</a></dt>
618<dd><p>Read a GSAS (old) instrument parameter file</p>
619<table class="docutils field-list" frame="void" rules="none">
620<col class="field-name" />
621<col class="field-body" />
622<tbody valign="top">
623<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
624<li><strong>instfile</strong> (<em>str</em>) &#8211; name of instrument parameter file</li>
625<li><strong>bank</strong> (<em>int</em>) &#8211; the bank number read in the raw data file</li>
626<li><strong>databanks</strong> (<em>int</em>) &#8211; the number of banks in the raw data file.
627If the number of banks in the data and instrument parameter files
628agree, then the sets of banks are assumed to match up and bank
629is used to select the instrument parameter file. If not, the user
630is asked to make a selection.</li>
631<li><strong>rd</strong> (<em>obj</em>) &#8211; the raw data (histogram) data object. This
632sets rd.instbank.</li>
633</ul>
634</td>
635</tr>
636</tbody>
637</table>
638</dd></dl>
639
640<dl class="method">
641<dt id="GSASII.GSASII.ShowLSParms">
642<tt class="descclassname">GSASII.</tt><tt class="descname">ShowLSParms</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.ShowLSParms"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.ShowLSParms" title="Permalink to this definition">¶</a></dt>
643<dd><p>Displays a window showing all parameters in the refinement.
644Called from the Calculate/View LS Parms menu.</p>
645</dd></dl>
646
647<dl class="method">
648<dt id="GSASII.GSASII.StartProject">
649<tt class="descclassname">GSASII.</tt><tt class="descname">StartProject</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.StartProject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.StartProject" title="Permalink to this definition">¶</a></dt>
650<dd><p>Opens a GSAS-II project file &amp; selects the 1st available data set to
651display (PWDR, HKLF or SASD)</p>
652</dd></dl>
653
654<dl class="class">
655<dt id="GSASII.GSASII.SumDialog">
656<em class="property">class </em><tt class="descclassname">GSASII.</tt><tt class="descname">SumDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>text</em>, <em>dataType</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASII.SumDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASII.SumDialog" title="Permalink to this definition">¶</a></dt>
657<dd><p>Allows user to supply scale factor(s) when summing data</p>
658</dd></dl>
659
660</dd></dl>
661
662<dl class="class">
663<dt id="GSASII.GSASIImain">
664<em class="property">class </em><tt class="descclassname">GSASII.</tt><tt class="descname">GSASIImain</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASIImain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASIImain" title="Permalink to this definition">¶</a></dt>
665<dd><p>Defines a wxApp for GSAS-II</p>
666<p>Creates a wx frame (self.main) which contains the display of the
667data tree.</p>
668<dl class="method">
669<dt id="GSASII.GSASIImain.OnInit">
670<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#GSASIImain.OnInit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.GSASIImain.OnInit" title="Permalink to this definition">¶</a></dt>
671<dd><p>Called automatically when the app is created.</p>
672</dd></dl>
673
674</dd></dl>
675
676<dl class="function">
677<dt id="GSASII.main">
678<tt class="descclassname">GSASII.</tt><tt class="descname">main</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASII.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASII.main" title="Permalink to this definition">¶</a></dt>
679<dd><p>Start up the GSAS-II application</p>
680</dd></dl>
681
682</div>
683
684
685          </div>
686        </div>
687      </div>
688      <div class="sphinxsidebar">
689        <div class="sphinxsidebarwrapper">
690            <p class="logo"><a href="index.html">
691              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
692            </a></p>
693  <h4>Previous topic</h4>
694  <p class="topless"><a href="index.html"
695                        title="previous chapter">GSAS-II Developer&#8217;s Documentation</a></p>
696  <h4>Next topic</h4>
697  <p class="topless"><a href="GSASIIobj.html"
698                        title="next chapter"><em>GSASIIobj: Data objects</em></a></p>
699  <h3>This Page</h3>
700  <ul class="this-page-menu">
701    <li><a href="_sources/GSASII.txt"
702           rel="nofollow">Show Source</a></li>
703  </ul>
704<div id="searchbox" style="display: none">
705  <h3>Quick search</h3>
706    <form class="search" action="search.html" method="get">
707      <input type="text" name="q" />
708      <input type="submit" value="Go" />
709      <input type="hidden" name="check_keywords" value="yes" />
710      <input type="hidden" name="area" value="default" />
711    </form>
712    <p class="searchtip" style="font-size: 90%">
713    Enter search terms or a module, class or function name.
714    </p>
715</div>
716<script type="text/javascript">$('#searchbox').show(0);</script>
717        </div>
718      </div>
719      <div class="clearer"></div>
720    </div>
721    <div class="related">
722      <h3>Navigation</h3>
723      <ul>
724        <li class="right" style="margin-right: 10px">
725          <a href="genindex.html" title="General Index"
726             >index</a></li>
727        <li class="right" >
728          <a href="py-modindex.html" title="Python Module Index"
729             >modules</a> |</li>
730        <li class="right" >
731          <a href="GSASIIobj.html" title="GSASIIobj: Data objects"
732             >next</a> |</li>
733        <li class="right" >
734          <a href="index.html" title="GSAS-II Developer’s Documentation"
735             >previous</a> |</li>
736        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
737      </ul>
738    </div>
739    <div class="footer">
740        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
741      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
742    </div>
743  </body>
744</html>
Note: See TracBrowser for help on using the repository browser.