source: sphinxdocs/build/html/GSASIIindex.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: 19.1 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>GSASIIindex: Cell Indexing 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="GSASIIplot: plotting routines" href="GSASIIplot.html" />
29    <link rel="prev" title="GSASIImath: computation module" href="GSASIImath.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="GSASIIplot.html" title="GSASIIplot: plotting routines"
43             accesskey="N">next</a> |</li>
44        <li class="right" >
45          <a href="GSASIImath.html" title="GSASIImath: computation 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-GSASIIindex"></span><div class="section" id="gsasiiindex-cell-indexing-module">
57<h1><em>GSASIIindex: Cell Indexing Module</em><a class="headerlink" href="#gsasiiindex-cell-indexing-module" title="Permalink to this headline">¶</a></h1>
58<p>Cell indexing program: variation on that of A. Coehlo
59includes cell refinement from peak positions (not zero as yet)</p>
60<p>This needs a bit of refactoring to remove the little bit of GUI
61code referencing wx</p>
62<dl class="function">
63<dt id="GSASIIindex.A2values">
64<tt class="descclassname">GSASIIindex.</tt><tt class="descname">A2values</tt><big>(</big><em>ibrav</em>, <em>A</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#A2values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.A2values" title="Permalink to this definition">¶</a></dt>
65<dd><p>needs a doc string</p>
66</dd></dl>
67
68<dl class="function">
69<dt id="GSASIIindex.DoIndexPeaks">
70<tt class="descclassname">GSASIIindex.</tt><tt class="descname">DoIndexPeaks</tt><big>(</big><em>peaks</em>, <em>controls</em>, <em>bravais</em>, <em>ifX20=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#DoIndexPeaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.DoIndexPeaks" title="Permalink to this definition">¶</a></dt>
71<dd><p>needs a doc string</p>
72</dd></dl>
73
74<dl class="function">
75<dt id="GSASIIindex.FitHKL">
76<tt class="descclassname">GSASIIindex.</tt><tt class="descname">FitHKL</tt><big>(</big><em>ibrav</em>, <em>peaks</em>, <em>A</em>, <em>Pwr</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#FitHKL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.FitHKL" title="Permalink to this definition">¶</a></dt>
77<dd><p>needs a doc string</p>
78</dd></dl>
79
80<dl class="function">
81<dt id="GSASIIindex.FitHKLT">
82<tt class="descclassname">GSASIIindex.</tt><tt class="descname">FitHKLT</tt><big>(</big><em>difC</em>, <em>ibrav</em>, <em>peaks</em>, <em>A</em>, <em>Z</em>, <em>Zref</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#FitHKLT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.FitHKLT" title="Permalink to this definition">¶</a></dt>
83<dd><p>needs a doc string</p>
84</dd></dl>
85
86<dl class="function">
87<dt id="GSASIIindex.FitHKLZ">
88<tt class="descclassname">GSASIIindex.</tt><tt class="descname">FitHKLZ</tt><big>(</big><em>wave</em>, <em>ibrav</em>, <em>peaks</em>, <em>A</em>, <em>Z</em>, <em>Zref</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#FitHKLZ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.FitHKLZ" title="Permalink to this definition">¶</a></dt>
89<dd><p>needs a doc string</p>
90</dd></dl>
91
92<dl class="function">
93<dt id="GSASIIindex.FitHKLZSS">
94<tt class="descclassname">GSASIIindex.</tt><tt class="descname">FitHKLZSS</tt><big>(</big><em>wave</em>, <em>ibrav</em>, <em>peaks</em>, <em>A</em>, <em>V</em>, <em>Vref</em>, <em>Z</em>, <em>Zref</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#FitHKLZSS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.FitHKLZSS" title="Permalink to this definition">¶</a></dt>
95<dd><p>needs a doc string</p>
96</dd></dl>
97
98<dl class="function">
99<dt id="GSASIIindex.IndexPeaks">
100<tt class="descclassname">GSASIIindex.</tt><tt class="descname">IndexPeaks</tt><big>(</big><em>peaks</em>, <em>HKL</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#IndexPeaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.IndexPeaks" title="Permalink to this definition">¶</a></dt>
101<dd><p>needs a doc string</p>
102</dd></dl>
103
104<dl class="function">
105<dt id="GSASIIindex.IndexSSPeaks">
106<tt class="descclassname">GSASIIindex.</tt><tt class="descname">IndexSSPeaks</tt><big>(</big><em>peaks</em>, <em>HKL</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#IndexSSPeaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.IndexSSPeaks" title="Permalink to this definition">¶</a></dt>
107<dd><p>needs a doc string</p>
108</dd></dl>
109
110<dl class="function">
111<dt id="GSASIIindex.TestData">
112<tt class="descclassname">GSASIIindex.</tt><tt class="descname">TestData</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#TestData"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.TestData" title="Permalink to this definition">¶</a></dt>
113<dd><p>needs a doc string</p>
114</dd></dl>
115
116<dl class="function">
117<dt id="GSASIIindex.Values2A">
118<tt class="descclassname">GSASIIindex.</tt><tt class="descname">Values2A</tt><big>(</big><em>ibrav</em>, <em>values</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#Values2A"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.Values2A" title="Permalink to this definition">¶</a></dt>
119<dd><p>needs a doc string</p>
120</dd></dl>
121
122<dl class="function">
123<dt id="GSASIIindex.calc_M20">
124<tt class="descclassname">GSASIIindex.</tt><tt class="descname">calc_M20</tt><big>(</big><em>peaks</em>, <em>HKL</em>, <em>ifX20=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#calc_M20"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.calc_M20" title="Permalink to this definition">¶</a></dt>
125<dd><p>needs a doc string</p>
126</dd></dl>
127
128<dl class="function">
129<dt id="GSASIIindex.calc_M20SS">
130<tt class="descclassname">GSASIIindex.</tt><tt class="descname">calc_M20SS</tt><big>(</big><em>peaks</em>, <em>HKL</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#calc_M20SS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.calc_M20SS" title="Permalink to this definition">¶</a></dt>
131<dd><p>needs a doc string</p>
132</dd></dl>
133
134<dl class="function">
135<dt id="GSASIIindex.findBestCell">
136<tt class="descclassname">GSASIIindex.</tt><tt class="descname">findBestCell</tt><big>(</big><em>dlg</em>, <em>ncMax</em>, <em>A</em>, <em>Ntries</em>, <em>ibrav</em>, <em>peaks</em>, <em>V1</em>, <em>ifX20=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#findBestCell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.findBestCell" title="Permalink to this definition">¶</a></dt>
137<dd><p>needs a doc string</p>
138</dd></dl>
139
140<dl class="function">
141<dt id="GSASIIindex.getDmax">
142<tt class="descclassname">GSASIIindex.</tt><tt class="descname">getDmax</tt><big>(</big><em>peaks</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#getDmax"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.getDmax" title="Permalink to this definition">¶</a></dt>
143<dd><p>needs a doc string</p>
144</dd></dl>
145
146<dl class="function">
147<dt id="GSASIIindex.getDmin">
148<tt class="descclassname">GSASIIindex.</tt><tt class="descname">getDmin</tt><big>(</big><em>peaks</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#getDmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.getDmin" title="Permalink to this definition">¶</a></dt>
149<dd><p>needs a doc string</p>
150</dd></dl>
151
152<dl class="function">
153<dt id="GSASIIindex.halfCell">
154<tt class="descclassname">GSASIIindex.</tt><tt class="descname">halfCell</tt><big>(</big><em>ibrav</em>, <em>A</em>, <em>peaks</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#halfCell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.halfCell" title="Permalink to this definition">¶</a></dt>
155<dd><p>needs a doc string</p>
156</dd></dl>
157
158<dl class="function">
159<dt id="GSASIIindex.monoCellReduce">
160<tt class="descclassname">GSASIIindex.</tt><tt class="descname">monoCellReduce</tt><big>(</big><em>ibrav</em>, <em>A</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#monoCellReduce"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.monoCellReduce" title="Permalink to this definition">¶</a></dt>
161<dd><p>needs a doc string</p>
162</dd></dl>
163
164<dl class="function">
165<dt id="GSASIIindex.oddPeak">
166<tt class="descclassname">GSASIIindex.</tt><tt class="descname">oddPeak</tt><big>(</big><em>indx</em>, <em>peaks</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#oddPeak"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.oddPeak" title="Permalink to this definition">¶</a></dt>
167<dd><p>needs a doc string</p>
168</dd></dl>
169
170<dl class="function">
171<dt id="GSASIIindex.ran2axis">
172<tt class="descclassname">GSASIIindex.</tt><tt class="descname">ran2axis</tt><big>(</big><em>k</em>, <em>N</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#ran2axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.ran2axis" title="Permalink to this definition">¶</a></dt>
173<dd><p>needs a doc string</p>
174</dd></dl>
175
176<dl class="function">
177<dt id="GSASIIindex.ranAbyR">
178<tt class="descclassname">GSASIIindex.</tt><tt class="descname">ranAbyR</tt><big>(</big><em>Bravais</em>, <em>A</em>, <em>k</em>, <em>N</em>, <em>ranFunc</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#ranAbyR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.ranAbyR" title="Permalink to this definition">¶</a></dt>
179<dd><p>needs a doc string</p>
180</dd></dl>
181
182<dl class="function">
183<dt id="GSASIIindex.ranAbyV">
184<tt class="descclassname">GSASIIindex.</tt><tt class="descname">ranAbyV</tt><big>(</big><em>Bravais</em>, <em>dmin</em>, <em>dmax</em>, <em>V</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#ranAbyV"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.ranAbyV" title="Permalink to this definition">¶</a></dt>
185<dd><p>needs a doc string</p>
186</dd></dl>
187
188<dl class="function">
189<dt id="GSASIIindex.ranaxis">
190<tt class="descclassname">GSASIIindex.</tt><tt class="descname">ranaxis</tt><big>(</big><em>dmin</em>, <em>dmax</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#ranaxis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.ranaxis" title="Permalink to this definition">¶</a></dt>
191<dd><p>needs a doc string</p>
192</dd></dl>
193
194<dl class="function">
195<dt id="GSASIIindex.rancell">
196<tt class="descclassname">GSASIIindex.</tt><tt class="descname">rancell</tt><big>(</big><em>Bravais</em>, <em>dmin</em>, <em>dmax</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#rancell"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.rancell" title="Permalink to this definition">¶</a></dt>
197<dd><p>needs a doc string</p>
198</dd></dl>
199
200<dl class="function">
201<dt id="GSASIIindex.refinePeaks">
202<tt class="descclassname">GSASIIindex.</tt><tt class="descname">refinePeaks</tt><big>(</big><em>peaks</em>, <em>ibrav</em>, <em>A</em>, <em>ifX20=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#refinePeaks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.refinePeaks" title="Permalink to this definition">¶</a></dt>
203<dd><p>needs a doc string</p>
204</dd></dl>
205
206<dl class="function">
207<dt id="GSASIIindex.refinePeaksT">
208<tt class="descclassname">GSASIIindex.</tt><tt class="descname">refinePeaksT</tt><big>(</big><em>peaks</em>, <em>difC</em>, <em>ibrav</em>, <em>A</em>, <em>Zero</em>, <em>ZeroRef</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#refinePeaksT"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.refinePeaksT" title="Permalink to this definition">¶</a></dt>
209<dd><p>needs a doc string</p>
210</dd></dl>
211
212<dl class="function">
213<dt id="GSASIIindex.refinePeaksZ">
214<tt class="descclassname">GSASIIindex.</tt><tt class="descname">refinePeaksZ</tt><big>(</big><em>peaks</em>, <em>wave</em>, <em>ibrav</em>, <em>A</em>, <em>Zero</em>, <em>ZeroRef</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#refinePeaksZ"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.refinePeaksZ" title="Permalink to this definition">¶</a></dt>
215<dd><p>needs a doc string</p>
216</dd></dl>
217
218<dl class="function">
219<dt id="GSASIIindex.refinePeaksZSS">
220<tt class="descclassname">GSASIIindex.</tt><tt class="descname">refinePeaksZSS</tt><big>(</big><em>peaks</em>, <em>wave</em>, <em>Inst</em>, <em>SGData</em>, <em>SSGData</em>, <em>maxH</em>, <em>ibrav</em>, <em>A</em>, <em>vec</em>, <em>vecRef</em>, <em>Zero</em>, <em>ZeroRef</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#refinePeaksZSS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.refinePeaksZSS" title="Permalink to this definition">¶</a></dt>
221<dd><p>needs a doc string</p>
222</dd></dl>
223
224<dl class="function">
225<dt id="GSASIIindex.rotOrthoA">
226<tt class="descclassname">GSASIIindex.</tt><tt class="descname">rotOrthoA</tt><big>(</big><em>A</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#rotOrthoA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.rotOrthoA" title="Permalink to this definition">¶</a></dt>
227<dd><p>needs a doc string</p>
228</dd></dl>
229
230<dl class="function">
231<dt id="GSASIIindex.scaleAbyV">
232<tt class="descclassname">GSASIIindex.</tt><tt class="descname">scaleAbyV</tt><big>(</big><em>A</em>, <em>V</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#scaleAbyV"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.scaleAbyV" title="Permalink to this definition">¶</a></dt>
233<dd><p>needs a doc string</p>
234</dd></dl>
235
236<dl class="function">
237<dt id="GSASIIindex.sortM20">
238<tt class="descclassname">GSASIIindex.</tt><tt class="descname">sortM20</tt><big>(</big><em>cells</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#sortM20"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.sortM20" title="Permalink to this definition">¶</a></dt>
239<dd><p>needs a doc string</p>
240</dd></dl>
241
242<dl class="function">
243<dt id="GSASIIindex.swapMonoA">
244<tt class="descclassname">GSASIIindex.</tt><tt class="descname">swapMonoA</tt><big>(</big><em>A</em><big>)</big><a class="reference internal" href="_modules/GSASIIindex.html#swapMonoA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIindex.swapMonoA" title="Permalink to this definition">¶</a></dt>
245<dd><p>needs a doc string</p>
246</dd></dl>
247
248</div>
249
250
251          </div>
252        </div>
253      </div>
254      <div class="sphinxsidebar">
255        <div class="sphinxsidebarwrapper">
256            <p class="logo"><a href="index.html">
257              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
258            </a></p>
259  <h4>Previous topic</h4>
260  <p class="topless"><a href="GSASIImath.html"
261                        title="previous chapter"><em>GSASIImath: computation module</em></a></p>
262  <h4>Next topic</h4>
263  <p class="topless"><a href="GSASIIplot.html"
264                        title="next chapter"><em>GSASIIplot: plotting routines</em></a></p>
265  <h3>This Page</h3>
266  <ul class="this-page-menu">
267    <li><a href="_sources/GSASIIindex.txt"
268           rel="nofollow">Show Source</a></li>
269  </ul>
270<div id="searchbox" style="display: none">
271  <h3>Quick search</h3>
272    <form class="search" action="search.html" method="get">
273      <input type="text" name="q" />
274      <input type="submit" value="Go" />
275      <input type="hidden" name="check_keywords" value="yes" />
276      <input type="hidden" name="area" value="default" />
277    </form>
278    <p class="searchtip" style="font-size: 90%">
279    Enter search terms or a module, class or function name.
280    </p>
281</div>
282<script type="text/javascript">$('#searchbox').show(0);</script>
283        </div>
284      </div>
285      <div class="clearer"></div>
286    </div>
287    <div class="related">
288      <h3>Navigation</h3>
289      <ul>
290        <li class="right" style="margin-right: 10px">
291          <a href="genindex.html" title="General Index"
292             >index</a></li>
293        <li class="right" >
294          <a href="py-modindex.html" title="Python Module Index"
295             >modules</a> |</li>
296        <li class="right" >
297          <a href="GSASIIplot.html" title="GSASIIplot: plotting routines"
298             >next</a> |</li>
299        <li class="right" >
300          <a href="GSASIImath.html" title="GSASIImath: computation module"
301             >previous</a> |</li>
302        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
303      </ul>
304    </div>
305    <div class="footer">
306        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
307      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
308    </div>
309  </body>
310</html>
Note: See TracBrowser for help on using the repository browser.