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

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

change sphinx docs links; rebuild & fixing minor formatting
  • Property svn:mime-type set to text/html
File size: 27.5 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>GSASIIplot: plotting routines &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="GSASII powder calculation module" href="GSASIIpwd.html" />
29    <link rel="prev" title="GSASIIindex: Cell Indexing Module" href="GSASIIindex.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="GSASIIpwd.html" title="GSASII powder calculation module"
43             accesskey="N">next</a> |</li>
44        <li class="right" >
45          <a href="GSASIIindex.html" title="GSASIIindex: Cell Indexing Module"
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-GSASIIplot"></span><div class="section" id="gsasiiplot-plotting-routines">
57<h1><em>GSASIIplot: plotting routines</em><a class="headerlink" href="#gsasiiplot-plotting-routines" title="Permalink to this headline">¶</a></h1>
58<dl class="class">
59<dt id="GSASIIplot.G2Plot3D">
60<em class="property">class </em><tt class="descclassname">GSASIIplot.</tt><tt class="descname">G2Plot3D</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>dpi=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2Plot3D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2Plot3D" title="Permalink to this definition">¶</a></dt>
61<dd><p>needs a doc string</p>
62</dd></dl>
63
64<dl class="class">
65<dt id="GSASIIplot.G2PlotMpl">
66<em class="property">class </em><tt class="descclassname">GSASIIplot.</tt><tt class="descname">G2PlotMpl</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>dpi=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotMpl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotMpl" title="Permalink to this definition">¶</a></dt>
67<dd><p>needs a doc string</p>
68</dd></dl>
69
70<dl class="class">
71<dt id="GSASIIplot.G2PlotNoteBook">
72<em class="property">class </em><tt class="descclassname">GSASIIplot.</tt><tt class="descname">G2PlotNoteBook</tt><big>(</big><em>parent</em>, <em>id=-1</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook" title="Permalink to this definition">¶</a></dt>
73<dd><p>create a tabbed window for plotting</p>
74<dl class="method">
75<dt id="GSASIIplot.G2PlotNoteBook.Delete">
76<tt class="descname">Delete</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.Delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.Delete" title="Permalink to this definition">¶</a></dt>
77<dd><p>delete a tabbed page</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="GSASIIplot.G2PlotNoteBook.OnNotebookKey">
82<tt class="descname">OnNotebookKey</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.OnNotebookKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.OnNotebookKey" title="Permalink to this definition">¶</a></dt>
83<dd><p>Called when a keystroke event gets picked up by the notebook window
84rather the child. This is not expected, but somehow it does sometimes
85on the Mac and perhaps Linux.</p>
86<p>Assume that the page associated with the currently displayed tab
87has a child, .canvas; give that child the focus and pass it the event.</p>
88</dd></dl>
89
90<dl class="method">
91<dt id="GSASIIplot.G2PlotNoteBook.OnPageChanged">
92<tt class="descname">OnPageChanged</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.OnPageChanged"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.OnPageChanged" title="Permalink to this definition">¶</a></dt>
93<dd><p>respond to someone pressing a tab on the plot window</p>
94</dd></dl>
95
96<dl class="method">
97<dt id="GSASIIplot.G2PlotNoteBook.Rename">
98<tt class="descname">Rename</tt><big>(</big><em>oldName</em>, <em>newName</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.Rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.Rename" title="Permalink to this definition">¶</a></dt>
99<dd><p>rename a tab</p>
100</dd></dl>
101
102<dl class="method">
103<dt id="GSASIIplot.G2PlotNoteBook.add3D">
104<tt class="descname">add3D</tt><big>(</big><em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.add3D"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.add3D" title="Permalink to this definition">¶</a></dt>
105<dd><p>Add a tabbed page with a 3D plot</p>
106</dd></dl>
107
108<dl class="method">
109<dt id="GSASIIplot.G2PlotNoteBook.addMpl">
110<tt class="descname">addMpl</tt><big>(</big><em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.addMpl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.addMpl" title="Permalink to this definition">¶</a></dt>
111<dd><p>Add a tabbed page with a matplotlib plot</p>
112</dd></dl>
113
114<dl class="method">
115<dt id="GSASIIplot.G2PlotNoteBook.addOgl">
116<tt class="descname">addOgl</tt><big>(</big><em>name=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.addOgl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.addOgl" title="Permalink to this definition">¶</a></dt>
117<dd><p>Add a tabbed page with an openGL plot</p>
118</dd></dl>
119
120<dl class="method">
121<dt id="GSASIIplot.G2PlotNoteBook.clear">
122<tt class="descname">clear</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotNoteBook.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotNoteBook.clear" title="Permalink to this definition">¶</a></dt>
123<dd><p>clear all pages from plot window</p>
124</dd></dl>
125
126</dd></dl>
127
128<dl class="class">
129<dt id="GSASIIplot.G2PlotOgl">
130<em class="property">class </em><tt class="descclassname">GSASIIplot.</tt><tt class="descname">G2PlotOgl</tt><big>(</big><em>parent</em>, <em>id=-1</em>, <em>dpi=None</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#G2PlotOgl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.G2PlotOgl" title="Permalink to this definition">¶</a></dt>
131<dd><p>needs a doc string</p>
132</dd></dl>
133
134<dl class="class">
135<dt id="GSASIIplot.GSASIItoolbar">
136<em class="property">class </em><tt class="descclassname">GSASIIplot.</tt><tt class="descname">GSASIItoolbar</tt><big>(</big><em>plotCanvas</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#GSASIItoolbar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.GSASIItoolbar" title="Permalink to this definition">¶</a></dt>
137<dd><p>Override the matplotlib toolbar so we can add more icons</p>
138<dl class="method">
139<dt id="GSASIIplot.GSASIItoolbar.OnArrow">
140<tt class="descname">OnArrow</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#GSASIItoolbar.OnArrow"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.GSASIItoolbar.OnArrow" title="Permalink to this definition">¶</a></dt>
141<dd><p>reposition limits to scan or zoom by button press</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="GSASIIplot.GSASIItoolbar.OnHelp">
146<tt class="descname">OnHelp</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#GSASIItoolbar.OnHelp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.GSASIItoolbar.OnHelp" title="Permalink to this definition">¶</a></dt>
147<dd><p>Respond to press of help button on plot toolbar</p>
148</dd></dl>
149
150<dl class="method">
151<dt id="GSASIIplot.GSASIItoolbar.OnKey">
152<tt class="descname">OnKey</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#GSASIItoolbar.OnKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.GSASIItoolbar.OnKey" title="Permalink to this definition">¶</a></dt>
153<dd><p>Provide user with list of keystrokes defined for plot as well as an
154alternate way to access the same functionality</p>
155</dd></dl>
156
157</dd></dl>
158
159<dl class="function">
160<dt id="GSASIIplot.OnStartMask">
161<tt class="descclassname">GSASIIplot.</tt><tt class="descname">OnStartMask</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#OnStartMask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.OnStartMask" title="Permalink to this definition">¶</a></dt>
162<dd><p>Initiate the start of a Frame or Polygon map</p>
163<table class="docutils field-list" frame="void" rules="none">
164<col class="field-name" />
165<col class="field-body" />
166<tbody valign="top">
167<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
168<li><strong>G2frame</strong> (<em>wx.Frame</em>) &#8211; The main GSAS-II tree &#8220;window&#8221;</li>
169<li><strong>eventkey</strong> (<em>str</em>) &#8211; a single letter (&#8216;f&#8217; or &#8216;p&#8217;) that
170determines what type of mask is created.</li>
171</ul>
172</td>
173</tr>
174</tbody>
175</table>
176</dd></dl>
177
178<dl class="function">
179<dt id="GSASIIplot.OnStartNewDzero">
180<tt class="descclassname">GSASIIplot.</tt><tt class="descname">OnStartNewDzero</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#OnStartNewDzero"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.OnStartNewDzero" title="Permalink to this definition">¶</a></dt>
181<dd><p>Initiate the start of adding a new d-zero to a strain data set</p>
182<table class="docutils field-list" frame="void" rules="none">
183<col class="field-name" />
184<col class="field-body" />
185<tbody valign="top">
186<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
187<li><strong>G2frame</strong> (<em>wx.Frame</em>) &#8211; The main GSAS-II tree &#8220;window&#8221;</li>
188<li><strong>eventkey</strong> (<em>str</em>) &#8211; a single letter (&#8216;a&#8217;) that
189triggers the addition of a d-zero.</li>
190</ul>
191</td>
192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="function">
198<dt id="GSASIIplot.Plot3DSngl">
199<tt class="descclassname">GSASIIplot.</tt><tt class="descname">Plot3DSngl</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>Data=None</em>, <em>hklRef=None</em>, <em>Title=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#Plot3DSngl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.Plot3DSngl" title="Permalink to this definition">¶</a></dt>
200<dd><p>3D Structure factor plotting package - displays reflections as rings proportional
201to F, F**2, etc. as requested as 3D array</p>
202</dd></dl>
203
204<dl class="function">
205<dt id="GSASIIplot.PlotCalib">
206<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotCalib</tt><big>(</big><em>G2frame</em>, <em>Inst</em>, <em>XY</em>, <em>Sigs</em>, <em>newPlot=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotCalib"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotCalib" title="Permalink to this definition">¶</a></dt>
207<dd><p>plot of CW or TOF peak calibration</p>
208</dd></dl>
209
210<dl class="function">
211<dt id="GSASIIplot.PlotCovariance">
212<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotCovariance</tt><big>(</big><em>G2frame</em>, <em>Data</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotCovariance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotCovariance" title="Permalink to this definition">¶</a></dt>
213<dd><p>needs a doc string</p>
214</dd></dl>
215
216<dl class="function">
217<dt id="GSASIIplot.PlotDeltSig">
218<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotDeltSig</tt><big>(</big><em>G2frame</em>, <em>kind</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotDeltSig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotDeltSig" title="Permalink to this definition">¶</a></dt>
219<dd><p>needs a doc string</p>
220</dd></dl>
221
222<dl class="function">
223<dt id="GSASIIplot.PlotExposedImage">
224<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotExposedImage</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>event=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotExposedImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotExposedImage" title="Permalink to this definition">¶</a></dt>
225<dd><p>General access module for 2D image plotting</p>
226</dd></dl>
227
228<dl class="function">
229<dt id="GSASIIplot.PlotISFG">
230<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotISFG</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>type=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotISFG"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotISFG" title="Permalink to this definition">¶</a></dt>
231<dd><p>Plotting package for PDF analysis; displays I(q), S(q), F(q) and G(r) as single
232or multiple plots with waterfall and contour plots as options</p>
233</dd></dl>
234
235<dl class="function">
236<dt id="GSASIIplot.PlotImage">
237<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotImage</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>event=None</em>, <em>newImage=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotImage" title="Permalink to this definition">¶</a></dt>
238<dd><p>Plot of 2D detector images as contoured plot. Also plot calibration ellipses,
239masks, etc.</p>
240</dd></dl>
241
242<dl class="function">
243<dt id="GSASIIplot.PlotIntegration">
244<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotIntegration</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>event=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotIntegration"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotIntegration" title="Permalink to this definition">¶</a></dt>
245<dd><p>Plot of 2D image after image integration with 2-theta and azimuth as coordinates</p>
246</dd></dl>
247
248<dl class="function">
249<dt id="GSASIIplot.PlotPatterns">
250<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotPatterns</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>plotType='PWDR'</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotPatterns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotPatterns" title="Permalink to this definition">¶</a></dt>
251<dd><p>Powder pattern plotting package - displays single or multiple powder patterns as intensity vs
2522-theta, q or TOF. Can display multiple patterns as &#8220;waterfall plots&#8221; or contour plots. Log I
253plotting available.</p>
254</dd></dl>
255
256<dl class="function">
257<dt id="GSASIIplot.PlotPeakWidths">
258<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotPeakWidths</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotPeakWidths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotPeakWidths" title="Permalink to this definition">¶</a></dt>
259<dd><p>Plotting of instrument broadening terms as function of 2-theta
260Seen when &#8220;Instrument Parameters&#8221; chosen from powder pattern data tree</p>
261</dd></dl>
262
263<dl class="function">
264<dt id="GSASIIplot.PlotPowderLines">
265<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotPowderLines</tt><big>(</big><em>G2frame</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotPowderLines"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotPowderLines" title="Permalink to this definition">¶</a></dt>
266<dd><p>plotting of powder lines (i.e. no powder pattern) as sticks</p>
267</dd></dl>
268
269<dl class="function">
270<dt id="GSASIIplot.PlotRama">
271<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotRama</tt><big>(</big><em>G2frame</em>, <em>phaseName</em>, <em>Rama</em>, <em>RamaName</em>, <em>Names=</em>, <span class="optional">[</span><span class="optional">]</span><em>PhiPsi=</em>, <span class="optional">[</span><span class="optional">]</span><em>Coeff=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotRama"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotRama" title="Permalink to this definition">¶</a></dt>
272<dd><p>needs a doc string</p>
273</dd></dl>
274
275<dl class="function">
276<dt id="GSASIIplot.PlotRigidBody">
277<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotRigidBody</tt><big>(</big><em>G2frame</em>, <em>rbType</em>, <em>AtInfo</em>, <em>rbData</em>, <em>defaults</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotRigidBody"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotRigidBody" title="Permalink to this definition">¶</a></dt>
278<dd><p>RB plotting package. Can show rigid body structures as balls &amp; sticks</p>
279</dd></dl>
280
281<dl class="function">
282<dt id="GSASIIplot.PlotSelectedSequence">
283<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotSelectedSequence</tt><big>(</big><em>G2frame</em>, <em>ColumnList</em>, <em>TableGet</em>, <em>SelectX</em>, <em>fitnum=None</em>, <em>fitvals=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotSelectedSequence"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotSelectedSequence" title="Permalink to this definition">¶</a></dt>
284<dd><p>Plot a result from a sequential refinement</p>
285<table class="docutils field-list" frame="void" rules="none">
286<col class="field-name" />
287<col class="field-body" />
288<tbody valign="top">
289<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
290<li><strong>G2frame</strong> (<em>wx.Frame</em>) &#8211; The main GSAS-II tree &#8220;window&#8221;</li>
291<li><strong>ColumnList</strong> (<em>list</em>) &#8211; list of int values corresponding to columns
292selected as y values</li>
293<li><strong>TableGet</strong> (<em>function</em>) &#8211; a function that takes a column number
294as argument and returns the column label, the values and there ESDs (or None)</li>
295<li><strong>SelectX</strong> (<em>function</em>) &#8211; a function that returns a selected column
296number (or None) as the X-axis selection</li>
297</ul>
298</td>
299</tr>
300</tbody>
301</table>
302</dd></dl>
303
304<dl class="function">
305<dt id="GSASIIplot.PlotSizeStrainPO">
306<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotSizeStrainPO</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>Start=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotSizeStrainPO"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotSizeStrainPO" title="Permalink to this definition">¶</a></dt>
307<dd><p>Plot 3D mustrain/size/preferred orientation figure. In this instance data is for a phase</p>
308</dd></dl>
309
310<dl class="function">
311<dt id="GSASIIplot.PlotSngl">
312<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotSngl</tt><big>(</big><em>G2frame</em>, <em>newPlot=False</em>, <em>Data=None</em>, <em>hklRef=None</em>, <em>Title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotSngl"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotSngl" title="Permalink to this definition">¶</a></dt>
313<dd><p>Structure factor plotting package - displays zone of reflections as rings proportional
314to F, F**2, etc. as requested</p>
315</dd></dl>
316
317<dl class="function">
318<dt id="GSASIIplot.PlotStrain">
319<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotStrain</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>newPlot=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotStrain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotStrain" title="Permalink to this definition">¶</a></dt>
320<dd><p>plot of strain data, used for diagnostic purposes</p>
321</dd></dl>
322
323<dl class="function">
324<dt id="GSASIIplot.PlotStructure">
325<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotStructure</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>firstCall=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotStructure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotStructure" title="Permalink to this definition">¶</a></dt>
326<dd><p>Crystal structure plotting package. Can show structures as balls, sticks, lines,
327thermal motion ellipsoids and polyhedra</p>
328</dd></dl>
329
330<dl class="function">
331<dt id="GSASIIplot.PlotTRImage">
332<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotTRImage</tt><big>(</big><em>G2frame</em>, <em>tax</em>, <em>tay</em>, <em>taz</em>, <em>newPlot=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotTRImage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotTRImage" title="Permalink to this definition">¶</a></dt>
333<dd><p>a test plot routine - not normally used</p>
334</dd></dl>
335
336<dl class="function">
337<dt id="GSASIIplot.PlotTexture">
338<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotTexture</tt><big>(</big><em>G2frame</em>, <em>data</em>, <em>Start=False</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotTexture"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotTexture" title="Permalink to this definition">¶</a></dt>
339<dd><p>Pole figure, inverse pole figure, 3D pole distribution and 3D inverse pole distribution
340plotting.
341dict generalData contains all phase info needed which is in data</p>
342</dd></dl>
343
344<dl class="function">
345<dt id="GSASIIplot.PlotTorsion">
346<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotTorsion</tt><big>(</big><em>G2frame</em>, <em>phaseName</em>, <em>Torsion</em>, <em>TorName</em>, <em>Names=</em>, <span class="optional">[</span><span class="optional">]</span><em>Angles=</em>, <span class="optional">[</span><span class="optional">]</span><em>Coeff=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotTorsion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotTorsion" title="Permalink to this definition">¶</a></dt>
347<dd><p>needs a doc string</p>
348</dd></dl>
349
350<dl class="function">
351<dt id="GSASIIplot.PlotXY">
352<tt class="descclassname">GSASIIplot.</tt><tt class="descname">PlotXY</tt><big>(</big><em>G2frame</em>, <em>XY</em>, <em>XY2=None</em>, <em>labelX=None</em>, <em>labelY=None</em>, <em>newPlot=False</em>, <em>Title=''</em><big>)</big><a class="reference internal" href="_modules/GSASIIplot.html#PlotXY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIplot.PlotXY" title="Permalink to this definition">¶</a></dt>
353<dd><p>simple plot of xy data, used for diagnostic purposes</p>
354</dd></dl>
355
356</div>
357
358
359          </div>
360        </div>
361      </div>
362      <div class="sphinxsidebar">
363        <div class="sphinxsidebarwrapper">
364            <p class="logo"><a href="index.html">
365              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
366            </a></p>
367  <h4>Previous topic</h4>
368  <p class="topless"><a href="GSASIIindex.html"
369                        title="previous chapter"><em>GSASIIindex: Cell Indexing Module</em></a></p>
370  <h4>Next topic</h4>
371  <p class="topless"><a href="GSASIIpwd.html"
372                        title="next chapter"><em>GSASII powder calculation module</em></a></p>
373  <h3>This Page</h3>
374  <ul class="this-page-menu">
375    <li><a href="_sources/GSASIIplot.txt"
376           rel="nofollow">Show Source</a></li>
377  </ul>
378<div id="searchbox" style="display: none">
379  <h3>Quick search</h3>
380    <form class="search" action="search.html" method="get">
381      <input type="text" name="q" />
382      <input type="submit" value="Go" />
383      <input type="hidden" name="check_keywords" value="yes" />
384      <input type="hidden" name="area" value="default" />
385    </form>
386    <p class="searchtip" style="font-size: 90%">
387    Enter search terms or a module, class or function name.
388    </p>
389</div>
390<script type="text/javascript">$('#searchbox').show(0);</script>
391        </div>
392      </div>
393      <div class="clearer"></div>
394    </div>
395    <div class="related">
396      <h3>Navigation</h3>
397      <ul>
398        <li class="right" style="margin-right: 10px">
399          <a href="genindex.html" title="General Index"
400             >index</a></li>
401        <li class="right" >
402          <a href="py-modindex.html" title="Python Module Index"
403             >modules</a> |</li>
404        <li class="right" >
405          <a href="GSASIIpwd.html" title="GSASII powder calculation module"
406             >next</a> |</li>
407        <li class="right" >
408          <a href="GSASIIindex.html" title="GSASIIindex: Cell Indexing Module"
409             >previous</a> |</li>
410        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
411      </ul>
412    </div>
413    <div class="footer">
414        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
415      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
416    </div>
417  </body>
418</html>
Note: See TracBrowser for help on using the repository browser.