source: sasview/sansdataloader/docs/sphinx/html/api/manipulations.html @ d6a2e26

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since d6a2e26 was 7247844, checked in by Gervaise Alina <gervyh@…>, 13 years ago

updates docs
  • Property mode set to 100644
File size: 81.8 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>manipulations &mdash; DataLoader 0.1.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.1.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="DataLoader 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="Readers" href="readers/index.html" />
31    <link rel="prev" title="loader" href="loader.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="readers/index.html" title="Readers"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="loader.html" title="loader"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="manipulations">
60<h1>manipulations<a class="headerlink" href="#manipulations" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-dataloader-manipulations">
62<h2><a class="reference internal" href="#module-sans.dataloader.manipulations" title="sans.dataloader.manipulations"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.manipulations</span></tt></a><a class="headerlink" href="#sans-dataloader-manipulations" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.dataloader.manipulations"></span><p>Data manipulations for 2D data sets.
64Using the meta data information, various types of averaging
65are performed in Q-space</p>
66<dl class="class">
67<dt id="sans.dataloader.manipulations.Boxavg">
68<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Boxavg</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg" title="Permalink to this definition">¶</a></dt>
69<dd><p>Bases: <a class="reference internal" href="#sans.dataloader.manipulations.Boxsum" title="sans.dataloader.manipulations.Boxsum"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.manipulations.Boxsum</span></tt></a></p>
70<p>Perform the average of counts in a 2D region of interest.</p>
71<dl class="method">
72<dt id="sans.dataloader.manipulations.Boxavg.__call__">
73<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__call__" title="Permalink to this definition">¶</a></dt>
74<dd><p>Perform the sum in the region of interest</p>
75<table class="docutils field-list" frame="void" rules="none">
76<col class="field-name" />
77<col class="field-body" />
78<tbody valign="top">
79<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
80</tr>
81<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">average counts, error on average counts</td>
82</tr>
83</tbody>
84</table>
85</dd></dl>
86
87<dl class="attribute">
88<dt id="sans.dataloader.manipulations.Boxavg.__class__">
89<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__class__" title="Permalink to this definition">¶</a></dt>
90<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
91</dd></dl>
92
93<dl class="attribute">
94<dt id="sans.dataloader.manipulations.Boxavg.__delattr__">
95<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__delattr__" title="Permalink to this definition">¶</a></dt>
96<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
97</dd></dl>
98
99<dl class="attribute">
100<dt id="sans.dataloader.manipulations.Boxavg.__dict__">
101<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x028EE710&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__dict__" title="Permalink to this definition">¶</a></dt>
102<dd></dd></dl>
103
104<dl class="attribute">
105<dt id="sans.dataloader.manipulations.Boxavg.__getattribute__">
106<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__getattribute__" title="Permalink to this definition">¶</a></dt>
107<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
108</dd></dl>
109
110<dl class="attribute">
111<dt id="sans.dataloader.manipulations.Boxavg.__hash__">
112<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__hash__" title="Permalink to this definition">¶</a></dt>
113<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
114</dd></dl>
115
116<dl class="method">
117<dt id="sans.dataloader.manipulations.Boxavg.__init__">
118<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__init__" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121<dl class="attribute">
122<dt id="sans.dataloader.manipulations.Boxavg.__module__">
123<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__module__" title="Permalink to this definition">¶</a></dt>
124<dd></dd></dl>
125
126<dl class="staticmethod">
127<dt id="sans.dataloader.manipulations.Boxavg.__new__">
128<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__new__" title="Permalink to this definition">¶</a></dt>
129<dd></dd></dl>
130
131<dl class="method">
132<dt id="sans.dataloader.manipulations.Boxavg.__reduce__">
133<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__reduce__" title="Permalink to this definition">¶</a></dt>
134<dd><p>helper for pickle</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.dataloader.manipulations.Boxavg.__reduce_ex__">
139<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
140<dd><p>helper for pickle</p>
141</dd></dl>
142
143<dl class="attribute">
144<dt id="sans.dataloader.manipulations.Boxavg.__repr__">
145<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__repr__" title="Permalink to this definition">¶</a></dt>
146<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
147</dd></dl>
148
149<dl class="attribute">
150<dt id="sans.dataloader.manipulations.Boxavg.__setattr__">
151<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__setattr__" title="Permalink to this definition">¶</a></dt>
152<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
153</dd></dl>
154
155<dl class="attribute">
156<dt id="sans.dataloader.manipulations.Boxavg.__str__">
157<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__str__" title="Permalink to this definition">¶</a></dt>
158<dd><p>x.__str__() &lt;==&gt; str(x)</p>
159</dd></dl>
160
161<dl class="attribute">
162<dt id="sans.dataloader.manipulations.Boxavg.__weakref__">
163<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg.__weakref__" title="Permalink to this definition">¶</a></dt>
164<dd><p>list of weak references to the object (if defined)</p>
165</dd></dl>
166
167<dl class="method">
168<dt id="sans.dataloader.manipulations.Boxavg._sum">
169<tt class="descname">_sum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxavg._sum" title="Permalink to this definition">¶</a></dt>
170<dd><p>Perform the sum in the region of interest</p>
171<table class="docutils field-list" frame="void" rules="none">
172<col class="field-name" />
173<col class="field-body" />
174<tbody valign="top">
175<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
176</tr>
177<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of counts,
178error on number of counts, number of entries summed</td>
179</tr>
180</tbody>
181</table>
182</dd></dl>
183
184</dd></dl>
185
186<dl class="class">
187<dt id="sans.dataloader.manipulations.Boxcut">
188<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Boxcut</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut" title="Permalink to this definition">¶</a></dt>
189<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
190<p>Find a rectangular 2D region of interest.</p>
191<dl class="method">
192<dt id="sans.dataloader.manipulations.Boxcut.__call__">
193<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__call__" title="Permalink to this definition">¶</a></dt>
194<dd><p>Find a rectangular 2D region of interest.</p>
195<table class="docutils field-list" frame="void" rules="none">
196<col class="field-name" />
197<col class="field-body" />
198<tbody valign="top">
199<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
200</tr>
201<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">mask, 1d array (len = len(data))
202with Trues where the data points are inside ROI, otherwise False</td>
203</tr>
204</tbody>
205</table>
206</dd></dl>
207
208<dl class="attribute">
209<dt id="sans.dataloader.manipulations.Boxcut.__class__">
210<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__class__" title="Permalink to this definition">¶</a></dt>
211<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
212</dd></dl>
213
214<dl class="attribute">
215<dt id="sans.dataloader.manipulations.Boxcut.__delattr__">
216<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__delattr__" title="Permalink to this definition">¶</a></dt>
217<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
218</dd></dl>
219
220<dl class="attribute">
221<dt id="sans.dataloader.manipulations.Boxcut.__dict__">
222<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x028EE4B0&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__dict__" title="Permalink to this definition">¶</a></dt>
223<dd></dd></dl>
224
225<dl class="attribute">
226<dt id="sans.dataloader.manipulations.Boxcut.__getattribute__">
227<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__getattribute__" title="Permalink to this definition">¶</a></dt>
228<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
229</dd></dl>
230
231<dl class="attribute">
232<dt id="sans.dataloader.manipulations.Boxcut.__hash__">
233<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__hash__" title="Permalink to this definition">¶</a></dt>
234<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
235</dd></dl>
236
237<dl class="method">
238<dt id="sans.dataloader.manipulations.Boxcut.__init__">
239<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__init__" title="Permalink to this definition">¶</a></dt>
240<dd></dd></dl>
241
242<dl class="attribute">
243<dt id="sans.dataloader.manipulations.Boxcut.__module__">
244<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__module__" title="Permalink to this definition">¶</a></dt>
245<dd></dd></dl>
246
247<dl class="staticmethod">
248<dt id="sans.dataloader.manipulations.Boxcut.__new__">
249<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__new__" title="Permalink to this definition">¶</a></dt>
250<dd></dd></dl>
251
252<dl class="method">
253<dt id="sans.dataloader.manipulations.Boxcut.__reduce__">
254<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__reduce__" title="Permalink to this definition">¶</a></dt>
255<dd><p>helper for pickle</p>
256</dd></dl>
257
258<dl class="method">
259<dt id="sans.dataloader.manipulations.Boxcut.__reduce_ex__">
260<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
261<dd><p>helper for pickle</p>
262</dd></dl>
263
264<dl class="attribute">
265<dt id="sans.dataloader.manipulations.Boxcut.__repr__">
266<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__repr__" title="Permalink to this definition">¶</a></dt>
267<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
268</dd></dl>
269
270<dl class="attribute">
271<dt id="sans.dataloader.manipulations.Boxcut.__setattr__">
272<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__setattr__" title="Permalink to this definition">¶</a></dt>
273<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
274</dd></dl>
275
276<dl class="attribute">
277<dt id="sans.dataloader.manipulations.Boxcut.__str__">
278<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__str__" title="Permalink to this definition">¶</a></dt>
279<dd><p>x.__str__() &lt;==&gt; str(x)</p>
280</dd></dl>
281
282<dl class="attribute">
283<dt id="sans.dataloader.manipulations.Boxcut.__weakref__">
284<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut.__weakref__" title="Permalink to this definition">¶</a></dt>
285<dd><p>list of weak references to the object (if defined)</p>
286</dd></dl>
287
288<dl class="method">
289<dt id="sans.dataloader.manipulations.Boxcut._find">
290<tt class="descname">_find</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxcut._find" title="Permalink to this definition">¶</a></dt>
291<dd><p>Find a rectangular 2D region of interest.</p>
292<table class="docutils field-list" frame="void" rules="none">
293<col class="field-name" />
294<col class="field-body" />
295<tbody valign="top">
296<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
297</tr>
298<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">out, 1d array (length = len(data))
299with Trues where the data points are inside ROI, otherwise Falses</td>
300</tr>
301</tbody>
302</table>
303</dd></dl>
304
305</dd></dl>
306
307<dl class="class">
308<dt id="sans.dataloader.manipulations.Boxsum">
309<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Boxsum</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum" title="Permalink to this definition">¶</a></dt>
310<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
311<p>Perform the sum of counts in a 2D region of interest.</p>
312<dl class="method">
313<dt id="sans.dataloader.manipulations.Boxsum.__call__">
314<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__call__" title="Permalink to this definition">¶</a></dt>
315<dd><p>Perform the sum in the region of interest</p>
316<table class="docutils field-list" frame="void" rules="none">
317<col class="field-name" />
318<col class="field-body" />
319<tbody valign="top">
320<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
321</tr>
322<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of counts, error on number of counts</td>
323</tr>
324</tbody>
325</table>
326</dd></dl>
327
328<dl class="attribute">
329<dt id="sans.dataloader.manipulations.Boxsum.__class__">
330<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__class__" title="Permalink to this definition">¶</a></dt>
331<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
332</dd></dl>
333
334<dl class="attribute">
335<dt id="sans.dataloader.manipulations.Boxsum.__delattr__">
336<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__delattr__" title="Permalink to this definition">¶</a></dt>
337<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
338</dd></dl>
339
340<dl class="attribute">
341<dt id="sans.dataloader.manipulations.Boxsum.__dict__">
342<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x028EE970&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__dict__" title="Permalink to this definition">¶</a></dt>
343<dd></dd></dl>
344
345<dl class="attribute">
346<dt id="sans.dataloader.manipulations.Boxsum.__getattribute__">
347<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__getattribute__" title="Permalink to this definition">¶</a></dt>
348<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
349</dd></dl>
350
351<dl class="attribute">
352<dt id="sans.dataloader.manipulations.Boxsum.__hash__">
353<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__hash__" title="Permalink to this definition">¶</a></dt>
354<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
355</dd></dl>
356
357<dl class="method">
358<dt id="sans.dataloader.manipulations.Boxsum.__init__">
359<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__init__" title="Permalink to this definition">¶</a></dt>
360<dd></dd></dl>
361
362<dl class="attribute">
363<dt id="sans.dataloader.manipulations.Boxsum.__module__">
364<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__module__" title="Permalink to this definition">¶</a></dt>
365<dd></dd></dl>
366
367<dl class="staticmethod">
368<dt id="sans.dataloader.manipulations.Boxsum.__new__">
369<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__new__" title="Permalink to this definition">¶</a></dt>
370<dd></dd></dl>
371
372<dl class="method">
373<dt id="sans.dataloader.manipulations.Boxsum.__reduce__">
374<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__reduce__" title="Permalink to this definition">¶</a></dt>
375<dd><p>helper for pickle</p>
376</dd></dl>
377
378<dl class="method">
379<dt id="sans.dataloader.manipulations.Boxsum.__reduce_ex__">
380<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
381<dd><p>helper for pickle</p>
382</dd></dl>
383
384<dl class="attribute">
385<dt id="sans.dataloader.manipulations.Boxsum.__repr__">
386<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__repr__" title="Permalink to this definition">¶</a></dt>
387<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
388</dd></dl>
389
390<dl class="attribute">
391<dt id="sans.dataloader.manipulations.Boxsum.__setattr__">
392<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__setattr__" title="Permalink to this definition">¶</a></dt>
393<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
394</dd></dl>
395
396<dl class="attribute">
397<dt id="sans.dataloader.manipulations.Boxsum.__str__">
398<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__str__" title="Permalink to this definition">¶</a></dt>
399<dd><p>x.__str__() &lt;==&gt; str(x)</p>
400</dd></dl>
401
402<dl class="attribute">
403<dt id="sans.dataloader.manipulations.Boxsum.__weakref__">
404<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum.__weakref__" title="Permalink to this definition">¶</a></dt>
405<dd><p>list of weak references to the object (if defined)</p>
406</dd></dl>
407
408<dl class="method">
409<dt id="sans.dataloader.manipulations.Boxsum._sum">
410<tt class="descname">_sum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Boxsum._sum" title="Permalink to this definition">¶</a></dt>
411<dd><p>Perform the sum in the region of interest</p>
412<table class="docutils field-list" frame="void" rules="none">
413<col class="field-name" />
414<col class="field-body" />
415<tbody valign="top">
416<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
417</tr>
418<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of counts,
419error on number of counts, number of entries summed</td>
420</tr>
421</tbody>
422</table>
423</dd></dl>
424
425</dd></dl>
426
427<dl class="class">
428<dt id="sans.dataloader.manipulations.CircularAverage">
429<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">CircularAverage</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage" title="Permalink to this definition">¶</a></dt>
430<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
431<p>Perform circular averaging on 2D data</p>
432<p>The data returned is the distribution of counts
433as a function of Q</p>
434<dl class="method">
435<dt id="sans.dataloader.manipulations.CircularAverage.__call__">
436<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__call__" title="Permalink to this definition">¶</a></dt>
437<dd><p>Perform circular averaging on the data</p>
438<table class="docutils field-list" frame="void" rules="none">
439<col class="field-name" />
440<col class="field-body" />
441<tbody valign="top">
442<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
443</tr>
444<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
445</tr>
446</tbody>
447</table>
448</dd></dl>
449
450<dl class="attribute">
451<dt id="sans.dataloader.manipulations.CircularAverage.__class__">
452<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__class__" title="Permalink to this definition">¶</a></dt>
453<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
454</dd></dl>
455
456<dl class="attribute">
457<dt id="sans.dataloader.manipulations.CircularAverage.__delattr__">
458<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__delattr__" title="Permalink to this definition">¶</a></dt>
459<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
460</dd></dl>
461
462<dl class="attribute">
463<dt id="sans.dataloader.manipulations.CircularAverage.__dict__">
464<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x028EE530&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__dict__" title="Permalink to this definition">¶</a></dt>
465<dd></dd></dl>
466
467<dl class="attribute">
468<dt id="sans.dataloader.manipulations.CircularAverage.__getattribute__">
469<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__getattribute__" title="Permalink to this definition">¶</a></dt>
470<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
471</dd></dl>
472
473<dl class="attribute">
474<dt id="sans.dataloader.manipulations.CircularAverage.__hash__">
475<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__hash__" title="Permalink to this definition">¶</a></dt>
476<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
477</dd></dl>
478
479<dl class="method">
480<dt id="sans.dataloader.manipulations.CircularAverage.__init__">
481<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__init__" title="Permalink to this definition">¶</a></dt>
482<dd></dd></dl>
483
484<dl class="attribute">
485<dt id="sans.dataloader.manipulations.CircularAverage.__module__">
486<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__module__" title="Permalink to this definition">¶</a></dt>
487<dd></dd></dl>
488
489<dl class="staticmethod">
490<dt id="sans.dataloader.manipulations.CircularAverage.__new__">
491<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__new__" title="Permalink to this definition">¶</a></dt>
492<dd></dd></dl>
493
494<dl class="method">
495<dt id="sans.dataloader.manipulations.CircularAverage.__reduce__">
496<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__reduce__" title="Permalink to this definition">¶</a></dt>
497<dd><p>helper for pickle</p>
498</dd></dl>
499
500<dl class="method">
501<dt id="sans.dataloader.manipulations.CircularAverage.__reduce_ex__">
502<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
503<dd><p>helper for pickle</p>
504</dd></dl>
505
506<dl class="attribute">
507<dt id="sans.dataloader.manipulations.CircularAverage.__repr__">
508<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__repr__" title="Permalink to this definition">¶</a></dt>
509<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
510</dd></dl>
511
512<dl class="attribute">
513<dt id="sans.dataloader.manipulations.CircularAverage.__setattr__">
514<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__setattr__" title="Permalink to this definition">¶</a></dt>
515<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
516</dd></dl>
517
518<dl class="attribute">
519<dt id="sans.dataloader.manipulations.CircularAverage.__str__">
520<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__str__" title="Permalink to this definition">¶</a></dt>
521<dd><p>x.__str__() &lt;==&gt; str(x)</p>
522</dd></dl>
523
524<dl class="attribute">
525<dt id="sans.dataloader.manipulations.CircularAverage.__weakref__">
526<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.CircularAverage.__weakref__" title="Permalink to this definition">¶</a></dt>
527<dd><p>list of weak references to the object (if defined)</p>
528</dd></dl>
529
530</dd></dl>
531
532<dl class="class">
533<dt id="sans.dataloader.manipulations.Ring">
534<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Ring</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring" title="Permalink to this definition">¶</a></dt>
535<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
536<p>Defines a ring on a 2D data set.
537The ring is defined by r_min, r_max, and
538the position of the center of the ring.</p>
539<p>The data returned is the distribution of counts
540around the ring as a function of phi.</p>
541<p>Phi_min and phi_max should be defined between 0 and 2*pi
542in anti-clockwise starting from the x- axis on the left-hand side</p>
543<dl class="method">
544<dt id="sans.dataloader.manipulations.Ring.__call__">
545<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__call__" title="Permalink to this definition">¶</a></dt>
546<dd><p>Apply the ring to the data set.
547Returns the angular distribution for a given q range</p>
548<table class="docutils field-list" frame="void" rules="none">
549<col class="field-name" />
550<col class="field-body" />
551<tbody valign="top">
552<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
553</tr>
554<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
555</tr>
556</tbody>
557</table>
558</dd></dl>
559
560<dl class="attribute">
561<dt id="sans.dataloader.manipulations.Ring.__class__">
562<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__class__" title="Permalink to this definition">¶</a></dt>
563<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
564</dd></dl>
565
566<dl class="attribute">
567<dt id="sans.dataloader.manipulations.Ring.__delattr__">
568<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__delattr__" title="Permalink to this definition">¶</a></dt>
569<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
570</dd></dl>
571
572<dl class="attribute">
573<dt id="sans.dataloader.manipulations.Ring.__dict__">
574<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x028EEFD0&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__dict__" title="Permalink to this definition">¶</a></dt>
575<dd></dd></dl>
576
577<dl class="attribute">
578<dt id="sans.dataloader.manipulations.Ring.__getattribute__">
579<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__getattribute__" title="Permalink to this definition">¶</a></dt>
580<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
581</dd></dl>
582
583<dl class="attribute">
584<dt id="sans.dataloader.manipulations.Ring.__hash__">
585<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__hash__" title="Permalink to this definition">¶</a></dt>
586<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
587</dd></dl>
588
589<dl class="method">
590<dt id="sans.dataloader.manipulations.Ring.__init__">
591<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__init__" title="Permalink to this definition">¶</a></dt>
592<dd></dd></dl>
593
594<dl class="attribute">
595<dt id="sans.dataloader.manipulations.Ring.__module__">
596<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__module__" title="Permalink to this definition">¶</a></dt>
597<dd></dd></dl>
598
599<dl class="staticmethod">
600<dt id="sans.dataloader.manipulations.Ring.__new__">
601<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Ring.__new__" title="Permalink to this definition">¶</a></dt>
602<dd></dd></dl>
603
604<dl class="method">
605<dt id="sans.dataloader.manipulations.Ring.__reduce__">
606<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__reduce__" title="Permalink to this definition">¶</a></dt>
607<dd><p>helper for pickle</p>
608</dd></dl>
609
610<dl class="method">
611<dt id="sans.dataloader.manipulations.Ring.__reduce_ex__">
612<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
613<dd><p>helper for pickle</p>
614</dd></dl>
615
616<dl class="attribute">
617<dt id="sans.dataloader.manipulations.Ring.__repr__">
618<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__repr__" title="Permalink to this definition">¶</a></dt>
619<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
620</dd></dl>
621
622<dl class="attribute">
623<dt id="sans.dataloader.manipulations.Ring.__setattr__">
624<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__setattr__" title="Permalink to this definition">¶</a></dt>
625<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
626</dd></dl>
627
628<dl class="attribute">
629<dt id="sans.dataloader.manipulations.Ring.__str__">
630<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__str__" title="Permalink to this definition">¶</a></dt>
631<dd><p>x.__str__() &lt;==&gt; str(x)</p>
632</dd></dl>
633
634<dl class="attribute">
635<dt id="sans.dataloader.manipulations.Ring.__weakref__">
636<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ring.__weakref__" title="Permalink to this definition">¶</a></dt>
637<dd><p>list of weak references to the object (if defined)</p>
638</dd></dl>
639
640</dd></dl>
641
642<dl class="class">
643<dt id="sans.dataloader.manipulations.Ringcut">
644<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Ringcut</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut" title="Permalink to this definition">¶</a></dt>
645<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
646<p>Defines a ring on a 2D data set.
647The ring is defined by r_min, r_max, and
648the position of the center of the ring.</p>
649<p>The data returned is the region inside the ring</p>
650<p>Phi_min and phi_max should be defined between 0 and 2*pi
651in anti-clockwise starting from the x- axis on the left-hand side</p>
652<dl class="method">
653<dt id="sans.dataloader.manipulations.Ringcut.__call__">
654<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__call__" title="Permalink to this definition">¶</a></dt>
655<dd><p>Apply the ring to the data set.
656Returns the angular distribution for a given q range</p>
657<table class="docutils field-list" frame="void" rules="none">
658<col class="field-name" />
659<col class="field-body" />
660<tbody valign="top">
661<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
662</tr>
663<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">index array in the range</td>
664</tr>
665</tbody>
666</table>
667</dd></dl>
668
669<dl class="attribute">
670<dt id="sans.dataloader.manipulations.Ringcut.__class__">
671<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__class__" title="Permalink to this definition">¶</a></dt>
672<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
673</dd></dl>
674
675<dl class="attribute">
676<dt id="sans.dataloader.manipulations.Ringcut.__delattr__">
677<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__delattr__" title="Permalink to this definition">¶</a></dt>
678<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
679</dd></dl>
680
681<dl class="attribute">
682<dt id="sans.dataloader.manipulations.Ringcut.__dict__">
683<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02906210&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__dict__" title="Permalink to this definition">¶</a></dt>
684<dd></dd></dl>
685
686<dl class="attribute">
687<dt id="sans.dataloader.manipulations.Ringcut.__getattribute__">
688<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__getattribute__" title="Permalink to this definition">¶</a></dt>
689<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
690</dd></dl>
691
692<dl class="attribute">
693<dt id="sans.dataloader.manipulations.Ringcut.__hash__">
694<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__hash__" title="Permalink to this definition">¶</a></dt>
695<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
696</dd></dl>
697
698<dl class="method">
699<dt id="sans.dataloader.manipulations.Ringcut.__init__">
700<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__init__" title="Permalink to this definition">¶</a></dt>
701<dd></dd></dl>
702
703<dl class="attribute">
704<dt id="sans.dataloader.manipulations.Ringcut.__module__">
705<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__module__" title="Permalink to this definition">¶</a></dt>
706<dd></dd></dl>
707
708<dl class="staticmethod">
709<dt id="sans.dataloader.manipulations.Ringcut.__new__">
710<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__new__" title="Permalink to this definition">¶</a></dt>
711<dd></dd></dl>
712
713<dl class="method">
714<dt id="sans.dataloader.manipulations.Ringcut.__reduce__">
715<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__reduce__" title="Permalink to this definition">¶</a></dt>
716<dd><p>helper for pickle</p>
717</dd></dl>
718
719<dl class="method">
720<dt id="sans.dataloader.manipulations.Ringcut.__reduce_ex__">
721<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
722<dd><p>helper for pickle</p>
723</dd></dl>
724
725<dl class="attribute">
726<dt id="sans.dataloader.manipulations.Ringcut.__repr__">
727<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__repr__" title="Permalink to this definition">¶</a></dt>
728<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
729</dd></dl>
730
731<dl class="attribute">
732<dt id="sans.dataloader.manipulations.Ringcut.__setattr__">
733<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__setattr__" title="Permalink to this definition">¶</a></dt>
734<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
735</dd></dl>
736
737<dl class="attribute">
738<dt id="sans.dataloader.manipulations.Ringcut.__str__">
739<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__str__" title="Permalink to this definition">¶</a></dt>
740<dd><p>x.__str__() &lt;==&gt; str(x)</p>
741</dd></dl>
742
743<dl class="attribute">
744<dt id="sans.dataloader.manipulations.Ringcut.__weakref__">
745<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Ringcut.__weakref__" title="Permalink to this definition">¶</a></dt>
746<dd><p>list of weak references to the object (if defined)</p>
747</dd></dl>
748
749</dd></dl>
750
751<dl class="class">
752<dt id="sans.dataloader.manipulations.SectorPhi">
753<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">SectorPhi</tt><a class="headerlink" href="#sans.dataloader.manipulations.SectorPhi" title="Permalink to this definition">¶</a></dt>
754<dd><p>Bases: <a class="reference internal" href="#sans.dataloader.manipulations._Sector" title="sans.dataloader.manipulations._Sector"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.manipulations._Sector</span></tt></a></p>
755<p>Sector average as a function of phi.
756I(phi) is return and the data is averaged over Q.</p>
757<p>A sector is defined by r_min, r_max, phi_min, phi_max.
758The number of bin in phi also has to be defined.</p>
759<dl class="method">
760<dt id="sans.dataloader.manipulations.SectorPhi.__call__">
761<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorPhi.__call__" title="Permalink to this definition">¶</a></dt>
762<dd><p>Perform sector average and return I(phi).</p>
763<table class="docutils field-list" frame="void" rules="none">
764<col class="field-name" />
765<col class="field-body" />
766<tbody valign="top">
767<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
768</tr>
769<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
770</tr>
771</tbody>
772</table>
773</dd></dl>
774
775<dl class="method">
776<dt id="sans.dataloader.manipulations.SectorPhi.__init__">
777<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorPhi.__init__" title="Permalink to this definition">¶</a></dt>
778<dd></dd></dl>
779
780<dl class="attribute">
781<dt id="sans.dataloader.manipulations.SectorPhi.__module__">
782<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.SectorPhi.__module__" title="Permalink to this definition">¶</a></dt>
783<dd></dd></dl>
784
785<dl class="method">
786<dt id="sans.dataloader.manipulations.SectorPhi._agv">
787<tt class="descname">_agv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorPhi._agv" title="Permalink to this definition">¶</a></dt>
788<dd><p>Perform sector averaging.</p>
789<table class="docutils field-list" frame="void" rules="none">
790<col class="field-name" />
791<col class="field-body" />
792<tbody valign="top">
793<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
794<li><strong>data2D</strong> &#8211; Data2D object</li>
795<li><strong>run</strong> &#8211; define the varying parameter (&#8216;phi&#8217; , &#8216;q&#8217; , or &#8216;q2&#8217;)</li>
796</ul>
797</td>
798</tr>
799<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
800</td>
801</tr>
802</tbody>
803</table>
804</dd></dl>
805
806</dd></dl>
807
808<dl class="class">
809<dt id="sans.dataloader.manipulations.SectorQ">
810<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">SectorQ</tt><a class="headerlink" href="#sans.dataloader.manipulations.SectorQ" title="Permalink to this definition">¶</a></dt>
811<dd><p>Bases: <a class="reference internal" href="#sans.dataloader.manipulations._Sector" title="sans.dataloader.manipulations._Sector"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.manipulations._Sector</span></tt></a></p>
812<p>Sector average as a function of Q for both symatric wings.
813I(Q) is return and the data is averaged over phi.</p>
814<p>A sector is defined by r_min, r_max, phi_min, phi_max.
815r_min, r_max, phi_min, phi_max &gt;0. 
816The number of bin in Q also has to be defined.</p>
817<dl class="method">
818<dt id="sans.dataloader.manipulations.SectorQ.__call__">
819<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorQ.__call__" title="Permalink to this definition">¶</a></dt>
820<dd><p>Perform sector average and return I(Q).</p>
821<table class="docutils field-list" frame="void" rules="none">
822<col class="field-name" />
823<col class="field-body" />
824<tbody valign="top">
825<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
826</tr>
827<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
828</tr>
829</tbody>
830</table>
831</dd></dl>
832
833<dl class="method">
834<dt id="sans.dataloader.manipulations.SectorQ.__init__">
835<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorQ.__init__" title="Permalink to this definition">¶</a></dt>
836<dd></dd></dl>
837
838<dl class="attribute">
839<dt id="sans.dataloader.manipulations.SectorQ.__module__">
840<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.SectorQ.__module__" title="Permalink to this definition">¶</a></dt>
841<dd></dd></dl>
842
843<dl class="method">
844<dt id="sans.dataloader.manipulations.SectorQ._agv">
845<tt class="descname">_agv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SectorQ._agv" title="Permalink to this definition">¶</a></dt>
846<dd><p>Perform sector averaging.</p>
847<table class="docutils field-list" frame="void" rules="none">
848<col class="field-name" />
849<col class="field-body" />
850<tbody valign="top">
851<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
852<li><strong>data2D</strong> &#8211; Data2D object</li>
853<li><strong>run</strong> &#8211; define the varying parameter (&#8216;phi&#8217; , &#8216;q&#8217; , or &#8216;q2&#8217;)</li>
854</ul>
855</td>
856</tr>
857<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
858</td>
859</tr>
860</tbody>
861</table>
862</dd></dl>
863
864</dd></dl>
865
866<dl class="class">
867<dt id="sans.dataloader.manipulations.Sectorcut">
868<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">Sectorcut</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut" title="Permalink to this definition">¶</a></dt>
869<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
870<p>Defines a sector (major + minor) region on a 2D data set.
871The sector is defined by phi_min, phi_max,
872where phi_min and phi_max are defined by the right
873and left lines wrt central line.</p>
874<p>Phi_min and phi_max are given in units of radian
875and (phi_max-phi_min) should not be larger than pi</p>
876<dl class="method">
877<dt id="sans.dataloader.manipulations.Sectorcut.__call__">
878<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__call__" title="Permalink to this definition">¶</a></dt>
879<dd><p>Find a rectangular 2D region of interest.</p>
880<table class="docutils field-list" frame="void" rules="none">
881<col class="field-name" />
882<col class="field-body" />
883<tbody valign="top">
884<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
885</tr>
886<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">mask, 1d array (len = len(data))</td>
887</tr>
888</tbody>
889</table>
890<p>with Trues where the data points are inside ROI, otherwise False</p>
891</dd></dl>
892
893<dl class="attribute">
894<dt id="sans.dataloader.manipulations.Sectorcut.__class__">
895<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__class__" title="Permalink to this definition">¶</a></dt>
896<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
897</dd></dl>
898
899<dl class="attribute">
900<dt id="sans.dataloader.manipulations.Sectorcut.__delattr__">
901<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__delattr__" title="Permalink to this definition">¶</a></dt>
902<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
903</dd></dl>
904
905<dl class="attribute">
906<dt id="sans.dataloader.manipulations.Sectorcut.__dict__">
907<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02906A10&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__dict__" title="Permalink to this definition">¶</a></dt>
908<dd></dd></dl>
909
910<dl class="attribute">
911<dt id="sans.dataloader.manipulations.Sectorcut.__getattribute__">
912<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__getattribute__" title="Permalink to this definition">¶</a></dt>
913<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
914</dd></dl>
915
916<dl class="attribute">
917<dt id="sans.dataloader.manipulations.Sectorcut.__hash__">
918<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__hash__" title="Permalink to this definition">¶</a></dt>
919<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
920</dd></dl>
921
922<dl class="method">
923<dt id="sans.dataloader.manipulations.Sectorcut.__init__">
924<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__init__" title="Permalink to this definition">¶</a></dt>
925<dd></dd></dl>
926
927<dl class="attribute">
928<dt id="sans.dataloader.manipulations.Sectorcut.__module__">
929<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__module__" title="Permalink to this definition">¶</a></dt>
930<dd></dd></dl>
931
932<dl class="staticmethod">
933<dt id="sans.dataloader.manipulations.Sectorcut.__new__">
934<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__new__" title="Permalink to this definition">¶</a></dt>
935<dd></dd></dl>
936
937<dl class="method">
938<dt id="sans.dataloader.manipulations.Sectorcut.__reduce__">
939<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__reduce__" title="Permalink to this definition">¶</a></dt>
940<dd><p>helper for pickle</p>
941</dd></dl>
942
943<dl class="method">
944<dt id="sans.dataloader.manipulations.Sectorcut.__reduce_ex__">
945<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
946<dd><p>helper for pickle</p>
947</dd></dl>
948
949<dl class="attribute">
950<dt id="sans.dataloader.manipulations.Sectorcut.__repr__">
951<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__repr__" title="Permalink to this definition">¶</a></dt>
952<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
953</dd></dl>
954
955<dl class="attribute">
956<dt id="sans.dataloader.manipulations.Sectorcut.__setattr__">
957<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__setattr__" title="Permalink to this definition">¶</a></dt>
958<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
959</dd></dl>
960
961<dl class="attribute">
962<dt id="sans.dataloader.manipulations.Sectorcut.__str__">
963<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__str__" title="Permalink to this definition">¶</a></dt>
964<dd><p>x.__str__() &lt;==&gt; str(x)</p>
965</dd></dl>
966
967<dl class="attribute">
968<dt id="sans.dataloader.manipulations.Sectorcut.__weakref__">
969<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut.__weakref__" title="Permalink to this definition">¶</a></dt>
970<dd><p>list of weak references to the object (if defined)</p>
971</dd></dl>
972
973<dl class="method">
974<dt id="sans.dataloader.manipulations.Sectorcut._find">
975<tt class="descname">_find</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.Sectorcut._find" title="Permalink to this definition">¶</a></dt>
976<dd><p>Find a rectangular 2D region of interest.</p>
977<table class="docutils field-list" frame="void" rules="none">
978<col class="field-name" />
979<col class="field-body" />
980<tbody valign="top">
981<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
982</tr>
983<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">out, 1d array (length = len(data))</td>
984</tr>
985</tbody>
986</table>
987<p>with Trues where the data points are inside ROI, otherwise Falses</p>
988</dd></dl>
989
990</dd></dl>
991
992<dl class="class">
993<dt id="sans.dataloader.manipulations.SlabX">
994<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">SlabX</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX" title="Permalink to this definition">¶</a></dt>
995<dd><p>Bases: <a class="reference internal" href="#sans.dataloader.manipulations._Slab" title="sans.dataloader.manipulations._Slab"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.manipulations._Slab</span></tt></a></p>
996<p>Compute average I(Qx) for a region of interest</p>
997<dl class="method">
998<dt id="sans.dataloader.manipulations.SlabX.__call__">
999<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__call__" title="Permalink to this definition">¶</a></dt>
1000<dd><p>Compute average I(Qx) for a region of interest</p>
1001<table class="docutils field-list" frame="void" rules="none">
1002<col class="field-name" />
1003<col class="field-body" />
1004<tbody valign="top">
1005<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
1006</tr>
1007<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
1008</tr>
1009</tbody>
1010</table>
1011</dd></dl>
1012
1013<dl class="attribute">
1014<dt id="sans.dataloader.manipulations.SlabX.__class__">
1015<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__class__" title="Permalink to this definition">¶</a></dt>
1016<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
1017</dd></dl>
1018
1019<dl class="attribute">
1020<dt id="sans.dataloader.manipulations.SlabX.__delattr__">
1021<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__delattr__" title="Permalink to this definition">¶</a></dt>
1022<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
1023</dd></dl>
1024
1025<dl class="attribute">
1026<dt id="sans.dataloader.manipulations.SlabX.__dict__">
1027<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02906DB0&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__dict__" title="Permalink to this definition">¶</a></dt>
1028<dd></dd></dl>
1029
1030<dl class="attribute">
1031<dt id="sans.dataloader.manipulations.SlabX.__getattribute__">
1032<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__getattribute__" title="Permalink to this definition">¶</a></dt>
1033<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
1034</dd></dl>
1035
1036<dl class="attribute">
1037<dt id="sans.dataloader.manipulations.SlabX.__hash__">
1038<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__hash__" title="Permalink to this definition">¶</a></dt>
1039<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
1040</dd></dl>
1041
1042<dl class="method">
1043<dt id="sans.dataloader.manipulations.SlabX.__init__">
1044<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__init__" title="Permalink to this definition">¶</a></dt>
1045<dd></dd></dl>
1046
1047<dl class="attribute">
1048<dt id="sans.dataloader.manipulations.SlabX.__module__">
1049<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__module__" title="Permalink to this definition">¶</a></dt>
1050<dd></dd></dl>
1051
1052<dl class="staticmethod">
1053<dt id="sans.dataloader.manipulations.SlabX.__new__">
1054<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__new__" title="Permalink to this definition">¶</a></dt>
1055<dd></dd></dl>
1056
1057<dl class="method">
1058<dt id="sans.dataloader.manipulations.SlabX.__reduce__">
1059<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__reduce__" title="Permalink to this definition">¶</a></dt>
1060<dd><p>helper for pickle</p>
1061</dd></dl>
1062
1063<dl class="method">
1064<dt id="sans.dataloader.manipulations.SlabX.__reduce_ex__">
1065<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
1066<dd><p>helper for pickle</p>
1067</dd></dl>
1068
1069<dl class="attribute">
1070<dt id="sans.dataloader.manipulations.SlabX.__repr__">
1071<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__repr__" title="Permalink to this definition">¶</a></dt>
1072<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
1073</dd></dl>
1074
1075<dl class="attribute">
1076<dt id="sans.dataloader.manipulations.SlabX.__setattr__">
1077<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__setattr__" title="Permalink to this definition">¶</a></dt>
1078<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
1079</dd></dl>
1080
1081<dl class="attribute">
1082<dt id="sans.dataloader.manipulations.SlabX.__str__">
1083<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__str__" title="Permalink to this definition">¶</a></dt>
1084<dd><p>x.__str__() &lt;==&gt; str(x)</p>
1085</dd></dl>
1086
1087<dl class="attribute">
1088<dt id="sans.dataloader.manipulations.SlabX.__weakref__">
1089<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabX.__weakref__" title="Permalink to this definition">¶</a></dt>
1090<dd><p>list of weak references to the object (if defined)</p>
1091</dd></dl>
1092
1093<dl class="method">
1094<dt id="sans.dataloader.manipulations.SlabX._avg">
1095<tt class="descname">_avg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabX._avg" title="Permalink to this definition">¶</a></dt>
1096<dd><p>Compute average I(Q_maj) for a region of interest.
1097The major axis is defined as the axis of Q_maj.
1098The minor axis is the axis that we average over.</p>
1099<table class="docutils field-list" frame="void" rules="none">
1100<col class="field-name" />
1101<col class="field-body" />
1102<tbody valign="top">
1103<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1104<li><strong>data2D</strong> &#8211; Data2D object</li>
1105<li><strong>maj_min</strong> &#8211; min value on the major axis</li>
1106</ul>
1107</td>
1108</tr>
1109<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
1110</td>
1111</tr>
1112</tbody>
1113</table>
1114</dd></dl>
1115
1116</dd></dl>
1117
1118<dl class="class">
1119<dt id="sans.dataloader.manipulations.SlabY">
1120<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">SlabY</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY" title="Permalink to this definition">¶</a></dt>
1121<dd><p>Bases: <a class="reference internal" href="#sans.dataloader.manipulations._Slab" title="sans.dataloader.manipulations._Slab"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.manipulations._Slab</span></tt></a></p>
1122<p>Compute average I(Qy) for a region of interest</p>
1123<dl class="method">
1124<dt id="sans.dataloader.manipulations.SlabY.__call__">
1125<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__call__" title="Permalink to this definition">¶</a></dt>
1126<dd><p>Compute average I(Qy) for a region of interest</p>
1127<table class="docutils field-list" frame="void" rules="none">
1128<col class="field-name" />
1129<col class="field-body" />
1130<tbody valign="top">
1131<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2D</strong> &#8211; Data2D object</td>
1132</tr>
1133<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td>
1134</tr>
1135</tbody>
1136</table>
1137</dd></dl>
1138
1139<dl class="attribute">
1140<dt id="sans.dataloader.manipulations.SlabY.__class__">
1141<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__class__" title="Permalink to this definition">¶</a></dt>
1142<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
1143</dd></dl>
1144
1145<dl class="attribute">
1146<dt id="sans.dataloader.manipulations.SlabY.__delattr__">
1147<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__delattr__" title="Permalink to this definition">¶</a></dt>
1148<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
1149</dd></dl>
1150
1151<dl class="attribute">
1152<dt id="sans.dataloader.manipulations.SlabY.__dict__">
1153<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0294E0F0&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__dict__" title="Permalink to this definition">¶</a></dt>
1154<dd></dd></dl>
1155
1156<dl class="attribute">
1157<dt id="sans.dataloader.manipulations.SlabY.__getattribute__">
1158<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__getattribute__" title="Permalink to this definition">¶</a></dt>
1159<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
1160</dd></dl>
1161
1162<dl class="attribute">
1163<dt id="sans.dataloader.manipulations.SlabY.__hash__">
1164<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__hash__" title="Permalink to this definition">¶</a></dt>
1165<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
1166</dd></dl>
1167
1168<dl class="method">
1169<dt id="sans.dataloader.manipulations.SlabY.__init__">
1170<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__init__" title="Permalink to this definition">¶</a></dt>
1171<dd></dd></dl>
1172
1173<dl class="attribute">
1174<dt id="sans.dataloader.manipulations.SlabY.__module__">
1175<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__module__" title="Permalink to this definition">¶</a></dt>
1176<dd></dd></dl>
1177
1178<dl class="staticmethod">
1179<dt id="sans.dataloader.manipulations.SlabY.__new__">
1180<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__new__" title="Permalink to this definition">¶</a></dt>
1181<dd></dd></dl>
1182
1183<dl class="method">
1184<dt id="sans.dataloader.manipulations.SlabY.__reduce__">
1185<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__reduce__" title="Permalink to this definition">¶</a></dt>
1186<dd><p>helper for pickle</p>
1187</dd></dl>
1188
1189<dl class="method">
1190<dt id="sans.dataloader.manipulations.SlabY.__reduce_ex__">
1191<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
1192<dd><p>helper for pickle</p>
1193</dd></dl>
1194
1195<dl class="attribute">
1196<dt id="sans.dataloader.manipulations.SlabY.__repr__">
1197<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__repr__" title="Permalink to this definition">¶</a></dt>
1198<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
1199</dd></dl>
1200
1201<dl class="attribute">
1202<dt id="sans.dataloader.manipulations.SlabY.__setattr__">
1203<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__setattr__" title="Permalink to this definition">¶</a></dt>
1204<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
1205</dd></dl>
1206
1207<dl class="attribute">
1208<dt id="sans.dataloader.manipulations.SlabY.__str__">
1209<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__str__" title="Permalink to this definition">¶</a></dt>
1210<dd><p>x.__str__() &lt;==&gt; str(x)</p>
1211</dd></dl>
1212
1213<dl class="attribute">
1214<dt id="sans.dataloader.manipulations.SlabY.__weakref__">
1215<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations.SlabY.__weakref__" title="Permalink to this definition">¶</a></dt>
1216<dd><p>list of weak references to the object (if defined)</p>
1217</dd></dl>
1218
1219<dl class="method">
1220<dt id="sans.dataloader.manipulations.SlabY._avg">
1221<tt class="descname">_avg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.SlabY._avg" title="Permalink to this definition">¶</a></dt>
1222<dd><p>Compute average I(Q_maj) for a region of interest.
1223The major axis is defined as the axis of Q_maj.
1224The minor axis is the axis that we average over.</p>
1225<table class="docutils field-list" frame="void" rules="none">
1226<col class="field-name" />
1227<col class="field-body" />
1228<tbody valign="top">
1229<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1230<li><strong>data2D</strong> &#8211; Data2D object</li>
1231<li><strong>maj_min</strong> &#8211; min value on the major axis</li>
1232</ul>
1233</td>
1234</tr>
1235<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
1236</td>
1237</tr>
1238</tbody>
1239</table>
1240</dd></dl>
1241
1242</dd></dl>
1243
1244<dl class="class">
1245<dt id="sans.dataloader.manipulations._Sector">
1246<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">_Sector</tt><a class="headerlink" href="#sans.dataloader.manipulations._Sector" title="Permalink to this definition">¶</a></dt>
1247<dd><p>Defines a sector region on a 2D data set.
1248The sector is defined by r_min, r_max, phi_min, phi_max,
1249and the position of the center of the ring
1250where phi_min and phi_max are defined by the right
1251and left lines wrt central line
1252and phi_max could be less than phi_min.</p>
1253<p>Phi is defined between 0 and 2*pi in anti-clockwise
1254starting from the x- axis on the left-hand side</p>
1255<dl class="method">
1256<dt id="sans.dataloader.manipulations._Sector.__init__">
1257<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Sector.__init__" title="Permalink to this definition">¶</a></dt>
1258<dd></dd></dl>
1259
1260<dl class="attribute">
1261<dt id="sans.dataloader.manipulations._Sector.__module__">
1262<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations._Sector.__module__" title="Permalink to this definition">¶</a></dt>
1263<dd></dd></dl>
1264
1265<dl class="method">
1266<dt id="sans.dataloader.manipulations._Sector._agv">
1267<tt class="descname">_agv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Sector._agv" title="Permalink to this definition">¶</a></dt>
1268<dd><p>Perform sector averaging.</p>
1269<table class="docutils field-list" frame="void" rules="none">
1270<col class="field-name" />
1271<col class="field-body" />
1272<tbody valign="top">
1273<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1274<li><strong>data2D</strong> &#8211; Data2D object</li>
1275<li><strong>run</strong> &#8211; define the varying parameter (&#8216;phi&#8217; , &#8216;q&#8217; , or &#8216;q2&#8217;)</li>
1276</ul>
1277</td>
1278</tr>
1279<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
1280</td>
1281</tr>
1282</tbody>
1283</table>
1284</dd></dl>
1285
1286</dd></dl>
1287
1288<dl class="class">
1289<dt id="sans.dataloader.manipulations._Slab">
1290<em class="property">class </em><tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">_Slab</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab" title="Permalink to this definition">¶</a></dt>
1291<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1292<p>Compute average I(Q) for a region of interest</p>
1293<dl class="method">
1294<dt id="sans.dataloader.manipulations._Slab.__call__">
1295<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__call__" title="Permalink to this definition">¶</a></dt>
1296<dd></dd></dl>
1297
1298<dl class="attribute">
1299<dt id="sans.dataloader.manipulations._Slab.__class__">
1300<tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__class__" title="Permalink to this definition">¶</a></dt>
1301<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
1302</dd></dl>
1303
1304<dl class="attribute">
1305<dt id="sans.dataloader.manipulations._Slab.__delattr__">
1306<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__delattr__" title="Permalink to this definition">¶</a></dt>
1307<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
1308</dd></dl>
1309
1310<dl class="attribute">
1311<dt id="sans.dataloader.manipulations._Slab.__dict__">
1312<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0294E670&gt;</em><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__dict__" title="Permalink to this definition">¶</a></dt>
1313<dd></dd></dl>
1314
1315<dl class="attribute">
1316<dt id="sans.dataloader.manipulations._Slab.__getattribute__">
1317<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__getattribute__" title="Permalink to this definition">¶</a></dt>
1318<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
1319</dd></dl>
1320
1321<dl class="attribute">
1322<dt id="sans.dataloader.manipulations._Slab.__hash__">
1323<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__hash__" title="Permalink to this definition">¶</a></dt>
1324<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
1325</dd></dl>
1326
1327<dl class="method">
1328<dt id="sans.dataloader.manipulations._Slab.__init__">
1329<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__init__" title="Permalink to this definition">¶</a></dt>
1330<dd></dd></dl>
1331
1332<dl class="attribute">
1333<dt id="sans.dataloader.manipulations._Slab.__module__">
1334<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.manipulations'</em><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__module__" title="Permalink to this definition">¶</a></dt>
1335<dd></dd></dl>
1336
1337<dl class="staticmethod">
1338<dt id="sans.dataloader.manipulations._Slab.__new__">
1339<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.manipulations._Slab.__new__" title="Permalink to this definition">¶</a></dt>
1340<dd></dd></dl>
1341
1342<dl class="method">
1343<dt id="sans.dataloader.manipulations._Slab.__reduce__">
1344<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__reduce__" title="Permalink to this definition">¶</a></dt>
1345<dd><p>helper for pickle</p>
1346</dd></dl>
1347
1348<dl class="method">
1349<dt id="sans.dataloader.manipulations._Slab.__reduce_ex__">
1350<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
1351<dd><p>helper for pickle</p>
1352</dd></dl>
1353
1354<dl class="attribute">
1355<dt id="sans.dataloader.manipulations._Slab.__repr__">
1356<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__repr__" title="Permalink to this definition">¶</a></dt>
1357<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
1358</dd></dl>
1359
1360<dl class="attribute">
1361<dt id="sans.dataloader.manipulations._Slab.__setattr__">
1362<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__setattr__" title="Permalink to this definition">¶</a></dt>
1363<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
1364</dd></dl>
1365
1366<dl class="attribute">
1367<dt id="sans.dataloader.manipulations._Slab.__str__">
1368<tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__str__" title="Permalink to this definition">¶</a></dt>
1369<dd><p>x.__str__() &lt;==&gt; str(x)</p>
1370</dd></dl>
1371
1372<dl class="attribute">
1373<dt id="sans.dataloader.manipulations._Slab.__weakref__">
1374<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.manipulations._Slab.__weakref__" title="Permalink to this definition">¶</a></dt>
1375<dd><p>list of weak references to the object (if defined)</p>
1376</dd></dl>
1377
1378<dl class="method">
1379<dt id="sans.dataloader.manipulations._Slab._avg">
1380<tt class="descname">_avg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations._Slab._avg" title="Permalink to this definition">¶</a></dt>
1381<dd><p>Compute average I(Q_maj) for a region of interest.
1382The major axis is defined as the axis of Q_maj.
1383The minor axis is the axis that we average over.</p>
1384<table class="docutils field-list" frame="void" rules="none">
1385<col class="field-name" />
1386<col class="field-body" />
1387<tbody valign="top">
1388<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1389<li><strong>data2D</strong> &#8211; Data2D object</li>
1390<li><strong>maj_min</strong> &#8211; min value on the major axis</li>
1391</ul>
1392</td>
1393</tr>
1394<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Data1D object</p>
1395</td>
1396</tr>
1397</tbody>
1398</table>
1399</dd></dl>
1400
1401</dd></dl>
1402
1403<dl class="function">
1404<dt id="sans.dataloader.manipulations.flip_phi">
1405<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">flip_phi</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.flip_phi" title="Permalink to this definition">¶</a></dt>
1406<dd><p>Correct phi to within the 0 &lt;= to &lt;= 2pi range</p>
1407<table class="docutils field-list" frame="void" rules="none">
1408<col class="field-name" />
1409<col class="field-body" />
1410<tbody valign="top">
1411<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">phi in &gt;=0 and &lt;=2Pi</td>
1412</tr>
1413</tbody>
1414</table>
1415</dd></dl>
1416
1417<dl class="function">
1418<dt id="sans.dataloader.manipulations.get_intercept">
1419<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">get_intercept</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.get_intercept" title="Permalink to this definition">¶</a></dt>
1420<dd><p>Returns the fraction of the side at which the
1421q-value intercept the pixel, None otherwise.
1422The values returned is the fraction ON THE SIDE
1423OF THE LOWEST Q.</p>
1424<div class="highlight-python"><pre>    A           B   
1425+-----------+--------+    &lt;--- pixel size
14260                    1     
1427Q_0 -------- Q ----- Q_1   &lt;--- equivalent Q range
1428if Q_1 &gt; Q_0, A is returned
1429if Q_1 &lt; Q_0, B is returned
1430if Q is outside the range of [Q_0, Q_1], None is returned</pre>
1431</div>
1432</dd></dl>
1433
1434<dl class="function">
1435<dt id="sans.dataloader.manipulations.get_pixel_fraction">
1436<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">get_pixel_fraction</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.get_pixel_fraction" title="Permalink to this definition">¶</a></dt>
1437<dd><p>Returns the fraction of the pixel defined by
1438the four corners (q_00, q_01, q_10, q_11) that
1439has q &lt; qmax.:</p>
1440<div class="highlight-python"><pre>        q_01                q_11
1441y=1         +--------------+
1442            |              |
1443            |              |
1444            |              |
1445y=0         +--------------+
1446        q_00                q_10
1447
1448            x=0            x=1</pre>
1449</div>
1450</dd></dl>
1451
1452<dl class="function">
1453<dt id="sans.dataloader.manipulations.get_pixel_fraction_square">
1454<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">get_pixel_fraction_square</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.get_pixel_fraction_square" title="Permalink to this definition">¶</a></dt>
1455<dd><p>Return the fraction of the length
1456from xmin to x.:</p>
1457<div class="highlight-python"><pre>    A            B
1458+-----------+---------+
1459xmin        x         xmax</pre>
1460</div>
1461<table class="docutils field-list" frame="void" rules="none">
1462<col class="field-name" />
1463<col class="field-body" />
1464<tbody valign="top">
1465<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1466<li><strong>x</strong> &#8211; x-value</li>
1467<li><strong>xmin</strong> &#8211; minimum x for the length considered</li>
1468<li><strong>xmax</strong> &#8211; minimum x for the length considered</li>
1469</ul>
1470</td>
1471</tr>
1472<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">(x-xmin)/(xmax-xmin) when xmin &lt; x &lt; xmax</p>
1473</td>
1474</tr>
1475</tbody>
1476</table>
1477</dd></dl>
1478
1479<dl class="function">
1480<dt id="sans.dataloader.manipulations.get_q">
1481<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">get_q</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.get_q" title="Permalink to this definition">¶</a></dt>
1482<dd><table class="docutils field-list" frame="void" rules="none">
1483<col class="field-name" />
1484<col class="field-body" />
1485<tbody valign="top">
1486<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1487<li><strong>dx</strong> &#8211; x-distance from beam center [mm]</li>
1488<li><strong>dy</strong> &#8211; y-distance from beam center [mm]</li>
1489</ul>
1490</td>
1491</tr>
1492<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">q-value at the given position</p>
1493</td>
1494</tr>
1495</tbody>
1496</table>
1497</dd></dl>
1498
1499<dl class="function">
1500<dt id="sans.dataloader.manipulations.get_q_compo">
1501<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">get_q_compo</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.get_q_compo" title="Permalink to this definition">¶</a></dt>
1502<dd><p>This reduces tiny error at very large q.
1503Implementation of this func is not started yet.&lt;&#8211;ToDo</p>
1504</dd></dl>
1505
1506<dl class="function">
1507<dt id="sans.dataloader.manipulations.reader2D_converter">
1508<tt class="descclassname">sans.dataloader.manipulations.</tt><tt class="descname">reader2D_converter</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.manipulations.reader2D_converter" title="Permalink to this definition">¶</a></dt>
1509<dd><p>convert old 2d format opened by IhorReader or danse_reader
1510to new Data2D format</p>
1511<table class="docutils field-list" frame="void" rules="none">
1512<col class="field-name" />
1513<col class="field-body" />
1514<tbody valign="top">
1515<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2d</strong> &#8211; 2d array of Data2D object</td>
1516</tr>
1517<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">1d arrays of Data2D object</td>
1518</tr>
1519</tbody>
1520</table>
1521</dd></dl>
1522
1523</div>
1524</div>
1525
1526
1527          </div>
1528        </div>
1529      </div>
1530      <div class="sphinxsidebar">
1531        <div class="sphinxsidebarwrapper">
1532  <h3><a href="../index.html">Table Of Contents</a></h3>
1533  <ul>
1534<li><a class="reference internal" href="#">manipulations</a><ul>
1535<li><a class="reference internal" href="#sans-dataloader-manipulations"><tt class="docutils literal"><span class="pre">sans.dataloader.manipulations</span></tt></a></li>
1536</ul>
1537</li>
1538</ul>
1539
1540  <h4>Previous topic</h4>
1541  <p class="topless"><a href="loader.html"
1542                        title="previous chapter">loader</a></p>
1543  <h4>Next topic</h4>
1544  <p class="topless"><a href="readers/index.html"
1545                        title="next chapter">Readers</a></p>
1546  <h3>This Page</h3>
1547  <ul class="this-page-menu">
1548    <li><a href="../_sources/api/manipulations.txt"
1549           rel="nofollow">Show Source</a></li>
1550  </ul>
1551<div id="searchbox" style="display: none">
1552  <h3>Quick search</h3>
1553    <form class="search" action="../search.html" method="get">
1554      <input type="text" name="q" />
1555      <input type="submit" value="Go" />
1556      <input type="hidden" name="check_keywords" value="yes" />
1557      <input type="hidden" name="area" value="default" />
1558    </form>
1559    <p class="searchtip" style="font-size: 90%">
1560    Enter search terms or a module, class or function name.
1561    </p>
1562</div>
1563<script type="text/javascript">$('#searchbox').show(0);</script>
1564        </div>
1565      </div>
1566      <div class="clearer"></div>
1567    </div>
1568    <div class="related">
1569      <h3>Navigation</h3>
1570      <ul>
1571        <li class="right" style="margin-right: 10px">
1572          <a href="../genindex.html" title="General Index"
1573             >index</a></li>
1574        <li class="right" >
1575          <a href="../py-modindex.html" title="Python Module Index"
1576             >modules</a> |</li>
1577        <li class="right" >
1578          <a href="readers/index.html" title="Readers"
1579             >next</a> |</li>
1580        <li class="right" >
1581          <a href="loader.html" title="loader"
1582             >previous</a> |</li>
1583        <li><a href="../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
1584          <li><a href="index.html" >Reference</a> &raquo;</li> 
1585      </ul>
1586    </div>
1587    <div class="footer">
1588        &copy; Copyright 2010, sans group.
1589      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
1590    </div>
1591  </body>
1592</html>
Note: See TracBrowser for help on using the repository browser.