1 | |
---|
2 | |
---|
3 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
4 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
5 | |
---|
6 | |
---|
7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
8 | <head> |
---|
9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
10 | |
---|
11 | <title>GSASIIgrid: Basic GUI routines — GSAS-II 0.2.0 documentation</title> |
---|
12 | |
---|
13 | <link rel="stylesheet" href="_static/default.css" type="text/css" /> |
---|
14 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
---|
15 | |
---|
16 | <script type="text/javascript"> |
---|
17 | var DOCUMENTATION_OPTIONS = { |
---|
18 | URL_ROOT: '', |
---|
19 | VERSION: '0.2.0', |
---|
20 | COLLAPSE_INDEX: false, |
---|
21 | FILE_SUFFIX: '.html', |
---|
22 | HAS_SOURCE: true |
---|
23 | }; |
---|
24 | </script> |
---|
25 | <script type="text/javascript" src="_static/jquery.js"></script> |
---|
26 | <script type="text/javascript" src="_static/underscore.js"></script> |
---|
27 | <script type="text/javascript" src="_static/doctools.js"></script> |
---|
28 | <link rel="top" title="GSAS-II 0.2.0 documentation" href="index.html" /> |
---|
29 | <link rel="next" title="GSASIIphsGUI: Phase GUI" href="GSASIIphsGUI.html" /> |
---|
30 | <link rel="prev" title="GSASIImapvars: Parameter constraints" href="GSASIImapvars.html" /> |
---|
31 | </head> |
---|
32 | <body> |
---|
33 | <div class="related"> |
---|
34 | <h3>Navigation</h3> |
---|
35 | <ul> |
---|
36 | <li class="right" style="margin-right: 10px"> |
---|
37 | <a href="genindex.html" title="General Index" |
---|
38 | accesskey="I">index</a></li> |
---|
39 | <li class="right" > |
---|
40 | <a href="py-modindex.html" title="Python Module Index" |
---|
41 | >modules</a> |</li> |
---|
42 | <li class="right" > |
---|
43 | <a href="GSASIIphsGUI.html" title="GSASIIphsGUI: Phase GUI" |
---|
44 | accesskey="N">next</a> |</li> |
---|
45 | <li class="right" > |
---|
46 | <a href="GSASIImapvars.html" title="GSASIImapvars: Parameter constraints" |
---|
47 | accesskey="P">previous</a> |</li> |
---|
48 | <li><a href="index.html">GSAS-II 0.2.0 documentation</a> »</li> |
---|
49 | </ul> |
---|
50 | </div> |
---|
51 | |
---|
52 | <div class="document"> |
---|
53 | <div class="documentwrapper"> |
---|
54 | <div class="bodywrapper"> |
---|
55 | <div class="body"> |
---|
56 | |
---|
57 | <span class="target" id="module-GSASIIgrid"></span><div class="section" id="gsasiigrid-basic-gui-routines"> |
---|
58 | <h1><em>GSASIIgrid: Basic GUI routines</em><a class="headerlink" href="#gsasiigrid-basic-gui-routines" title="Permalink to this headline">¶</a></h1> |
---|
59 | <dl class="class"> |
---|
60 | <dt id="GSASIIgrid.AddHelp"> |
---|
61 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">AddHelp</tt><big>(</big><em>frame</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#AddHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.AddHelp" title="Permalink to this definition">¶</a></dt> |
---|
62 | <dd><p>This class a single entry for the help menu (used on the Mac only): |
---|
63 | ‘Help on <helpType>’: where helpType is a reference to an HTML page to |
---|
64 | be opened</p> |
---|
65 | <p>NOTE: the title when appending this menu should be ‘&Help’ so the wx handles |
---|
66 | it correctly.</p> |
---|
67 | <dl class="method"> |
---|
68 | <dt id="GSASIIgrid.AddHelp.OnHelpById"> |
---|
69 | <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#AddHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.AddHelp.OnHelpById" title="Permalink to this definition">¶</a></dt> |
---|
70 | <dd><p>Called when Help on... is pressed in a menu. Brings up |
---|
71 | a web page for documentation.</p> |
---|
72 | </dd></dl> |
---|
73 | |
---|
74 | </dd></dl> |
---|
75 | |
---|
76 | <dl class="class"> |
---|
77 | <dt id="GSASIIgrid.DataFrame"> |
---|
78 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DataFrame</tt><big>(</big><em>parent</em>, <em>frame</em>, <em>data=None</em>, <em>name=None</em>, <em>size=None</em>, <em>pos=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame" title="Permalink to this definition">¶</a></dt> |
---|
79 | <dd><p>Create the dataframe window and all the entries in menus. |
---|
80 | The binding is for the menus is not done here, but rather is done |
---|
81 | where the functions can be accessed (in various GSASII*GUI modules).</p> |
---|
82 | <dl class="method"> |
---|
83 | <dt id="GSASIIgrid.DataFrame.Bind"> |
---|
84 | <tt class="descname">Bind</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.Bind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.Bind" title="Permalink to this definition">¶</a></dt> |
---|
85 | <dd><p>Override the Bind() function: on the Mac the binding is to |
---|
86 | the main window, so that menus operate with any window on top. |
---|
87 | For other platforms, call the default wx.Frame Bind()</p> |
---|
88 | </dd></dl> |
---|
89 | |
---|
90 | <dl class="method"> |
---|
91 | <dt id="GSASIIgrid.DataFrame.PostfillDataMenu"> |
---|
92 | <tt class="descname">PostfillDataMenu</tt><big>(</big><em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PostfillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PostfillDataMenu" title="Permalink to this definition">¶</a></dt> |
---|
93 | <dd><p>Create the “standard” part of data frame menus. Note that on Linux and |
---|
94 | Windows, this is the standard help Menu. On Mac, this menu duplicates the |
---|
95 | tree menu, but adds an extra help command for the data item and a separator.</p> |
---|
96 | </dd></dl> |
---|
97 | |
---|
98 | <dl class="method"> |
---|
99 | <dt id="GSASIIgrid.DataFrame.PrefillDataMenu"> |
---|
100 | <tt class="descname">PrefillDataMenu</tt><big>(</big><em>menu</em>, <em>helpType</em>, <em>helpLbl=None</em>, <em>empty=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DataFrame.PrefillDataMenu"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DataFrame.PrefillDataMenu" title="Permalink to this definition">¶</a></dt> |
---|
101 | <dd><p>Create the “standard” part of data frame menus. Note that on Linux and |
---|
102 | Windows nothing happens here. On Mac, this menu duplicates the |
---|
103 | tree menu, but adds an extra help command for the data item and a separator.</p> |
---|
104 | </dd></dl> |
---|
105 | |
---|
106 | </dd></dl> |
---|
107 | |
---|
108 | <dl class="class"> |
---|
109 | <dt id="GSASIIgrid.DisAglDialog"> |
---|
110 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">DisAglDialog</tt><big>(</big><em>parent</em>, <em>data</em>, <em>default</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#DisAglDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.DisAglDialog" title="Permalink to this definition">¶</a></dt> |
---|
111 | <dd><p>Distance Angle Controls dialog</p> |
---|
112 | </dd></dl> |
---|
113 | |
---|
114 | <dl class="class"> |
---|
115 | <dt id="GSASIIgrid.G2HtmlWindow"> |
---|
116 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">G2HtmlWindow</tt><big>(</big><em>parent</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#G2HtmlWindow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.G2HtmlWindow" title="Permalink to this definition">¶</a></dt> |
---|
117 | <dd><p>Displays help information in a primitive HTML browser type window</p> |
---|
118 | </dd></dl> |
---|
119 | |
---|
120 | <dl class="class"> |
---|
121 | <dt id="GSASIIgrid.GSGrid"> |
---|
122 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSGrid</tt><big>(</big><em>parent</em>, <em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSGrid" title="Permalink to this definition">¶</a></dt> |
---|
123 | <dd><p>Basic wx.Grid implementation</p> |
---|
124 | </dd></dl> |
---|
125 | |
---|
126 | <dl class="class"> |
---|
127 | <dt id="GSASIIgrid.GSNoteBook"> |
---|
128 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GSNoteBook</tt><big>(</big><em>parent</em>, <em>name=''</em>, <em>size=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GSNoteBook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GSNoteBook" title="Permalink to this definition">¶</a></dt> |
---|
129 | <dd><p>Notebook used in various locations; implemented with wx.aui extension</p> |
---|
130 | </dd></dl> |
---|
131 | |
---|
132 | <dl class="function"> |
---|
133 | <dt id="GSASIIgrid.GetPatternTreeDataNames"> |
---|
134 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeDataNames</tt><big>(</big><em>G2frame</em>, <em>dataTypes</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeDataNames"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeDataNames" title="Permalink to this definition">¶</a></dt> |
---|
135 | <dd><p>Not sure what this does</p> |
---|
136 | </dd></dl> |
---|
137 | |
---|
138 | <dl class="function"> |
---|
139 | <dt id="GSASIIgrid.GetPatternTreeItemId"> |
---|
140 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GetPatternTreeItemId</tt><big>(</big><em>G2frame</em>, <em>parentId</em>, <em>itemText</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GetPatternTreeItemId"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GetPatternTreeItemId" title="Permalink to this definition">¶</a></dt> |
---|
141 | <dd><p>Not sure what this does</p> |
---|
142 | </dd></dl> |
---|
143 | |
---|
144 | <dl class="class"> |
---|
145 | <dt id="GSASIIgrid.GridFractionEditor"> |
---|
146 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">GridFractionEditor</tt><big>(</big><em>grid</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#GridFractionEditor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.GridFractionEditor" title="Permalink to this definition">¶</a></dt> |
---|
147 | <dd><p>A grid cell editor class that allows entry of values as fractions as well |
---|
148 | as sine and cosine values [as s() and c()]</p> |
---|
149 | </dd></dl> |
---|
150 | |
---|
151 | <dl class="function"> |
---|
152 | <dt id="GSASIIgrid.HorizontalLine"> |
---|
153 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">HorizontalLine</tt><big>(</big><em>sizer</em>, <em>parent</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#HorizontalLine"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.HorizontalLine" title="Permalink to this definition">¶</a></dt> |
---|
154 | <dd><p>Draws a horizontal line as wide as the window. |
---|
155 | This shows up on the Mac as a very thin line, no matter what I do</p> |
---|
156 | </dd></dl> |
---|
157 | |
---|
158 | <dl class="function"> |
---|
159 | <dt id="GSASIIgrid.MovePatternTreeToGrid"> |
---|
160 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MovePatternTreeToGrid</tt><big>(</big><em>G2frame</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MovePatternTreeToGrid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MovePatternTreeToGrid" title="Permalink to this definition">¶</a></dt> |
---|
161 | <dd><p>Not sure what this does</p> |
---|
162 | </dd></dl> |
---|
163 | |
---|
164 | <dl class="class"> |
---|
165 | <dt id="GSASIIgrid.MyHelp"> |
---|
166 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MyHelp</tt><big>(</big><em>frame</em>, <em>helpType=None</em>, <em>helpLbl=None</em>, <em>morehelpitems=</em><span class="optional">[</span><span class="optional">]</span>, <em>title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp" title="Permalink to this definition">¶</a></dt> |
---|
167 | <dd><p>A class that creates the contents of a help menu. |
---|
168 | The menu will start with two entries:</p> |
---|
169 | <ul class="simple"> |
---|
170 | <li>‘Help on <helpType>’: where helpType is a reference to an HTML page to |
---|
171 | be opened</li> |
---|
172 | <li>About: opens an About dialog using OnHelpAbout. N.B. on the Mac this |
---|
173 | gets moved to the App menu to be consistent with Apple style.</li> |
---|
174 | </ul> |
---|
175 | <p>NOTE: for this to work properly with respect to system menus, the title |
---|
176 | for the menu must be &Help, or it will not be processed properly:</p> |
---|
177 | <div class="highlight-python"><div class="highlight"><pre><span class="n">menu</span><span class="o">.</span><span class="n">Append</span><span class="p">(</span><span class="n">menu</span><span class="o">=</span><span class="n">MyHelp</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span><span class="o">...</span><span class="p">),</span><span class="n">title</span><span class="o">=</span><span class="s">"&Help"</span><span class="p">)</span> |
---|
178 | </pre></div> |
---|
179 | </div> |
---|
180 | <dl class="method"> |
---|
181 | <dt id="GSASIIgrid.MyHelp.OnCheckUpdates"> |
---|
182 | <tt class="descname">OnCheckUpdates</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHelp.OnCheckUpdates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnCheckUpdates" title="Permalink to this definition">¶</a></dt> |
---|
183 | <dd><p>Check if the GSAS-II repository has an update for the current source files |
---|
184 | and perform that update if requested.</p> |
---|
185 | </dd></dl> |
---|
186 | |
---|
187 | <dl class="method"> |
---|
188 | <dt id="GSASIIgrid.MyHelp.OnHelpAbout"> |
---|
189 | <tt class="descname">OnHelpAbout</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHelp.OnHelpAbout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnHelpAbout" title="Permalink to this definition">¶</a></dt> |
---|
190 | <dd><p>Display an ‘About GSAS-II’ box</p> |
---|
191 | </dd></dl> |
---|
192 | |
---|
193 | <dl class="method"> |
---|
194 | <dt id="GSASIIgrid.MyHelp.OnHelpById"> |
---|
195 | <tt class="descname">OnHelpById</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHelp.OnHelpById"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHelp.OnHelpById" title="Permalink to this definition">¶</a></dt> |
---|
196 | <dd><p>Called when Help on... is pressed in a menu. Brings up |
---|
197 | a web page for documentation.</p> |
---|
198 | </dd></dl> |
---|
199 | |
---|
200 | </dd></dl> |
---|
201 | |
---|
202 | <dl class="class"> |
---|
203 | <dt id="GSASIIgrid.MyHtmlPanel"> |
---|
204 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">MyHtmlPanel</tt><big>(</big><em>frame</em>, <em>id</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#MyHtmlPanel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.MyHtmlPanel" title="Permalink to this definition">¶</a></dt> |
---|
205 | <dd><p>Defines a panel to display Help information</p> |
---|
206 | </dd></dl> |
---|
207 | |
---|
208 | <dl class="class"> |
---|
209 | <dt id="GSASIIgrid.PickTwoDialog"> |
---|
210 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">PickTwoDialog</tt><big>(</big><em>parent</em>, <em>title</em>, <em>prompt</em>, <em>names</em>, <em>choices</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#PickTwoDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.PickTwoDialog" title="Permalink to this definition">¶</a></dt> |
---|
211 | <dd><p>This does not seem to be in use</p> |
---|
212 | </dd></dl> |
---|
213 | |
---|
214 | <dl class="function"> |
---|
215 | <dt id="GSASIIgrid.SetDataMenuBar"> |
---|
216 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SetDataMenuBar</tt><big>(</big><em>G2frame</em>, <em>menu=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SetDataMenuBar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SetDataMenuBar" title="Permalink to this definition">¶</a></dt> |
---|
217 | <dd><p>Set the menu for the data frame. On the Mac put this |
---|
218 | menu for the data tree window instead.</p> |
---|
219 | <p>Note that data frame items do not have menus, for these (menu=None) |
---|
220 | display a blank menu or on the Mac display the standard menu for |
---|
221 | the data tree window.</p> |
---|
222 | </dd></dl> |
---|
223 | |
---|
224 | <dl class="function"> |
---|
225 | <dt id="GSASIIgrid.ShowHelp"> |
---|
226 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">ShowHelp</tt><big>(</big><em>helpType</em>, <em>frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#ShowHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.ShowHelp" title="Permalink to this definition">¶</a></dt> |
---|
227 | <dd><p>Called to bring up a web page for documentation.</p> |
---|
228 | </dd></dl> |
---|
229 | |
---|
230 | <dl class="class"> |
---|
231 | <dt id="GSASIIgrid.SingleFloatDialog"> |
---|
232 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SingleFloatDialog</tt><big>(</big><em>parent, title, prompt, value, limits=[0.0, 1.0], format='%.5g'</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SingleFloatDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SingleFloatDialog" title="Permalink to this definition">¶</a></dt> |
---|
233 | <dd><p>Dialog to obtain a single float value from user</p> |
---|
234 | </dd></dl> |
---|
235 | |
---|
236 | <dl class="class"> |
---|
237 | <dt id="GSASIIgrid.SymOpDialog"> |
---|
238 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">SymOpDialog</tt><big>(</big><em>parent</em>, <em>SGData</em>, <em>New=True</em>, <em>ForceUnit=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#SymOpDialog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.SymOpDialog" title="Permalink to this definition">¶</a></dt> |
---|
239 | <dd><p>Class to select a symmetry operator</p> |
---|
240 | </dd></dl> |
---|
241 | |
---|
242 | <dl class="class"> |
---|
243 | <dt id="GSASIIgrid.Table"> |
---|
244 | <em class="property">class </em><tt class="descclassname">GSASIIgrid.</tt><tt class="descname">Table</tt><big>(</big><em>data=</em><span class="optional">[</span><span class="optional">]</span>, <em>rowLabels=None</em>, <em>colLabels=None</em>, <em>types=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#Table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.Table" title="Permalink to this definition">¶</a></dt> |
---|
245 | <dd><p>Basic data table for use with GSgrid</p> |
---|
246 | </dd></dl> |
---|
247 | |
---|
248 | <dl class="function"> |
---|
249 | <dt id="GSASIIgrid.UpdateControls"> |
---|
250 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateControls</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateControls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateControls" title="Permalink to this definition">¶</a></dt> |
---|
251 | <dd><p>Edit overall GSAS-II controls in main Controls data tree entry</p> |
---|
252 | </dd></dl> |
---|
253 | |
---|
254 | <dl class="function"> |
---|
255 | <dt id="GSASIIgrid.UpdateHKLControls"> |
---|
256 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateHKLControls</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateHKLControls"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateHKLControls" title="Permalink to this definition">¶</a></dt> |
---|
257 | <dd><p>Not sure what this does</p> |
---|
258 | </dd></dl> |
---|
259 | |
---|
260 | <dl class="function"> |
---|
261 | <dt id="GSASIIgrid.UpdateNotebook"> |
---|
262 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateNotebook</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateNotebook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateNotebook" title="Permalink to this definition">¶</a></dt> |
---|
263 | <dd><p>Called when the data tree notebook entry is selected. Allows for |
---|
264 | editing of the text in that tree entry</p> |
---|
265 | </dd></dl> |
---|
266 | |
---|
267 | <dl class="function"> |
---|
268 | <dt id="GSASIIgrid.UpdatePWHKPlot"> |
---|
269 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdatePWHKPlot</tt><big>(</big><em>G2frame</em>, <em>kind</em>, <em>item</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdatePWHKPlot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdatePWHKPlot" title="Permalink to this definition">¶</a></dt> |
---|
270 | <dd><p>Not sure what this does</p> |
---|
271 | </dd></dl> |
---|
272 | |
---|
273 | <dl class="function"> |
---|
274 | <dt id="GSASIIgrid.UpdateSeqResults"> |
---|
275 | <tt class="descclassname">GSASIIgrid.</tt><tt class="descname">UpdateSeqResults</tt><big>(</big><em>G2frame</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIgrid.html#UpdateSeqResults"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIgrid.UpdateSeqResults" title="Permalink to this definition">¶</a></dt> |
---|
276 | <dd><p>Called when the Sequential Results data tree entry is selected |
---|
277 | to show results from a sequential refinement.</p> |
---|
278 | <table class="docutils field-list" frame="void" rules="none"> |
---|
279 | <col class="field-name" /> |
---|
280 | <col class="field-body" /> |
---|
281 | <tbody valign="top"> |
---|
282 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
283 | <li><strong>G2frame</strong> (<em>wx.Frame</em>) – main GSAS-II data tree windows</li> |
---|
284 | <li><strong>data</strong> (<em>dict</em>) – <p>a dictionary containing the following items:</p> |
---|
285 | <ul> |
---|
286 | <li>‘histNames’ - list of histogram names in order as processed by Sequential Refinement</li> |
---|
287 | <li>‘varyList’ - list of variables - identical over all refinements in sequence</li> |
---|
288 | <li>‘histName’ - dictionaries for all data sets processed, which contains:<ul> |
---|
289 | <li>‘variables’- result[0] from leastsq call</li> |
---|
290 | <li>‘varyList’ - list of variables; same as above</li> |
---|
291 | <li>‘sig’ - esds for variables</li> |
---|
292 | <li>‘covMatrix’ - covariance matrix from individual refinement</li> |
---|
293 | <li>‘title’ - histogram name; same as dict item name</li> |
---|
294 | <li>‘newAtomDict’ - new atom parameters after shifts applied</li> |
---|
295 | <li>‘newCellDict’ - new cell parameters after shifts to A0-A5 applied’</li> |
---|
296 | </ul> |
---|
297 | </li> |
---|
298 | </ul> |
---|
299 | </li> |
---|
300 | </ul> |
---|
301 | </td> |
---|
302 | </tr> |
---|
303 | </tbody> |
---|
304 | </table> |
---|
305 | </dd></dl> |
---|
306 | |
---|
307 | </div> |
---|
308 | |
---|
309 | |
---|
310 | </div> |
---|
311 | </div> |
---|
312 | </div> |
---|
313 | <div class="sphinxsidebar"> |
---|
314 | <div class="sphinxsidebarwrapper"> |
---|
315 | <h4>Previous topic</h4> |
---|
316 | <p class="topless"><a href="GSASIImapvars.html" |
---|
317 | title="previous chapter"><em>GSASIImapvars: Parameter constraints</em></a></p> |
---|
318 | <h4>Next topic</h4> |
---|
319 | <p class="topless"><a href="GSASIIphsGUI.html" |
---|
320 | title="next chapter"><em>GSASIIphsGUI: Phase GUI</em></a></p> |
---|
321 | <h3>This Page</h3> |
---|
322 | <ul class="this-page-menu"> |
---|
323 | <li><a href="_sources/GSASIIgrid.txt" |
---|
324 | rel="nofollow">Show Source</a></li> |
---|
325 | </ul> |
---|
326 | <div id="searchbox" style="display: none"> |
---|
327 | <h3>Quick search</h3> |
---|
328 | <form class="search" action="search.html" method="get"> |
---|
329 | <input type="text" name="q" /> |
---|
330 | <input type="submit" value="Go" /> |
---|
331 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
332 | <input type="hidden" name="area" value="default" /> |
---|
333 | </form> |
---|
334 | <p class="searchtip" style="font-size: 90%"> |
---|
335 | Enter search terms or a module, class or function name. |
---|
336 | </p> |
---|
337 | </div> |
---|
338 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
339 | </div> |
---|
340 | </div> |
---|
341 | <div class="clearer"></div> |
---|
342 | </div> |
---|
343 | <div class="related"> |
---|
344 | <h3>Navigation</h3> |
---|
345 | <ul> |
---|
346 | <li class="right" style="margin-right: 10px"> |
---|
347 | <a href="genindex.html" title="General Index" |
---|
348 | >index</a></li> |
---|
349 | <li class="right" > |
---|
350 | <a href="py-modindex.html" title="Python Module Index" |
---|
351 | >modules</a> |</li> |
---|
352 | <li class="right" > |
---|
353 | <a href="GSASIIphsGUI.html" title="GSASIIphsGUI: Phase GUI" |
---|
354 | >next</a> |</li> |
---|
355 | <li class="right" > |
---|
356 | <a href="GSASIImapvars.html" title="GSASIImapvars: Parameter constraints" |
---|
357 | >previous</a> |</li> |
---|
358 | <li><a href="index.html">GSAS-II 0.2.0 documentation</a> »</li> |
---|
359 | </ul> |
---|
360 | </div> |
---|
361 | <div class="footer"> |
---|
362 | © Copyright 2013, Von Dreele and Toby for Argonne National Laboratory. |
---|
363 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2. |
---|
364 | </div> |
---|
365 | </body> |
---|
366 | </html> |
---|