source: trunk/sphinxdocs/build/html/GSASIIimage.html @ 1183

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

fixup number formatting; update produced doc files
  • Property svn:mime-type set to text/html
File size: 19.3 KB
Line 
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>GSASIIimage: Image calc module &mdash; 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    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29    <link rel="top" title="GSAS-II 0.2.0 documentation" href="index.html" />
30    <link rel="next" title="GSASIImath: computation module" href="GSASIImath.html" />
31    <link rel="prev" title="GSASIImapvars: Parameter constraints" href="GSASIImapvars.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="GSASIImath.html" title="GSASIImath: computation module"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="GSASIImapvars.html" title="GSASIImapvars: Parameter constraints"
48             accesskey="P">previous</a> |</li>
49        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
50      </ul>
51    </div> 
52
53    <div class="document">
54      <div class="documentwrapper">
55        <div class="bodywrapper">
56          <div class="body">
57           
58  <span class="target" id="module-GSASIIimage"></span><div class="section" id="gsasiiimage-image-calc-module">
59<h1><em>GSASIIimage: Image calc module</em><a class="headerlink" href="#gsasiiimage-image-calc-module" title="Permalink to this headline">¶</a></h1>
60<p>Ellipse fitting &amp; image integration</p>
61<dl class="function">
62<dt id="GSASIIimage.EdgeFinder">
63<tt class="descclassname">GSASIIimage.</tt><tt class="descname">EdgeFinder</tt><big>(</big><em>image</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#EdgeFinder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.EdgeFinder" title="Permalink to this definition">¶</a></dt>
64<dd><p>this makes list of all x,y where I&gt;edgeMin suitable for an ellipse search?
65Not currently used but might be useful in future?</p>
66</dd></dl>
67
68<dl class="function">
69<dt id="GSASIIimage.Fill2ThetaAzimuthMap">
70<tt class="descclassname">GSASIIimage.</tt><tt class="descname">Fill2ThetaAzimuthMap</tt><big>(</big><em>masks</em>, <em>TA</em>, <em>tam</em>, <em>image</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#Fill2ThetaAzimuthMap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.Fill2ThetaAzimuthMap" 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="GSASIIimage.FitDetector">
76<tt class="descclassname">GSASIIimage.</tt><tt class="descname">FitDetector</tt><big>(</big><em>rings</em>, <em>varyList</em>, <em>parmDict</em>, <em>Print=True</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#FitDetector"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.FitDetector" 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="GSASIIimage.FitStrSta">
82<tt class="descclassname">GSASIIimage.</tt><tt class="descname">FitStrSta</tt><big>(</big><em>Image</em>, <em>StrSta</em>, <em>Controls</em>, <em>Masks</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#FitStrSta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.FitStrSta" 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="GSASIIimage.FitStrain">
88<tt class="descclassname">GSASIIimage.</tt><tt class="descname">FitStrain</tt><big>(</big><em>rings</em>, <em>p0</em>, <em>wave</em>, <em>phi</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#FitStrain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.FitStrain" 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="GSASIIimage.GetAzm">
94<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetAzm</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetAzm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetAzm" title="Permalink to this definition">¶</a></dt>
95<dd><p>Give azimuth value for detector x,y position; calibration info in data</p>
96</dd></dl>
97
98<dl class="function">
99<dt id="GSASIIimage.GetDetXYfromThAzm">
100<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetDetXYfromThAzm</tt><big>(</big><em>Th</em>, <em>Azm</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetDetXYfromThAzm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetDetXYfromThAzm" 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="GSASIIimage.GetDetectorXY">
106<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetDetectorXY</tt><big>(</big><em>dsp</em>, <em>azm</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetDetectorXY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetDetectorXY" 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="GSASIIimage.GetDsp">
112<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetDsp</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetDsp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetDsp" title="Permalink to this definition">¶</a></dt>
113<dd><p>Give d-spacing value for detector x,y position; calibration info in data</p>
114</dd></dl>
115
116<dl class="function">
117<dt id="GSASIIimage.GetEllipse">
118<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetEllipse</tt><big>(</big><em>dsp</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetEllipse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetEllipse" title="Permalink to this definition">¶</a></dt>
119<dd><p>uses Dandelin spheres to find ellipse or hyperbola parameters from detector geometry
120as given in image controls dictionary (data) and a d-spacing (dsp)</p>
121</dd></dl>
122
123<dl class="function">
124<dt id="GSASIIimage.GetEllipse2">
125<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetEllipse2</tt><big>(</big><em>tth</em>, <em>dxy</em>, <em>dist</em>, <em>cent</em>, <em>tilt</em>, <em>phi</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetEllipse2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetEllipse2" title="Permalink to this definition">¶</a></dt>
126<dd><p>uses Dandelin spheres to find ellipse or hyperbola parameters from detector geometry
127on output
128radii[0] (b-minor axis) set &lt; 0. for hyperbola</p>
129</dd></dl>
130
131<dl class="function">
132<dt id="GSASIIimage.GetTth">
133<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetTth</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetTth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetTth" title="Permalink to this definition">¶</a></dt>
134<dd><p>Give 2-theta value for detector x,y position; calibration info in data</p>
135</dd></dl>
136
137<dl class="function">
138<dt id="GSASIIimage.GetTthAzm">
139<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetTthAzm</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetTthAzm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetTthAzm" title="Permalink to this definition">¶</a></dt>
140<dd><p>Give 2-theta, azimuth values for detector x,y position; calibration info in data</p>
141</dd></dl>
142
143<dl class="function">
144<dt id="GSASIIimage.GetTthAzmD">
145<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetTthAzmD</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetTthAzmD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetTthAzmD" title="Permalink to this definition">¶</a></dt>
146<dd><p>Give 2-theta, azimuth &amp; geometric correction values for detector x,y position;
147calibration info in data</p>
148</dd></dl>
149
150<dl class="function">
151<dt id="GSASIIimage.GetTthAzmDsp">
152<tt class="descclassname">GSASIIimage.</tt><tt class="descname">GetTthAzmDsp</tt><big>(</big><em>x</em>, <em>y</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#GetTthAzmDsp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.GetTthAzmDsp" title="Permalink to this definition">¶</a></dt>
153<dd><p>Needs a doc string - checked OK for ellipses &amp; hyperbola</p>
154</dd></dl>
155
156<dl class="function">
157<dt id="GSASIIimage.ImageCalibrate">
158<tt class="descclassname">GSASIIimage.</tt><tt class="descname">ImageCalibrate</tt><big>(</big><em>self</em>, <em>data</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#ImageCalibrate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.ImageCalibrate" title="Permalink to this definition">¶</a></dt>
159<dd><p>Needs a doc string</p>
160</dd></dl>
161
162<dl class="function">
163<dt id="GSASIIimage.ImageCompress">
164<tt class="descclassname">GSASIIimage.</tt><tt class="descname">ImageCompress</tt><big>(</big><em>image</em>, <em>scale</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#ImageCompress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.ImageCompress" title="Permalink to this definition">¶</a></dt>
165<dd><p>Needs a doc string</p>
166</dd></dl>
167
168<dl class="function">
169<dt id="GSASIIimage.ImageIntegrate">
170<tt class="descclassname">GSASIIimage.</tt><tt class="descname">ImageIntegrate</tt><big>(</big><em>image</em>, <em>data</em>, <em>masks</em>, <em>blkSize=128</em>, <em>dlg=None</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#ImageIntegrate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.ImageIntegrate" title="Permalink to this definition">¶</a></dt>
171<dd><p>Needs a doc string</p>
172</dd></dl>
173
174<dl class="function">
175<dt id="GSASIIimage.ImageLocalMax">
176<tt class="descclassname">GSASIIimage.</tt><tt class="descname">ImageLocalMax</tt><big>(</big><em>image</em>, <em>w</em>, <em>Xpix</em>, <em>Ypix</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#ImageLocalMax"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.ImageLocalMax" title="Permalink to this definition">¶</a></dt>
177<dd><p>Needs a doc string</p>
178</dd></dl>
179
180<dl class="function">
181<dt id="GSASIIimage.ImageRecalibrate">
182<tt class="descclassname">GSASIIimage.</tt><tt class="descname">ImageRecalibrate</tt><big>(</big><em>self</em>, <em>data</em>, <em>masks</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#ImageRecalibrate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.ImageRecalibrate" title="Permalink to this definition">¶</a></dt>
183<dd><p>Needs a doc string</p>
184</dd></dl>
185
186<dl class="function">
187<dt id="GSASIIimage.Make2ThetaAzimuthMap">
188<tt class="descclassname">GSASIIimage.</tt><tt class="descname">Make2ThetaAzimuthMap</tt><big>(</big><em>data</em>, <em>masks</em>, <em>iLim</em>, <em>jLim</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#Make2ThetaAzimuthMap"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.Make2ThetaAzimuthMap" title="Permalink to this definition">¶</a></dt>
189<dd><p>Needs a doc string</p>
190</dd></dl>
191
192<dl class="function">
193<dt id="GSASIIimage.calcFij">
194<tt class="descclassname">GSASIIimage.</tt><tt class="descname">calcFij</tt><big>(</big><em>omg</em>, <em>phi</em>, <em>azm</em>, <em>th</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#calcFij"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.calcFij" title="Permalink to this definition">¶</a></dt>
195<dd><p>Does something...</p>
196<p>Uses parameters as defined by Bob He &amp; Kingsley Smith, Adv. in X-Ray Anal. 41, 501 (1997)</p>
197<table class="docutils field-list" frame="void" rules="none">
198<col class="field-name" />
199<col class="field-body" />
200<tbody valign="top">
201<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
202<li><strong>omg</strong> &#8211; his omega = sample omega rotation; 0 when incident beam || sample surface,
20390 when perp. to sample surface</li>
204<li><strong>phi</strong> &#8211; his phi = sample phi rotation; usually = 0, axis rotates with omg.</li>
205<li><strong>azm</strong> &#8211; his chi = azimuth around incident beam</li>
206<li><strong>th</strong> &#8211; his theta = theta</li>
207</ul>
208</td>
209</tr>
210</tbody>
211</table>
212</dd></dl>
213
214<dl class="function">
215<dt id="GSASIIimage.checkEllipse">
216<tt class="descclassname">GSASIIimage.</tt><tt class="descname">checkEllipse</tt><big>(</big><em>Zsum</em>, <em>distSum</em>, <em>xSum</em>, <em>ySum</em>, <em>dist</em>, <em>x</em>, <em>y</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#checkEllipse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.checkEllipse" title="Permalink to this definition">¶</a></dt>
217<dd><p>Needs a doc string</p>
218</dd></dl>
219
220<dl class="function">
221<dt id="GSASIIimage.makeMat">
222<tt class="descclassname">GSASIIimage.</tt><tt class="descname">makeMat</tt><big>(</big><em>Angle</em>, <em>Axis</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#makeMat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.makeMat" title="Permalink to this definition">¶</a></dt>
223<dd><p>Make rotation matrix from Angle and Axis</p>
224<table class="docutils field-list" frame="void" rules="none">
225<col class="field-name" />
226<col class="field-body" />
227<tbody valign="top">
228<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
229<li><strong>Angle</strong> (<em>float</em>) &#8211; in degrees</li>
230<li><strong>Axis</strong> (<em>int</em>) &#8211; 0 for rotation about x, 1 for about y, etc.</li>
231</ul>
232</td>
233</tr>
234</tbody>
235</table>
236</dd></dl>
237
238<dl class="function">
239<dt id="GSASIIimage.makeRing">
240<tt class="descclassname">GSASIIimage.</tt><tt class="descname">makeRing</tt><big>(</big><em>dsp</em>, <em>ellipse</em>, <em>pix</em>, <em>reject</em>, <em>scalex</em>, <em>scaley</em>, <em>image</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#makeRing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.makeRing" title="Permalink to this definition">¶</a></dt>
241<dd><p>Needs a doc string</p>
242</dd></dl>
243
244<dl class="function">
245<dt id="GSASIIimage.peneCorr">
246<tt class="descclassname">GSASIIimage.</tt><tt class="descname">peneCorr</tt><big>(</big><em>tth</em>, <em>dep</em>, <em>tilt=0.0</em>, <em>azm=0.0</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#peneCorr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.peneCorr" title="Permalink to this definition">¶</a></dt>
247<dd><p>Needs a doc string</p>
248</dd></dl>
249
250<dl class="function">
251<dt id="GSASIIimage.pointInPolygon">
252<tt class="descclassname">GSASIIimage.</tt><tt class="descname">pointInPolygon</tt><big>(</big><em>pXY</em>, <em>xy</em><big>)</big><a class="reference internal" href="_modules/GSASIIimage.html#pointInPolygon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GSASIIimage.pointInPolygon" title="Permalink to this definition">¶</a></dt>
253<dd><p>Needs a doc string</p>
254</dd></dl>
255
256</div>
257
258
259          </div>
260        </div>
261      </div>
262      <div class="sphinxsidebar">
263        <div class="sphinxsidebarwrapper">
264            <p class="logo"><a href="index.html">
265              <img class="logo" src="_static/G2_html_logo.png" alt="Logo"/>
266            </a></p>
267  <h4>Previous topic</h4>
268  <p class="topless"><a href="GSASIImapvars.html"
269                        title="previous chapter"><em>GSASIImapvars: Parameter constraints</em></a></p>
270  <h4>Next topic</h4>
271  <p class="topless"><a href="GSASIImath.html"
272                        title="next chapter"><em>GSASIImath: computation module</em></a></p>
273  <h3>This Page</h3>
274  <ul class="this-page-menu">
275    <li><a href="_sources/GSASIIimage.txt"
276           rel="nofollow">Show Source</a></li>
277  </ul>
278<div id="searchbox" style="display: none">
279  <h3>Quick search</h3>
280    <form class="search" action="search.html" method="get">
281      <input type="text" name="q" />
282      <input type="submit" value="Go" />
283      <input type="hidden" name="check_keywords" value="yes" />
284      <input type="hidden" name="area" value="default" />
285    </form>
286    <p class="searchtip" style="font-size: 90%">
287    Enter search terms or a module, class or function name.
288    </p>
289</div>
290<script type="text/javascript">$('#searchbox').show(0);</script>
291        </div>
292      </div>
293      <div class="clearer"></div>
294    </div>
295    <div class="related">
296      <h3>Navigation</h3>
297      <ul>
298        <li class="right" style="margin-right: 10px">
299          <a href="genindex.html" title="General Index"
300             >index</a></li>
301        <li class="right" >
302          <a href="py-modindex.html" title="Python Module Index"
303             >modules</a> |</li>
304        <li class="right" >
305          <a href="GSASIImath.html" title="GSASIImath: computation module"
306             >next</a> |</li>
307        <li class="right" >
308          <a href="GSASIImapvars.html" title="GSASIImapvars: Parameter constraints"
309             >previous</a> |</li>
310        <li><a href="index.html">GSAS-II 0.2.0 documentation</a> &raquo;</li> 
311      </ul>
312    </div>
313    <div class="footer">
314        &copy; Copyright 2013, Von Dreele and Toby for Argonne National Laboratory.
315      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
316    </div>
317  </body>
318</html>
Note: See TracBrowser for help on using the repository browser.