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>data_info — 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="loader" href="loader.html" /> |
---|
31 | <link rel="prev" title="Reference" href="index.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="loader.html" title="loader" |
---|
45 | accesskey="N">next</a> |</li> |
---|
46 | <li class="right" > |
---|
47 | <a href="index.html" title="Reference" |
---|
48 | accesskey="P">previous</a> |</li> |
---|
49 | <li><a href="../index.html">DataLoader 0.1.0 documentation</a> »</li> |
---|
50 | <li><a href="index.html" accesskey="U">Reference</a> »</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="data-info"> |
---|
60 | <h1>data_info<a class="headerlink" href="#data-info" title="Permalink to this headline">¶</a></h1> |
---|
61 | <div class="section" id="sans-dataloader-data-info"> |
---|
62 | <h2><a class="reference internal" href="#module-sans.dataloader.data_info" title="sans.dataloader.data_info"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.data_info</span></tt></a><a class="headerlink" href="#sans-dataloader-data-info" title="Permalink to this headline">¶</a></h2> |
---|
63 | <span class="target" id="module-sans.dataloader.data_info"></span><p>Module that contains classes to hold information read from |
---|
64 | reduced data files.</p> |
---|
65 | <p>A good description of the data members can be found in |
---|
66 | the CanSAS 1D XML data format:</p> |
---|
67 | <p><a class="reference external" href="http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation">http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation</a></p> |
---|
68 | <dl class="class"> |
---|
69 | <dt id="sans.dataloader.data_info.Aperture"> |
---|
70 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Aperture</tt><a class="headerlink" href="#sans.dataloader.data_info.Aperture" title="Permalink to this definition">¶</a></dt> |
---|
71 | <dd><dl class="method"> |
---|
72 | <dt id="sans.dataloader.data_info.Aperture.__init__"> |
---|
73 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Aperture.__init__" title="Permalink to this definition">¶</a></dt> |
---|
74 | <dd></dd></dl> |
---|
75 | |
---|
76 | <dl class="attribute"> |
---|
77 | <dt id="sans.dataloader.data_info.Aperture.__module__"> |
---|
78 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.__module__" title="Permalink to this definition">¶</a></dt> |
---|
79 | <dd></dd></dl> |
---|
80 | |
---|
81 | <dl class="attribute"> |
---|
82 | <dt id="sans.dataloader.data_info.Aperture.distance"> |
---|
83 | <tt class="descname">distance</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.distance" title="Permalink to this definition">¶</a></dt> |
---|
84 | <dd></dd></dl> |
---|
85 | |
---|
86 | <dl class="attribute"> |
---|
87 | <dt id="sans.dataloader.data_info.Aperture.distance_unit"> |
---|
88 | <tt class="descname">distance_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.distance_unit" title="Permalink to this definition">¶</a></dt> |
---|
89 | <dd></dd></dl> |
---|
90 | |
---|
91 | <dl class="attribute"> |
---|
92 | <dt id="sans.dataloader.data_info.Aperture.name"> |
---|
93 | <tt class="descname">name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.name" title="Permalink to this definition">¶</a></dt> |
---|
94 | <dd></dd></dl> |
---|
95 | |
---|
96 | <dl class="attribute"> |
---|
97 | <dt id="sans.dataloader.data_info.Aperture.size"> |
---|
98 | <tt class="descname">size</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.size" title="Permalink to this definition">¶</a></dt> |
---|
99 | <dd></dd></dl> |
---|
100 | |
---|
101 | <dl class="attribute"> |
---|
102 | <dt id="sans.dataloader.data_info.Aperture.size_name"> |
---|
103 | <tt class="descname">size_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.size_name" title="Permalink to this definition">¶</a></dt> |
---|
104 | <dd></dd></dl> |
---|
105 | |
---|
106 | <dl class="attribute"> |
---|
107 | <dt id="sans.dataloader.data_info.Aperture.size_unit"> |
---|
108 | <tt class="descname">size_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.size_unit" title="Permalink to this definition">¶</a></dt> |
---|
109 | <dd></dd></dl> |
---|
110 | |
---|
111 | <dl class="attribute"> |
---|
112 | <dt id="sans.dataloader.data_info.Aperture.type"> |
---|
113 | <tt class="descname">type</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Aperture.type" title="Permalink to this definition">¶</a></dt> |
---|
114 | <dd></dd></dl> |
---|
115 | |
---|
116 | </dd></dl> |
---|
117 | |
---|
118 | <dl class="class"> |
---|
119 | <dt id="sans.dataloader.data_info.Collimation"> |
---|
120 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Collimation</tt><a class="headerlink" href="#sans.dataloader.data_info.Collimation" title="Permalink to this definition">¶</a></dt> |
---|
121 | <dd><p>Class to hold collimation information</p> |
---|
122 | <dl class="method"> |
---|
123 | <dt id="sans.dataloader.data_info.Collimation.__init__"> |
---|
124 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Collimation.__init__" title="Permalink to this definition">¶</a></dt> |
---|
125 | <dd></dd></dl> |
---|
126 | |
---|
127 | <dl class="attribute"> |
---|
128 | <dt id="sans.dataloader.data_info.Collimation.__module__"> |
---|
129 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Collimation.__module__" title="Permalink to this definition">¶</a></dt> |
---|
130 | <dd></dd></dl> |
---|
131 | |
---|
132 | <dl class="method"> |
---|
133 | <dt id="sans.dataloader.data_info.Collimation.__str__"> |
---|
134 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Collimation.__str__" title="Permalink to this definition">¶</a></dt> |
---|
135 | <dd></dd></dl> |
---|
136 | |
---|
137 | <dl class="attribute"> |
---|
138 | <dt id="sans.dataloader.data_info.Collimation.aperture"> |
---|
139 | <tt class="descname">aperture</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Collimation.aperture" title="Permalink to this definition">¶</a></dt> |
---|
140 | <dd></dd></dl> |
---|
141 | |
---|
142 | <dl class="attribute"> |
---|
143 | <dt id="sans.dataloader.data_info.Collimation.length"> |
---|
144 | <tt class="descname">length</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Collimation.length" title="Permalink to this definition">¶</a></dt> |
---|
145 | <dd></dd></dl> |
---|
146 | |
---|
147 | <dl class="attribute"> |
---|
148 | <dt id="sans.dataloader.data_info.Collimation.length_unit"> |
---|
149 | <tt class="descname">length_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Collimation.length_unit" title="Permalink to this definition">¶</a></dt> |
---|
150 | <dd></dd></dl> |
---|
151 | |
---|
152 | <dl class="attribute"> |
---|
153 | <dt id="sans.dataloader.data_info.Collimation.name"> |
---|
154 | <tt class="descname">name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Collimation.name" title="Permalink to this definition">¶</a></dt> |
---|
155 | <dd></dd></dl> |
---|
156 | |
---|
157 | </dd></dl> |
---|
158 | |
---|
159 | <dl class="class"> |
---|
160 | <dt id="sans.dataloader.data_info.Data1D"> |
---|
161 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Data1D</tt><a class="headerlink" href="#sans.dataloader.data_info.Data1D" title="Permalink to this definition">¶</a></dt> |
---|
162 | <dd><p>Bases: <a class="reference internal" href="#sans.dataloader.data_info.plottable_1D" title="sans.dataloader.data_info.plottable_1D"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.plottable_1D</span></tt></a>, <a class="reference internal" href="#sans.dataloader.data_info.DataInfo" title="sans.dataloader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.DataInfo</span></tt></a></p> |
---|
163 | <p>1D data class</p> |
---|
164 | <dl class="method"> |
---|
165 | <dt id="sans.dataloader.data_info.Data1D.__add__"> |
---|
166 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__add__" title="Permalink to this definition">¶</a></dt> |
---|
167 | <dd><p>Add two data sets</p> |
---|
168 | <table class="docutils field-list" frame="void" rules="none"> |
---|
169 | <col class="field-name" /> |
---|
170 | <col class="field-body" /> |
---|
171 | <tbody valign="top"> |
---|
172 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
173 | </tr> |
---|
174 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
175 | </tr> |
---|
176 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
177 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
178 | </tr> |
---|
179 | </tbody> |
---|
180 | </table> |
---|
181 | </dd></dl> |
---|
182 | |
---|
183 | <dl class="method"> |
---|
184 | <dt id="sans.dataloader.data_info.Data1D.__div__"> |
---|
185 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__div__" title="Permalink to this definition">¶</a></dt> |
---|
186 | <dd><p>Divided a data set by another</p> |
---|
187 | <table class="docutils field-list" frame="void" rules="none"> |
---|
188 | <col class="field-name" /> |
---|
189 | <col class="field-body" /> |
---|
190 | <tbody valign="top"> |
---|
191 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
192 | </tr> |
---|
193 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
194 | </tr> |
---|
195 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
196 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
197 | </tr> |
---|
198 | </tbody> |
---|
199 | </table> |
---|
200 | </dd></dl> |
---|
201 | |
---|
202 | <dl class="method"> |
---|
203 | <dt id="sans.dataloader.data_info.Data1D.__init__"> |
---|
204 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
205 | <dd></dd></dl> |
---|
206 | |
---|
207 | <dl class="attribute"> |
---|
208 | <dt id="sans.dataloader.data_info.Data1D.__module__"> |
---|
209 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
210 | <dd></dd></dl> |
---|
211 | |
---|
212 | <dl class="method"> |
---|
213 | <dt id="sans.dataloader.data_info.Data1D.__mul__"> |
---|
214 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
215 | <dd><p>Multiply two data sets</p> |
---|
216 | <table class="docutils field-list" frame="void" rules="none"> |
---|
217 | <col class="field-name" /> |
---|
218 | <col class="field-body" /> |
---|
219 | <tbody valign="top"> |
---|
220 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
221 | </tr> |
---|
222 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
223 | </tr> |
---|
224 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
225 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
226 | </tr> |
---|
227 | </tbody> |
---|
228 | </table> |
---|
229 | </dd></dl> |
---|
230 | |
---|
231 | <dl class="method"> |
---|
232 | <dt id="sans.dataloader.data_info.Data1D.__radd__"> |
---|
233 | <tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__radd__" title="Permalink to this definition">¶</a></dt> |
---|
234 | <dd><p>Add two data sets</p> |
---|
235 | <table class="docutils field-list" frame="void" rules="none"> |
---|
236 | <col class="field-name" /> |
---|
237 | <col class="field-body" /> |
---|
238 | <tbody valign="top"> |
---|
239 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
240 | </tr> |
---|
241 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
242 | </tr> |
---|
243 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
244 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
245 | </tr> |
---|
246 | </tbody> |
---|
247 | </table> |
---|
248 | </dd></dl> |
---|
249 | |
---|
250 | <dl class="method"> |
---|
251 | <dt id="sans.dataloader.data_info.Data1D.__rdiv__"> |
---|
252 | <tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__rdiv__" title="Permalink to this definition">¶</a></dt> |
---|
253 | <dd><p>Divided a data set by another</p> |
---|
254 | <table class="docutils field-list" frame="void" rules="none"> |
---|
255 | <col class="field-name" /> |
---|
256 | <col class="field-body" /> |
---|
257 | <tbody valign="top"> |
---|
258 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
259 | </tr> |
---|
260 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
261 | </tr> |
---|
262 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
263 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
264 | </tr> |
---|
265 | </tbody> |
---|
266 | </table> |
---|
267 | </dd></dl> |
---|
268 | |
---|
269 | <dl class="method"> |
---|
270 | <dt id="sans.dataloader.data_info.Data1D.__rmul__"> |
---|
271 | <tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__rmul__" title="Permalink to this definition">¶</a></dt> |
---|
272 | <dd><p>Multiply two data sets</p> |
---|
273 | <table class="docutils field-list" frame="void" rules="none"> |
---|
274 | <col class="field-name" /> |
---|
275 | <col class="field-body" /> |
---|
276 | <tbody valign="top"> |
---|
277 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
278 | </tr> |
---|
279 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
280 | </tr> |
---|
281 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
282 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
283 | </tr> |
---|
284 | </tbody> |
---|
285 | </table> |
---|
286 | </dd></dl> |
---|
287 | |
---|
288 | <dl class="method"> |
---|
289 | <dt id="sans.dataloader.data_info.Data1D.__rsub__"> |
---|
290 | <tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__rsub__" title="Permalink to this definition">¶</a></dt> |
---|
291 | <dd><p>Subtract two data sets</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>other</strong> – data set to subtract from the current one</td> |
---|
297 | </tr> |
---|
298 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
299 | </tr> |
---|
300 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
301 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
302 | </tr> |
---|
303 | </tbody> |
---|
304 | </table> |
---|
305 | </dd></dl> |
---|
306 | |
---|
307 | <dl class="method"> |
---|
308 | <dt id="sans.dataloader.data_info.Data1D.__str__"> |
---|
309 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__str__" title="Permalink to this definition">¶</a></dt> |
---|
310 | <dd><p>Nice printout</p> |
---|
311 | </dd></dl> |
---|
312 | |
---|
313 | <dl class="method"> |
---|
314 | <dt id="sans.dataloader.data_info.Data1D.__sub__"> |
---|
315 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
316 | <dd><p>Subtract two data sets</p> |
---|
317 | <table class="docutils field-list" frame="void" rules="none"> |
---|
318 | <col class="field-name" /> |
---|
319 | <col class="field-body" /> |
---|
320 | <tbody valign="top"> |
---|
321 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
322 | </tr> |
---|
323 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
324 | </tr> |
---|
325 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
326 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
327 | </tr> |
---|
328 | </tbody> |
---|
329 | </table> |
---|
330 | </dd></dl> |
---|
331 | |
---|
332 | <dl class="method"> |
---|
333 | <dt id="sans.dataloader.data_info.Data1D._perform_operation"> |
---|
334 | <tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D._perform_operation" title="Permalink to this definition">¶</a></dt> |
---|
335 | <dd></dd></dl> |
---|
336 | |
---|
337 | <dl class="method"> |
---|
338 | <dt id="sans.dataloader.data_info.Data1D._validity_check"> |
---|
339 | <tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D._validity_check" title="Permalink to this definition">¶</a></dt> |
---|
340 | <dd><p>Checks that the data lengths are compatible. |
---|
341 | Checks that the x vectors are compatible. |
---|
342 | Returns errors vectors equal to original |
---|
343 | errors vectors if they were present or vectors |
---|
344 | of zeros when none was found.</p> |
---|
345 | <table class="docutils field-list" frame="void" rules="none"> |
---|
346 | <col class="field-name" /> |
---|
347 | <col class="field-body" /> |
---|
348 | <tbody valign="top"> |
---|
349 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – other data set for operation</td> |
---|
350 | </tr> |
---|
351 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> |
---|
352 | </tr> |
---|
353 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
354 | <tr class="field-odd field"><td> </td><td class="field-body">when lengths are not compatible</td> |
---|
355 | </tr> |
---|
356 | </tbody> |
---|
357 | </table> |
---|
358 | </dd></dl> |
---|
359 | |
---|
360 | <dl class="attribute"> |
---|
361 | <dt id="sans.dataloader.data_info.Data1D._xaxis"> |
---|
362 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
363 | <dd></dd></dl> |
---|
364 | |
---|
365 | <dl class="attribute"> |
---|
366 | <dt id="sans.dataloader.data_info.Data1D._xunit"> |
---|
367 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
368 | <dd></dd></dl> |
---|
369 | |
---|
370 | <dl class="attribute"> |
---|
371 | <dt id="sans.dataloader.data_info.Data1D._yaxis"> |
---|
372 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
373 | <dd></dd></dl> |
---|
374 | |
---|
375 | <dl class="attribute"> |
---|
376 | <dt id="sans.dataloader.data_info.Data1D._yunit"> |
---|
377 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
378 | <dd></dd></dl> |
---|
379 | |
---|
380 | <dl class="method"> |
---|
381 | <dt id="sans.dataloader.data_info.Data1D.add_notes"> |
---|
382 | <tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.add_notes" title="Permalink to this definition">¶</a></dt> |
---|
383 | <dd><p>Add notes to datainfo</p> |
---|
384 | </dd></dl> |
---|
385 | |
---|
386 | <dl class="method"> |
---|
387 | <dt id="sans.dataloader.data_info.Data1D.append_empty_process"> |
---|
388 | <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.append_empty_process" title="Permalink to this definition">¶</a></dt> |
---|
389 | <dd></dd></dl> |
---|
390 | |
---|
391 | <dl class="method"> |
---|
392 | <dt id="sans.dataloader.data_info.Data1D.clone_without_data"> |
---|
393 | <tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.clone_without_data" title="Permalink to this definition">¶</a></dt> |
---|
394 | <dd><p>Clone the current object, without copying the data (which |
---|
395 | will be filled out by a subsequent operation). |
---|
396 | The data arrays will be initialized to zero.</p> |
---|
397 | <table class="docutils field-list" frame="void" rules="none"> |
---|
398 | <col class="field-name" /> |
---|
399 | <col class="field-body" /> |
---|
400 | <tbody valign="top"> |
---|
401 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
402 | <li><strong>length</strong> – length of the data array to be initialized</li> |
---|
403 | <li><strong>clone</strong> – if provided, the data will be copied to clone</li> |
---|
404 | </ul> |
---|
405 | </td> |
---|
406 | </tr> |
---|
407 | </tbody> |
---|
408 | </table> |
---|
409 | </dd></dl> |
---|
410 | |
---|
411 | <dl class="attribute"> |
---|
412 | <dt id="sans.dataloader.data_info.Data1D.collimation"> |
---|
413 | <tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.collimation" title="Permalink to this definition">¶</a></dt> |
---|
414 | <dd></dd></dl> |
---|
415 | |
---|
416 | <dl class="attribute"> |
---|
417 | <dt id="sans.dataloader.data_info.Data1D.detector"> |
---|
418 | <tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.detector" title="Permalink to this definition">¶</a></dt> |
---|
419 | <dd></dd></dl> |
---|
420 | |
---|
421 | <dl class="attribute"> |
---|
422 | <dt id="sans.dataloader.data_info.Data1D.dx"> |
---|
423 | <tt class="descname">dx</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.dx" title="Permalink to this definition">¶</a></dt> |
---|
424 | <dd></dd></dl> |
---|
425 | |
---|
426 | <dl class="attribute"> |
---|
427 | <dt id="sans.dataloader.data_info.Data1D.dxl"> |
---|
428 | <tt class="descname">dxl</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.dxl" title="Permalink to this definition">¶</a></dt> |
---|
429 | <dd></dd></dl> |
---|
430 | |
---|
431 | <dl class="attribute"> |
---|
432 | <dt id="sans.dataloader.data_info.Data1D.dxw"> |
---|
433 | <tt class="descname">dxw</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.dxw" title="Permalink to this definition">¶</a></dt> |
---|
434 | <dd></dd></dl> |
---|
435 | |
---|
436 | <dl class="attribute"> |
---|
437 | <dt id="sans.dataloader.data_info.Data1D.dy"> |
---|
438 | <tt class="descname">dy</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.dy" title="Permalink to this definition">¶</a></dt> |
---|
439 | <dd></dd></dl> |
---|
440 | |
---|
441 | <dl class="attribute"> |
---|
442 | <dt id="sans.dataloader.data_info.Data1D.errors"> |
---|
443 | <tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.errors" title="Permalink to this definition">¶</a></dt> |
---|
444 | <dd></dd></dl> |
---|
445 | |
---|
446 | <dl class="attribute"> |
---|
447 | <dt id="sans.dataloader.data_info.Data1D.filename"> |
---|
448 | <tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.filename" title="Permalink to this definition">¶</a></dt> |
---|
449 | <dd></dd></dl> |
---|
450 | |
---|
451 | <dl class="attribute"> |
---|
452 | <dt id="sans.dataloader.data_info.Data1D.instrument"> |
---|
453 | <tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.instrument" title="Permalink to this definition">¶</a></dt> |
---|
454 | <dd></dd></dl> |
---|
455 | |
---|
456 | <dl class="method"> |
---|
457 | <dt id="sans.dataloader.data_info.Data1D.is_slit_smeared"> |
---|
458 | <tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt> |
---|
459 | <dd><p>Check whether the data has slit smearing information</p> |
---|
460 | <table class="docutils field-list" frame="void" rules="none"> |
---|
461 | <col class="field-name" /> |
---|
462 | <col class="field-body" /> |
---|
463 | <tbody valign="top"> |
---|
464 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td> |
---|
465 | </tr> |
---|
466 | </tbody> |
---|
467 | </table> |
---|
468 | </dd></dl> |
---|
469 | |
---|
470 | <dl class="attribute"> |
---|
471 | <dt id="sans.dataloader.data_info.Data1D.meta_data"> |
---|
472 | <tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.meta_data" title="Permalink to this definition">¶</a></dt> |
---|
473 | <dd></dd></dl> |
---|
474 | |
---|
475 | <dl class="attribute"> |
---|
476 | <dt id="sans.dataloader.data_info.Data1D.notes"> |
---|
477 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.notes" title="Permalink to this definition">¶</a></dt> |
---|
478 | <dd></dd></dl> |
---|
479 | |
---|
480 | <dl class="attribute"> |
---|
481 | <dt id="sans.dataloader.data_info.Data1D.process"> |
---|
482 | <tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.process" title="Permalink to this definition">¶</a></dt> |
---|
483 | <dd></dd></dl> |
---|
484 | |
---|
485 | <dl class="attribute"> |
---|
486 | <dt id="sans.dataloader.data_info.Data1D.run"> |
---|
487 | <tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.run" title="Permalink to this definition">¶</a></dt> |
---|
488 | <dd></dd></dl> |
---|
489 | |
---|
490 | <dl class="attribute"> |
---|
491 | <dt id="sans.dataloader.data_info.Data1D.run_name"> |
---|
492 | <tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.run_name" title="Permalink to this definition">¶</a></dt> |
---|
493 | <dd></dd></dl> |
---|
494 | |
---|
495 | <dl class="attribute"> |
---|
496 | <dt id="sans.dataloader.data_info.Data1D.sample"> |
---|
497 | <tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.sample" title="Permalink to this definition">¶</a></dt> |
---|
498 | <dd></dd></dl> |
---|
499 | |
---|
500 | <dl class="attribute"> |
---|
501 | <dt id="sans.dataloader.data_info.Data1D.source"> |
---|
502 | <tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.source" title="Permalink to this definition">¶</a></dt> |
---|
503 | <dd></dd></dl> |
---|
504 | |
---|
505 | <dl class="attribute"> |
---|
506 | <dt id="sans.dataloader.data_info.Data1D.title"> |
---|
507 | <tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.title" title="Permalink to this definition">¶</a></dt> |
---|
508 | <dd></dd></dl> |
---|
509 | |
---|
510 | <dl class="attribute"> |
---|
511 | <dt id="sans.dataloader.data_info.Data1D.x"> |
---|
512 | <tt class="descname">x</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.x" title="Permalink to this definition">¶</a></dt> |
---|
513 | <dd></dd></dl> |
---|
514 | |
---|
515 | <dl class="attribute"> |
---|
516 | <dt id="sans.dataloader.data_info.Data1D.x_unit"> |
---|
517 | <tt class="descname">x_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.x_unit" title="Permalink to this definition">¶</a></dt> |
---|
518 | <dd></dd></dl> |
---|
519 | |
---|
520 | <dl class="method"> |
---|
521 | <dt id="sans.dataloader.data_info.Data1D.xaxis"> |
---|
522 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
523 | <dd><p>set the x axis label and unit</p> |
---|
524 | </dd></dl> |
---|
525 | |
---|
526 | <dl class="attribute"> |
---|
527 | <dt id="sans.dataloader.data_info.Data1D.y"> |
---|
528 | <tt class="descname">y</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.y" title="Permalink to this definition">¶</a></dt> |
---|
529 | <dd></dd></dl> |
---|
530 | |
---|
531 | <dl class="attribute"> |
---|
532 | <dt id="sans.dataloader.data_info.Data1D.y_unit"> |
---|
533 | <tt class="descname">y_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.dataloader.data_info.Data1D.y_unit" title="Permalink to this definition">¶</a></dt> |
---|
534 | <dd></dd></dl> |
---|
535 | |
---|
536 | <dl class="method"> |
---|
537 | <dt id="sans.dataloader.data_info.Data1D.yaxis"> |
---|
538 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data1D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
539 | <dd><p>set the y axis label and unit</p> |
---|
540 | </dd></dl> |
---|
541 | |
---|
542 | </dd></dl> |
---|
543 | |
---|
544 | <dl class="class"> |
---|
545 | <dt id="sans.dataloader.data_info.Data2D"> |
---|
546 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Data2D</tt><a class="headerlink" href="#sans.dataloader.data_info.Data2D" title="Permalink to this definition">¶</a></dt> |
---|
547 | <dd><p>Bases: <a class="reference internal" href="#sans.dataloader.data_info.plottable_2D" title="sans.dataloader.data_info.plottable_2D"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.plottable_2D</span></tt></a>, <a class="reference internal" href="#sans.dataloader.data_info.DataInfo" title="sans.dataloader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.DataInfo</span></tt></a></p> |
---|
548 | <p>2D data class</p> |
---|
549 | <dl class="attribute"> |
---|
550 | <dt id="sans.dataloader.data_info.Data2D.I_unit"> |
---|
551 | <tt class="descname">I_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.I_unit" title="Permalink to this definition">¶</a></dt> |
---|
552 | <dd></dd></dl> |
---|
553 | |
---|
554 | <dl class="attribute"> |
---|
555 | <dt id="sans.dataloader.data_info.Data2D.Q_unit"> |
---|
556 | <tt class="descname">Q_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.Q_unit" title="Permalink to this definition">¶</a></dt> |
---|
557 | <dd></dd></dl> |
---|
558 | |
---|
559 | <dl class="method"> |
---|
560 | <dt id="sans.dataloader.data_info.Data2D.__add__"> |
---|
561 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__add__" title="Permalink to this definition">¶</a></dt> |
---|
562 | <dd><p>Add two data sets</p> |
---|
563 | <table class="docutils field-list" frame="void" rules="none"> |
---|
564 | <col class="field-name" /> |
---|
565 | <col class="field-body" /> |
---|
566 | <tbody valign="top"> |
---|
567 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
568 | </tr> |
---|
569 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
570 | </tr> |
---|
571 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
572 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
573 | </tr> |
---|
574 | </tbody> |
---|
575 | </table> |
---|
576 | </dd></dl> |
---|
577 | |
---|
578 | <dl class="method"> |
---|
579 | <dt id="sans.dataloader.data_info.Data2D.__div__"> |
---|
580 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__div__" title="Permalink to this definition">¶</a></dt> |
---|
581 | <dd><p>Divided a data set by another</p> |
---|
582 | <table class="docutils field-list" frame="void" rules="none"> |
---|
583 | <col class="field-name" /> |
---|
584 | <col class="field-body" /> |
---|
585 | <tbody valign="top"> |
---|
586 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
587 | </tr> |
---|
588 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
589 | </tr> |
---|
590 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
591 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
592 | </tr> |
---|
593 | </tbody> |
---|
594 | </table> |
---|
595 | </dd></dl> |
---|
596 | |
---|
597 | <dl class="method"> |
---|
598 | <dt id="sans.dataloader.data_info.Data2D.__init__"> |
---|
599 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
600 | <dd></dd></dl> |
---|
601 | |
---|
602 | <dl class="attribute"> |
---|
603 | <dt id="sans.dataloader.data_info.Data2D.__module__"> |
---|
604 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
605 | <dd></dd></dl> |
---|
606 | |
---|
607 | <dl class="method"> |
---|
608 | <dt id="sans.dataloader.data_info.Data2D.__mul__"> |
---|
609 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
610 | <dd><p>Multiply two data sets</p> |
---|
611 | <table class="docutils field-list" frame="void" rules="none"> |
---|
612 | <col class="field-name" /> |
---|
613 | <col class="field-body" /> |
---|
614 | <tbody valign="top"> |
---|
615 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
616 | </tr> |
---|
617 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
618 | </tr> |
---|
619 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
620 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
621 | </tr> |
---|
622 | </tbody> |
---|
623 | </table> |
---|
624 | </dd></dl> |
---|
625 | |
---|
626 | <dl class="method"> |
---|
627 | <dt id="sans.dataloader.data_info.Data2D.__radd__"> |
---|
628 | <tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__radd__" title="Permalink to this definition">¶</a></dt> |
---|
629 | <dd><p>Add two data sets</p> |
---|
630 | <table class="docutils field-list" frame="void" rules="none"> |
---|
631 | <col class="field-name" /> |
---|
632 | <col class="field-body" /> |
---|
633 | <tbody valign="top"> |
---|
634 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
635 | </tr> |
---|
636 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
637 | </tr> |
---|
638 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
639 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
640 | </tr> |
---|
641 | </tbody> |
---|
642 | </table> |
---|
643 | </dd></dl> |
---|
644 | |
---|
645 | <dl class="method"> |
---|
646 | <dt id="sans.dataloader.data_info.Data2D.__rdiv__"> |
---|
647 | <tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__rdiv__" title="Permalink to this definition">¶</a></dt> |
---|
648 | <dd><p>Divided a data set by another</p> |
---|
649 | <table class="docutils field-list" frame="void" rules="none"> |
---|
650 | <col class="field-name" /> |
---|
651 | <col class="field-body" /> |
---|
652 | <tbody valign="top"> |
---|
653 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
654 | </tr> |
---|
655 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
656 | </tr> |
---|
657 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
658 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
659 | </tr> |
---|
660 | </tbody> |
---|
661 | </table> |
---|
662 | </dd></dl> |
---|
663 | |
---|
664 | <dl class="method"> |
---|
665 | <dt id="sans.dataloader.data_info.Data2D.__rmul__"> |
---|
666 | <tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__rmul__" title="Permalink to this definition">¶</a></dt> |
---|
667 | <dd><p>Multiply two data sets</p> |
---|
668 | <table class="docutils field-list" frame="void" rules="none"> |
---|
669 | <col class="field-name" /> |
---|
670 | <col class="field-body" /> |
---|
671 | <tbody valign="top"> |
---|
672 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
673 | </tr> |
---|
674 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
675 | </tr> |
---|
676 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
677 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
678 | </tr> |
---|
679 | </tbody> |
---|
680 | </table> |
---|
681 | </dd></dl> |
---|
682 | |
---|
683 | <dl class="method"> |
---|
684 | <dt id="sans.dataloader.data_info.Data2D.__rsub__"> |
---|
685 | <tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__rsub__" title="Permalink to this definition">¶</a></dt> |
---|
686 | <dd><p>Subtract two data sets</p> |
---|
687 | <table class="docutils field-list" frame="void" rules="none"> |
---|
688 | <col class="field-name" /> |
---|
689 | <col class="field-body" /> |
---|
690 | <tbody valign="top"> |
---|
691 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
692 | </tr> |
---|
693 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
694 | </tr> |
---|
695 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
696 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
697 | </tr> |
---|
698 | </tbody> |
---|
699 | </table> |
---|
700 | </dd></dl> |
---|
701 | |
---|
702 | <dl class="method"> |
---|
703 | <dt id="sans.dataloader.data_info.Data2D.__str__"> |
---|
704 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__str__" title="Permalink to this definition">¶</a></dt> |
---|
705 | <dd></dd></dl> |
---|
706 | |
---|
707 | <dl class="method"> |
---|
708 | <dt id="sans.dataloader.data_info.Data2D.__sub__"> |
---|
709 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
710 | <dd><p>Subtract two data sets</p> |
---|
711 | <table class="docutils field-list" frame="void" rules="none"> |
---|
712 | <col class="field-name" /> |
---|
713 | <col class="field-body" /> |
---|
714 | <tbody valign="top"> |
---|
715 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
716 | </tr> |
---|
717 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
718 | </tr> |
---|
719 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
720 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
721 | </tr> |
---|
722 | </tbody> |
---|
723 | </table> |
---|
724 | </dd></dl> |
---|
725 | |
---|
726 | <dl class="method"> |
---|
727 | <dt id="sans.dataloader.data_info.Data2D._perform_operation"> |
---|
728 | <tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D._perform_operation" title="Permalink to this definition">¶</a></dt> |
---|
729 | <dd><p>Perform 2D operations between data sets</p> |
---|
730 | <table class="docutils field-list" frame="void" rules="none"> |
---|
731 | <col class="field-name" /> |
---|
732 | <col class="field-body" /> |
---|
733 | <tbody valign="top"> |
---|
734 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
735 | <li><strong>other</strong> – other data set</li> |
---|
736 | <li><strong>operation</strong> – function defining the operation</li> |
---|
737 | </ul> |
---|
738 | </td> |
---|
739 | </tr> |
---|
740 | </tbody> |
---|
741 | </table> |
---|
742 | </dd></dl> |
---|
743 | |
---|
744 | <dl class="method"> |
---|
745 | <dt id="sans.dataloader.data_info.Data2D._validity_check"> |
---|
746 | <tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D._validity_check" title="Permalink to this definition">¶</a></dt> |
---|
747 | <dd><p>Checks that the data lengths are compatible. |
---|
748 | Checks that the x vectors are compatible. |
---|
749 | Returns errors vectors equal to original |
---|
750 | errors vectors if they were present or vectors |
---|
751 | of zeros when none was found.</p> |
---|
752 | <table class="docutils field-list" frame="void" rules="none"> |
---|
753 | <col class="field-name" /> |
---|
754 | <col class="field-body" /> |
---|
755 | <tbody valign="top"> |
---|
756 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – other data set for operation</td> |
---|
757 | </tr> |
---|
758 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> |
---|
759 | </tr> |
---|
760 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
761 | <tr class="field-odd field"><td> </td><td class="field-body">when lengths are not compatible</td> |
---|
762 | </tr> |
---|
763 | </tbody> |
---|
764 | </table> |
---|
765 | </dd></dl> |
---|
766 | |
---|
767 | <dl class="attribute"> |
---|
768 | <dt id="sans.dataloader.data_info.Data2D._xaxis"> |
---|
769 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
770 | <dd></dd></dl> |
---|
771 | |
---|
772 | <dl class="attribute"> |
---|
773 | <dt id="sans.dataloader.data_info.Data2D._xunit"> |
---|
774 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
775 | <dd></dd></dl> |
---|
776 | |
---|
777 | <dl class="attribute"> |
---|
778 | <dt id="sans.dataloader.data_info.Data2D._yaxis"> |
---|
779 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
780 | <dd></dd></dl> |
---|
781 | |
---|
782 | <dl class="attribute"> |
---|
783 | <dt id="sans.dataloader.data_info.Data2D._yunit"> |
---|
784 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
785 | <dd></dd></dl> |
---|
786 | |
---|
787 | <dl class="attribute"> |
---|
788 | <dt id="sans.dataloader.data_info.Data2D._zaxis"> |
---|
789 | <tt class="descname">_zaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._zaxis" title="Permalink to this definition">¶</a></dt> |
---|
790 | <dd></dd></dl> |
---|
791 | |
---|
792 | <dl class="attribute"> |
---|
793 | <dt id="sans.dataloader.data_info.Data2D._zunit"> |
---|
794 | <tt class="descname">_zunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D._zunit" title="Permalink to this definition">¶</a></dt> |
---|
795 | <dd></dd></dl> |
---|
796 | |
---|
797 | <dl class="method"> |
---|
798 | <dt id="sans.dataloader.data_info.Data2D.add_notes"> |
---|
799 | <tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.add_notes" title="Permalink to this definition">¶</a></dt> |
---|
800 | <dd><p>Add notes to datainfo</p> |
---|
801 | </dd></dl> |
---|
802 | |
---|
803 | <dl class="method"> |
---|
804 | <dt id="sans.dataloader.data_info.Data2D.append_empty_process"> |
---|
805 | <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.append_empty_process" title="Permalink to this definition">¶</a></dt> |
---|
806 | <dd></dd></dl> |
---|
807 | |
---|
808 | <dl class="method"> |
---|
809 | <dt id="sans.dataloader.data_info.Data2D.clone_without_data"> |
---|
810 | <tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.clone_without_data" title="Permalink to this definition">¶</a></dt> |
---|
811 | <dd><p>Clone the current object, without copying the data (which |
---|
812 | will be filled out by a subsequent operation). |
---|
813 | The data arrays will be initialized to zero.</p> |
---|
814 | <table class="docutils field-list" frame="void" rules="none"> |
---|
815 | <col class="field-name" /> |
---|
816 | <col class="field-body" /> |
---|
817 | <tbody valign="top"> |
---|
818 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
819 | <li><strong>length</strong> – length of the data array to be initialized</li> |
---|
820 | <li><strong>clone</strong> – if provided, the data will be copied to clone</li> |
---|
821 | </ul> |
---|
822 | </td> |
---|
823 | </tr> |
---|
824 | </tbody> |
---|
825 | </table> |
---|
826 | </dd></dl> |
---|
827 | |
---|
828 | <dl class="attribute"> |
---|
829 | <dt id="sans.dataloader.data_info.Data2D.collimation"> |
---|
830 | <tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.collimation" title="Permalink to this definition">¶</a></dt> |
---|
831 | <dd></dd></dl> |
---|
832 | |
---|
833 | <dl class="attribute"> |
---|
834 | <dt id="sans.dataloader.data_info.Data2D.data"> |
---|
835 | <tt class="descname">data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.data" title="Permalink to this definition">¶</a></dt> |
---|
836 | <dd></dd></dl> |
---|
837 | |
---|
838 | <dl class="attribute"> |
---|
839 | <dt id="sans.dataloader.data_info.Data2D.detector"> |
---|
840 | <tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.detector" title="Permalink to this definition">¶</a></dt> |
---|
841 | <dd></dd></dl> |
---|
842 | |
---|
843 | <dl class="attribute"> |
---|
844 | <dt id="sans.dataloader.data_info.Data2D.dqx_data"> |
---|
845 | <tt class="descname">dqx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.dqx_data" title="Permalink to this definition">¶</a></dt> |
---|
846 | <dd></dd></dl> |
---|
847 | |
---|
848 | <dl class="attribute"> |
---|
849 | <dt id="sans.dataloader.data_info.Data2D.dqy_data"> |
---|
850 | <tt class="descname">dqy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.dqy_data" title="Permalink to this definition">¶</a></dt> |
---|
851 | <dd></dd></dl> |
---|
852 | |
---|
853 | <dl class="attribute"> |
---|
854 | <dt id="sans.dataloader.data_info.Data2D.err_data"> |
---|
855 | <tt class="descname">err_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.err_data" title="Permalink to this definition">¶</a></dt> |
---|
856 | <dd></dd></dl> |
---|
857 | |
---|
858 | <dl class="attribute"> |
---|
859 | <dt id="sans.dataloader.data_info.Data2D.errors"> |
---|
860 | <tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.errors" title="Permalink to this definition">¶</a></dt> |
---|
861 | <dd></dd></dl> |
---|
862 | |
---|
863 | <dl class="attribute"> |
---|
864 | <dt id="sans.dataloader.data_info.Data2D.filename"> |
---|
865 | <tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.filename" title="Permalink to this definition">¶</a></dt> |
---|
866 | <dd></dd></dl> |
---|
867 | |
---|
868 | <dl class="attribute"> |
---|
869 | <dt id="sans.dataloader.data_info.Data2D.instrument"> |
---|
870 | <tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.instrument" title="Permalink to this definition">¶</a></dt> |
---|
871 | <dd></dd></dl> |
---|
872 | |
---|
873 | <dl class="attribute"> |
---|
874 | <dt id="sans.dataloader.data_info.Data2D.mask"> |
---|
875 | <tt class="descname">mask</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.mask" title="Permalink to this definition">¶</a></dt> |
---|
876 | <dd></dd></dl> |
---|
877 | |
---|
878 | <dl class="attribute"> |
---|
879 | <dt id="sans.dataloader.data_info.Data2D.meta_data"> |
---|
880 | <tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.meta_data" title="Permalink to this definition">¶</a></dt> |
---|
881 | <dd></dd></dl> |
---|
882 | |
---|
883 | <dl class="attribute"> |
---|
884 | <dt id="sans.dataloader.data_info.Data2D.notes"> |
---|
885 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.notes" title="Permalink to this definition">¶</a></dt> |
---|
886 | <dd></dd></dl> |
---|
887 | |
---|
888 | <dl class="attribute"> |
---|
889 | <dt id="sans.dataloader.data_info.Data2D.process"> |
---|
890 | <tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.process" title="Permalink to this definition">¶</a></dt> |
---|
891 | <dd></dd></dl> |
---|
892 | |
---|
893 | <dl class="attribute"> |
---|
894 | <dt id="sans.dataloader.data_info.Data2D.q_data"> |
---|
895 | <tt class="descname">q_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.q_data" title="Permalink to this definition">¶</a></dt> |
---|
896 | <dd></dd></dl> |
---|
897 | |
---|
898 | <dl class="attribute"> |
---|
899 | <dt id="sans.dataloader.data_info.Data2D.qx_data"> |
---|
900 | <tt class="descname">qx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.qx_data" title="Permalink to this definition">¶</a></dt> |
---|
901 | <dd></dd></dl> |
---|
902 | |
---|
903 | <dl class="attribute"> |
---|
904 | <dt id="sans.dataloader.data_info.Data2D.qy_data"> |
---|
905 | <tt class="descname">qy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.qy_data" title="Permalink to this definition">¶</a></dt> |
---|
906 | <dd></dd></dl> |
---|
907 | |
---|
908 | <dl class="attribute"> |
---|
909 | <dt id="sans.dataloader.data_info.Data2D.run"> |
---|
910 | <tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.run" title="Permalink to this definition">¶</a></dt> |
---|
911 | <dd></dd></dl> |
---|
912 | |
---|
913 | <dl class="attribute"> |
---|
914 | <dt id="sans.dataloader.data_info.Data2D.run_name"> |
---|
915 | <tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.run_name" title="Permalink to this definition">¶</a></dt> |
---|
916 | <dd></dd></dl> |
---|
917 | |
---|
918 | <dl class="attribute"> |
---|
919 | <dt id="sans.dataloader.data_info.Data2D.sample"> |
---|
920 | <tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.sample" title="Permalink to this definition">¶</a></dt> |
---|
921 | <dd></dd></dl> |
---|
922 | |
---|
923 | <dl class="attribute"> |
---|
924 | <dt id="sans.dataloader.data_info.Data2D.source"> |
---|
925 | <tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.source" title="Permalink to this definition">¶</a></dt> |
---|
926 | <dd></dd></dl> |
---|
927 | |
---|
928 | <dl class="attribute"> |
---|
929 | <dt id="sans.dataloader.data_info.Data2D.title"> |
---|
930 | <tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.title" title="Permalink to this definition">¶</a></dt> |
---|
931 | <dd></dd></dl> |
---|
932 | |
---|
933 | <dl class="attribute"> |
---|
934 | <dt id="sans.dataloader.data_info.Data2D.x_bins"> |
---|
935 | <tt class="descname">x_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.x_bins" title="Permalink to this definition">¶</a></dt> |
---|
936 | <dd></dd></dl> |
---|
937 | |
---|
938 | <dl class="method"> |
---|
939 | <dt id="sans.dataloader.data_info.Data2D.xaxis"> |
---|
940 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
941 | <dd><p>set the x axis label and unit</p> |
---|
942 | </dd></dl> |
---|
943 | |
---|
944 | <dl class="attribute"> |
---|
945 | <dt id="sans.dataloader.data_info.Data2D.xmax"> |
---|
946 | <tt class="descname">xmax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.xmax" title="Permalink to this definition">¶</a></dt> |
---|
947 | <dd></dd></dl> |
---|
948 | |
---|
949 | <dl class="attribute"> |
---|
950 | <dt id="sans.dataloader.data_info.Data2D.xmin"> |
---|
951 | <tt class="descname">xmin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.xmin" title="Permalink to this definition">¶</a></dt> |
---|
952 | <dd></dd></dl> |
---|
953 | |
---|
954 | <dl class="attribute"> |
---|
955 | <dt id="sans.dataloader.data_info.Data2D.y_bins"> |
---|
956 | <tt class="descname">y_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.y_bins" title="Permalink to this definition">¶</a></dt> |
---|
957 | <dd></dd></dl> |
---|
958 | |
---|
959 | <dl class="method"> |
---|
960 | <dt id="sans.dataloader.data_info.Data2D.yaxis"> |
---|
961 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
962 | <dd><p>set the y axis label and unit</p> |
---|
963 | </dd></dl> |
---|
964 | |
---|
965 | <dl class="attribute"> |
---|
966 | <dt id="sans.dataloader.data_info.Data2D.ymax"> |
---|
967 | <tt class="descname">ymax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.ymax" title="Permalink to this definition">¶</a></dt> |
---|
968 | <dd></dd></dl> |
---|
969 | |
---|
970 | <dl class="attribute"> |
---|
971 | <dt id="sans.dataloader.data_info.Data2D.ymin"> |
---|
972 | <tt class="descname">ymin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Data2D.ymin" title="Permalink to this definition">¶</a></dt> |
---|
973 | <dd></dd></dl> |
---|
974 | |
---|
975 | <dl class="method"> |
---|
976 | <dt id="sans.dataloader.data_info.Data2D.zaxis"> |
---|
977 | <tt class="descname">zaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Data2D.zaxis" title="Permalink to this definition">¶</a></dt> |
---|
978 | <dd><p>set the z axis label and unit</p> |
---|
979 | </dd></dl> |
---|
980 | |
---|
981 | </dd></dl> |
---|
982 | |
---|
983 | <dl class="class"> |
---|
984 | <dt id="sans.dataloader.data_info.DataInfo"> |
---|
985 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">DataInfo</tt><a class="headerlink" href="#sans.dataloader.data_info.DataInfo" title="Permalink to this definition">¶</a></dt> |
---|
986 | <dd><p>Class to hold the data read from a file. |
---|
987 | It includes four blocks of data for the |
---|
988 | instrument description, the sample description, |
---|
989 | the data itself and any other meta data.</p> |
---|
990 | <dl class="method"> |
---|
991 | <dt id="sans.dataloader.data_info.DataInfo.__add__"> |
---|
992 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__add__" title="Permalink to this definition">¶</a></dt> |
---|
993 | <dd><p>Add two data sets</p> |
---|
994 | <table class="docutils field-list" frame="void" rules="none"> |
---|
995 | <col class="field-name" /> |
---|
996 | <col class="field-body" /> |
---|
997 | <tbody valign="top"> |
---|
998 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
999 | </tr> |
---|
1000 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1001 | </tr> |
---|
1002 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1003 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1004 | </tr> |
---|
1005 | </tbody> |
---|
1006 | </table> |
---|
1007 | </dd></dl> |
---|
1008 | |
---|
1009 | <dl class="method"> |
---|
1010 | <dt id="sans.dataloader.data_info.DataInfo.__div__"> |
---|
1011 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__div__" title="Permalink to this definition">¶</a></dt> |
---|
1012 | <dd><p>Divided a data set by another</p> |
---|
1013 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1014 | <col class="field-name" /> |
---|
1015 | <col class="field-body" /> |
---|
1016 | <tbody valign="top"> |
---|
1017 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
1018 | </tr> |
---|
1019 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1020 | </tr> |
---|
1021 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1022 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1023 | </tr> |
---|
1024 | </tbody> |
---|
1025 | </table> |
---|
1026 | </dd></dl> |
---|
1027 | |
---|
1028 | <dl class="method"> |
---|
1029 | <dt id="sans.dataloader.data_info.DataInfo.__init__"> |
---|
1030 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1031 | <dd><p>Initialization</p> |
---|
1032 | </dd></dl> |
---|
1033 | |
---|
1034 | <dl class="attribute"> |
---|
1035 | <dt id="sans.dataloader.data_info.DataInfo.__module__"> |
---|
1036 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1037 | <dd></dd></dl> |
---|
1038 | |
---|
1039 | <dl class="method"> |
---|
1040 | <dt id="sans.dataloader.data_info.DataInfo.__mul__"> |
---|
1041 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
1042 | <dd><p>Multiply two data sets</p> |
---|
1043 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1044 | <col class="field-name" /> |
---|
1045 | <col class="field-body" /> |
---|
1046 | <tbody valign="top"> |
---|
1047 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
1048 | </tr> |
---|
1049 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1050 | </tr> |
---|
1051 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1052 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1053 | </tr> |
---|
1054 | </tbody> |
---|
1055 | </table> |
---|
1056 | </dd></dl> |
---|
1057 | |
---|
1058 | <dl class="method"> |
---|
1059 | <dt id="sans.dataloader.data_info.DataInfo.__radd__"> |
---|
1060 | <tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__radd__" title="Permalink to this definition">¶</a></dt> |
---|
1061 | <dd><p>Add two data sets</p> |
---|
1062 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1063 | <col class="field-name" /> |
---|
1064 | <col class="field-body" /> |
---|
1065 | <tbody valign="top"> |
---|
1066 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
1067 | </tr> |
---|
1068 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1069 | </tr> |
---|
1070 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1071 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1072 | </tr> |
---|
1073 | </tbody> |
---|
1074 | </table> |
---|
1075 | </dd></dl> |
---|
1076 | |
---|
1077 | <dl class="method"> |
---|
1078 | <dt id="sans.dataloader.data_info.DataInfo.__rdiv__"> |
---|
1079 | <tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__rdiv__" title="Permalink to this definition">¶</a></dt> |
---|
1080 | <dd><p>Divided a data set by another</p> |
---|
1081 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1082 | <col class="field-name" /> |
---|
1083 | <col class="field-body" /> |
---|
1084 | <tbody valign="top"> |
---|
1085 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
1086 | </tr> |
---|
1087 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1088 | </tr> |
---|
1089 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1090 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1091 | </tr> |
---|
1092 | </tbody> |
---|
1093 | </table> |
---|
1094 | </dd></dl> |
---|
1095 | |
---|
1096 | <dl class="method"> |
---|
1097 | <dt id="sans.dataloader.data_info.DataInfo.__rmul__"> |
---|
1098 | <tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__rmul__" title="Permalink to this definition">¶</a></dt> |
---|
1099 | <dd><p>Multiply two data sets</p> |
---|
1100 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1101 | <col class="field-name" /> |
---|
1102 | <col class="field-body" /> |
---|
1103 | <tbody valign="top"> |
---|
1104 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
1105 | </tr> |
---|
1106 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1107 | </tr> |
---|
1108 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1109 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1110 | </tr> |
---|
1111 | </tbody> |
---|
1112 | </table> |
---|
1113 | </dd></dl> |
---|
1114 | |
---|
1115 | <dl class="method"> |
---|
1116 | <dt id="sans.dataloader.data_info.DataInfo.__rsub__"> |
---|
1117 | <tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__rsub__" title="Permalink to this definition">¶</a></dt> |
---|
1118 | <dd><p>Subtract two data sets</p> |
---|
1119 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1120 | <col class="field-name" /> |
---|
1121 | <col class="field-body" /> |
---|
1122 | <tbody valign="top"> |
---|
1123 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
1124 | </tr> |
---|
1125 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1126 | </tr> |
---|
1127 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1128 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1129 | </tr> |
---|
1130 | </tbody> |
---|
1131 | </table> |
---|
1132 | </dd></dl> |
---|
1133 | |
---|
1134 | <dl class="method"> |
---|
1135 | <dt id="sans.dataloader.data_info.DataInfo.__str__"> |
---|
1136 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1137 | <dd><p>Nice printout</p> |
---|
1138 | </dd></dl> |
---|
1139 | |
---|
1140 | <dl class="method"> |
---|
1141 | <dt id="sans.dataloader.data_info.DataInfo.__sub__"> |
---|
1142 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
1143 | <dd><p>Subtract two data sets</p> |
---|
1144 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1145 | <col class="field-name" /> |
---|
1146 | <col class="field-body" /> |
---|
1147 | <tbody valign="top"> |
---|
1148 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
1149 | </tr> |
---|
1150 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
1151 | </tr> |
---|
1152 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
1153 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
1154 | </tr> |
---|
1155 | </tbody> |
---|
1156 | </table> |
---|
1157 | </dd></dl> |
---|
1158 | |
---|
1159 | <dl class="method"> |
---|
1160 | <dt id="sans.dataloader.data_info.DataInfo._perform_operation"> |
---|
1161 | <tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo._perform_operation" title="Permalink to this definition">¶</a></dt> |
---|
1162 | <dd><p>Private method to perform operation. Not implemented for DataInfo, |
---|
1163 | but should be implemented for each data class inherited from DataInfo |
---|
1164 | that holds actual data (ex.: Data1D)</p> |
---|
1165 | </dd></dl> |
---|
1166 | |
---|
1167 | <dl class="method"> |
---|
1168 | <dt id="sans.dataloader.data_info.DataInfo.add_notes"> |
---|
1169 | <tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.add_notes" title="Permalink to this definition">¶</a></dt> |
---|
1170 | <dd><p>Add notes to datainfo</p> |
---|
1171 | </dd></dl> |
---|
1172 | |
---|
1173 | <dl class="method"> |
---|
1174 | <dt id="sans.dataloader.data_info.DataInfo.append_empty_process"> |
---|
1175 | <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.append_empty_process" title="Permalink to this definition">¶</a></dt> |
---|
1176 | <dd></dd></dl> |
---|
1177 | |
---|
1178 | <dl class="attribute"> |
---|
1179 | <dt id="sans.dataloader.data_info.DataInfo.collimation"> |
---|
1180 | <tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.collimation" title="Permalink to this definition">¶</a></dt> |
---|
1181 | <dd></dd></dl> |
---|
1182 | |
---|
1183 | <dl class="attribute"> |
---|
1184 | <dt id="sans.dataloader.data_info.DataInfo.detector"> |
---|
1185 | <tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.detector" title="Permalink to this definition">¶</a></dt> |
---|
1186 | <dd></dd></dl> |
---|
1187 | |
---|
1188 | <dl class="attribute"> |
---|
1189 | <dt id="sans.dataloader.data_info.DataInfo.errors"> |
---|
1190 | <tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.errors" title="Permalink to this definition">¶</a></dt> |
---|
1191 | <dd></dd></dl> |
---|
1192 | |
---|
1193 | <dl class="attribute"> |
---|
1194 | <dt id="sans.dataloader.data_info.DataInfo.filename"> |
---|
1195 | <tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.filename" title="Permalink to this definition">¶</a></dt> |
---|
1196 | <dd></dd></dl> |
---|
1197 | |
---|
1198 | <dl class="attribute"> |
---|
1199 | <dt id="sans.dataloader.data_info.DataInfo.instrument"> |
---|
1200 | <tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.instrument" title="Permalink to this definition">¶</a></dt> |
---|
1201 | <dd></dd></dl> |
---|
1202 | |
---|
1203 | <dl class="attribute"> |
---|
1204 | <dt id="sans.dataloader.data_info.DataInfo.meta_data"> |
---|
1205 | <tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.meta_data" title="Permalink to this definition">¶</a></dt> |
---|
1206 | <dd></dd></dl> |
---|
1207 | |
---|
1208 | <dl class="attribute"> |
---|
1209 | <dt id="sans.dataloader.data_info.DataInfo.notes"> |
---|
1210 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.notes" title="Permalink to this definition">¶</a></dt> |
---|
1211 | <dd></dd></dl> |
---|
1212 | |
---|
1213 | <dl class="attribute"> |
---|
1214 | <dt id="sans.dataloader.data_info.DataInfo.process"> |
---|
1215 | <tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.process" title="Permalink to this definition">¶</a></dt> |
---|
1216 | <dd></dd></dl> |
---|
1217 | |
---|
1218 | <dl class="attribute"> |
---|
1219 | <dt id="sans.dataloader.data_info.DataInfo.run"> |
---|
1220 | <tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.run" title="Permalink to this definition">¶</a></dt> |
---|
1221 | <dd></dd></dl> |
---|
1222 | |
---|
1223 | <dl class="attribute"> |
---|
1224 | <dt id="sans.dataloader.data_info.DataInfo.run_name"> |
---|
1225 | <tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.run_name" title="Permalink to this definition">¶</a></dt> |
---|
1226 | <dd></dd></dl> |
---|
1227 | |
---|
1228 | <dl class="attribute"> |
---|
1229 | <dt id="sans.dataloader.data_info.DataInfo.sample"> |
---|
1230 | <tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.sample" title="Permalink to this definition">¶</a></dt> |
---|
1231 | <dd></dd></dl> |
---|
1232 | |
---|
1233 | <dl class="attribute"> |
---|
1234 | <dt id="sans.dataloader.data_info.DataInfo.source"> |
---|
1235 | <tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.source" title="Permalink to this definition">¶</a></dt> |
---|
1236 | <dd></dd></dl> |
---|
1237 | |
---|
1238 | <dl class="attribute"> |
---|
1239 | <dt id="sans.dataloader.data_info.DataInfo.title"> |
---|
1240 | <tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.DataInfo.title" title="Permalink to this definition">¶</a></dt> |
---|
1241 | <dd></dd></dl> |
---|
1242 | |
---|
1243 | </dd></dl> |
---|
1244 | |
---|
1245 | <dl class="class"> |
---|
1246 | <dt id="sans.dataloader.data_info.Detector"> |
---|
1247 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Detector</tt><a class="headerlink" href="#sans.dataloader.data_info.Detector" title="Permalink to this definition">¶</a></dt> |
---|
1248 | <dd><p>Class to hold detector information</p> |
---|
1249 | <dl class="method"> |
---|
1250 | <dt id="sans.dataloader.data_info.Detector.__init__"> |
---|
1251 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Detector.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1252 | <dd><p>Initialize class attribute that are objects...</p> |
---|
1253 | </dd></dl> |
---|
1254 | |
---|
1255 | <dl class="attribute"> |
---|
1256 | <dt id="sans.dataloader.data_info.Detector.__module__"> |
---|
1257 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1258 | <dd></dd></dl> |
---|
1259 | |
---|
1260 | <dl class="method"> |
---|
1261 | <dt id="sans.dataloader.data_info.Detector.__str__"> |
---|
1262 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Detector.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1263 | <dd></dd></dl> |
---|
1264 | |
---|
1265 | <dl class="attribute"> |
---|
1266 | <dt id="sans.dataloader.data_info.Detector.beam_center"> |
---|
1267 | <tt class="descname">beam_center</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.beam_center" title="Permalink to this definition">¶</a></dt> |
---|
1268 | <dd></dd></dl> |
---|
1269 | |
---|
1270 | <dl class="attribute"> |
---|
1271 | <dt id="sans.dataloader.data_info.Detector.beam_center_unit"> |
---|
1272 | <tt class="descname">beam_center_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.beam_center_unit" title="Permalink to this definition">¶</a></dt> |
---|
1273 | <dd></dd></dl> |
---|
1274 | |
---|
1275 | <dl class="attribute"> |
---|
1276 | <dt id="sans.dataloader.data_info.Detector.distance"> |
---|
1277 | <tt class="descname">distance</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.distance" title="Permalink to this definition">¶</a></dt> |
---|
1278 | <dd></dd></dl> |
---|
1279 | |
---|
1280 | <dl class="attribute"> |
---|
1281 | <dt id="sans.dataloader.data_info.Detector.distance_unit"> |
---|
1282 | <tt class="descname">distance_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.distance_unit" title="Permalink to this definition">¶</a></dt> |
---|
1283 | <dd></dd></dl> |
---|
1284 | |
---|
1285 | <dl class="attribute"> |
---|
1286 | <dt id="sans.dataloader.data_info.Detector.name"> |
---|
1287 | <tt class="descname">name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.name" title="Permalink to this definition">¶</a></dt> |
---|
1288 | <dd></dd></dl> |
---|
1289 | |
---|
1290 | <dl class="attribute"> |
---|
1291 | <dt id="sans.dataloader.data_info.Detector.offset"> |
---|
1292 | <tt class="descname">offset</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.offset" title="Permalink to this definition">¶</a></dt> |
---|
1293 | <dd></dd></dl> |
---|
1294 | |
---|
1295 | <dl class="attribute"> |
---|
1296 | <dt id="sans.dataloader.data_info.Detector.offset_unit"> |
---|
1297 | <tt class="descname">offset_unit</tt><em class="property"> = 'm'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.offset_unit" title="Permalink to this definition">¶</a></dt> |
---|
1298 | <dd></dd></dl> |
---|
1299 | |
---|
1300 | <dl class="attribute"> |
---|
1301 | <dt id="sans.dataloader.data_info.Detector.orientation"> |
---|
1302 | <tt class="descname">orientation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.orientation" title="Permalink to this definition">¶</a></dt> |
---|
1303 | <dd></dd></dl> |
---|
1304 | |
---|
1305 | <dl class="attribute"> |
---|
1306 | <dt id="sans.dataloader.data_info.Detector.orientation_unit"> |
---|
1307 | <tt class="descname">orientation_unit</tt><em class="property"> = 'degree'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.orientation_unit" title="Permalink to this definition">¶</a></dt> |
---|
1308 | <dd></dd></dl> |
---|
1309 | |
---|
1310 | <dl class="attribute"> |
---|
1311 | <dt id="sans.dataloader.data_info.Detector.pixel_size"> |
---|
1312 | <tt class="descname">pixel_size</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.pixel_size" title="Permalink to this definition">¶</a></dt> |
---|
1313 | <dd></dd></dl> |
---|
1314 | |
---|
1315 | <dl class="attribute"> |
---|
1316 | <dt id="sans.dataloader.data_info.Detector.pixel_size_unit"> |
---|
1317 | <tt class="descname">pixel_size_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.pixel_size_unit" title="Permalink to this definition">¶</a></dt> |
---|
1318 | <dd></dd></dl> |
---|
1319 | |
---|
1320 | <dl class="attribute"> |
---|
1321 | <dt id="sans.dataloader.data_info.Detector.slit_length"> |
---|
1322 | <tt class="descname">slit_length</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.slit_length" title="Permalink to this definition">¶</a></dt> |
---|
1323 | <dd></dd></dl> |
---|
1324 | |
---|
1325 | <dl class="attribute"> |
---|
1326 | <dt id="sans.dataloader.data_info.Detector.slit_length_unit"> |
---|
1327 | <tt class="descname">slit_length_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Detector.slit_length_unit" title="Permalink to this definition">¶</a></dt> |
---|
1328 | <dd></dd></dl> |
---|
1329 | |
---|
1330 | </dd></dl> |
---|
1331 | |
---|
1332 | <dl class="class"> |
---|
1333 | <dt id="sans.dataloader.data_info.Process"> |
---|
1334 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Process</tt><a class="headerlink" href="#sans.dataloader.data_info.Process" title="Permalink to this definition">¶</a></dt> |
---|
1335 | <dd><p>Class that holds information about the processes |
---|
1336 | performed on the data.</p> |
---|
1337 | <dl class="method"> |
---|
1338 | <dt id="sans.dataloader.data_info.Process.__init__"> |
---|
1339 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Process.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1340 | <dd></dd></dl> |
---|
1341 | |
---|
1342 | <dl class="attribute"> |
---|
1343 | <dt id="sans.dataloader.data_info.Process.__module__"> |
---|
1344 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Process.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1345 | <dd></dd></dl> |
---|
1346 | |
---|
1347 | <dl class="method"> |
---|
1348 | <dt id="sans.dataloader.data_info.Process.__str__"> |
---|
1349 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Process.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1350 | <dd></dd></dl> |
---|
1351 | |
---|
1352 | <dl class="attribute"> |
---|
1353 | <dt id="sans.dataloader.data_info.Process.date"> |
---|
1354 | <tt class="descname">date</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Process.date" title="Permalink to this definition">¶</a></dt> |
---|
1355 | <dd></dd></dl> |
---|
1356 | |
---|
1357 | <dl class="attribute"> |
---|
1358 | <dt id="sans.dataloader.data_info.Process.description"> |
---|
1359 | <tt class="descname">description</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Process.description" title="Permalink to this definition">¶</a></dt> |
---|
1360 | <dd></dd></dl> |
---|
1361 | |
---|
1362 | <dl class="attribute"> |
---|
1363 | <dt id="sans.dataloader.data_info.Process.name"> |
---|
1364 | <tt class="descname">name</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Process.name" title="Permalink to this definition">¶</a></dt> |
---|
1365 | <dd></dd></dl> |
---|
1366 | |
---|
1367 | <dl class="attribute"> |
---|
1368 | <dt id="sans.dataloader.data_info.Process.notes"> |
---|
1369 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Process.notes" title="Permalink to this definition">¶</a></dt> |
---|
1370 | <dd></dd></dl> |
---|
1371 | |
---|
1372 | <dl class="attribute"> |
---|
1373 | <dt id="sans.dataloader.data_info.Process.term"> |
---|
1374 | <tt class="descname">term</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Process.term" title="Permalink to this definition">¶</a></dt> |
---|
1375 | <dd></dd></dl> |
---|
1376 | |
---|
1377 | </dd></dl> |
---|
1378 | |
---|
1379 | <dl class="class"> |
---|
1380 | <dt id="sans.dataloader.data_info.Sample"> |
---|
1381 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Sample</tt><a class="headerlink" href="#sans.dataloader.data_info.Sample" title="Permalink to this definition">¶</a></dt> |
---|
1382 | <dd><p>Class to hold the sample description</p> |
---|
1383 | <dl class="attribute"> |
---|
1384 | <dt id="sans.dataloader.data_info.Sample.ID"> |
---|
1385 | <tt class="descname">ID</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.ID" title="Permalink to this definition">¶</a></dt> |
---|
1386 | <dd></dd></dl> |
---|
1387 | |
---|
1388 | <dl class="method"> |
---|
1389 | <dt id="sans.dataloader.data_info.Sample.__init__"> |
---|
1390 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Sample.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1391 | <dd></dd></dl> |
---|
1392 | |
---|
1393 | <dl class="attribute"> |
---|
1394 | <dt id="sans.dataloader.data_info.Sample.__module__"> |
---|
1395 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1396 | <dd></dd></dl> |
---|
1397 | |
---|
1398 | <dl class="method"> |
---|
1399 | <dt id="sans.dataloader.data_info.Sample.__str__"> |
---|
1400 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Sample.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1401 | <dd></dd></dl> |
---|
1402 | |
---|
1403 | <dl class="attribute"> |
---|
1404 | <dt id="sans.dataloader.data_info.Sample.details"> |
---|
1405 | <tt class="descname">details</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.details" title="Permalink to this definition">¶</a></dt> |
---|
1406 | <dd></dd></dl> |
---|
1407 | |
---|
1408 | <dl class="attribute"> |
---|
1409 | <dt id="sans.dataloader.data_info.Sample.name"> |
---|
1410 | <tt class="descname">name</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.name" title="Permalink to this definition">¶</a></dt> |
---|
1411 | <dd></dd></dl> |
---|
1412 | |
---|
1413 | <dl class="attribute"> |
---|
1414 | <dt id="sans.dataloader.data_info.Sample.orientation"> |
---|
1415 | <tt class="descname">orientation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.orientation" title="Permalink to this definition">¶</a></dt> |
---|
1416 | <dd></dd></dl> |
---|
1417 | |
---|
1418 | <dl class="attribute"> |
---|
1419 | <dt id="sans.dataloader.data_info.Sample.orientation_unit"> |
---|
1420 | <tt class="descname">orientation_unit</tt><em class="property"> = 'degree'</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.orientation_unit" title="Permalink to this definition">¶</a></dt> |
---|
1421 | <dd></dd></dl> |
---|
1422 | |
---|
1423 | <dl class="attribute"> |
---|
1424 | <dt id="sans.dataloader.data_info.Sample.position"> |
---|
1425 | <tt class="descname">position</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.position" title="Permalink to this definition">¶</a></dt> |
---|
1426 | <dd></dd></dl> |
---|
1427 | |
---|
1428 | <dl class="attribute"> |
---|
1429 | <dt id="sans.dataloader.data_info.Sample.position_unit"> |
---|
1430 | <tt class="descname">position_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.position_unit" title="Permalink to this definition">¶</a></dt> |
---|
1431 | <dd></dd></dl> |
---|
1432 | |
---|
1433 | <dl class="attribute"> |
---|
1434 | <dt id="sans.dataloader.data_info.Sample.temperature"> |
---|
1435 | <tt class="descname">temperature</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.temperature" title="Permalink to this definition">¶</a></dt> |
---|
1436 | <dd></dd></dl> |
---|
1437 | |
---|
1438 | <dl class="attribute"> |
---|
1439 | <dt id="sans.dataloader.data_info.Sample.temperature_unit"> |
---|
1440 | <tt class="descname">temperature_unit</tt><em class="property"> = 'C'</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.temperature_unit" title="Permalink to this definition">¶</a></dt> |
---|
1441 | <dd></dd></dl> |
---|
1442 | |
---|
1443 | <dl class="attribute"> |
---|
1444 | <dt id="sans.dataloader.data_info.Sample.thickness"> |
---|
1445 | <tt class="descname">thickness</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.thickness" title="Permalink to this definition">¶</a></dt> |
---|
1446 | <dd></dd></dl> |
---|
1447 | |
---|
1448 | <dl class="attribute"> |
---|
1449 | <dt id="sans.dataloader.data_info.Sample.thickness_unit"> |
---|
1450 | <tt class="descname">thickness_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.thickness_unit" title="Permalink to this definition">¶</a></dt> |
---|
1451 | <dd></dd></dl> |
---|
1452 | |
---|
1453 | <dl class="attribute"> |
---|
1454 | <dt id="sans.dataloader.data_info.Sample.transmission"> |
---|
1455 | <tt class="descname">transmission</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Sample.transmission" title="Permalink to this definition">¶</a></dt> |
---|
1456 | <dd></dd></dl> |
---|
1457 | |
---|
1458 | </dd></dl> |
---|
1459 | |
---|
1460 | <dl class="class"> |
---|
1461 | <dt id="sans.dataloader.data_info.Source"> |
---|
1462 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Source</tt><a class="headerlink" href="#sans.dataloader.data_info.Source" title="Permalink to this definition">¶</a></dt> |
---|
1463 | <dd><p>Class to hold source information</p> |
---|
1464 | <dl class="method"> |
---|
1465 | <dt id="sans.dataloader.data_info.Source.__init__"> |
---|
1466 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Source.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1467 | <dd></dd></dl> |
---|
1468 | |
---|
1469 | <dl class="attribute"> |
---|
1470 | <dt id="sans.dataloader.data_info.Source.__module__"> |
---|
1471 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1472 | <dd></dd></dl> |
---|
1473 | |
---|
1474 | <dl class="method"> |
---|
1475 | <dt id="sans.dataloader.data_info.Source.__str__"> |
---|
1476 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Source.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1477 | <dd></dd></dl> |
---|
1478 | |
---|
1479 | <dl class="attribute"> |
---|
1480 | <dt id="sans.dataloader.data_info.Source.beam_shape"> |
---|
1481 | <tt class="descname">beam_shape</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.beam_shape" title="Permalink to this definition">¶</a></dt> |
---|
1482 | <dd></dd></dl> |
---|
1483 | |
---|
1484 | <dl class="attribute"> |
---|
1485 | <dt id="sans.dataloader.data_info.Source.beam_size"> |
---|
1486 | <tt class="descname">beam_size</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.beam_size" title="Permalink to this definition">¶</a></dt> |
---|
1487 | <dd></dd></dl> |
---|
1488 | |
---|
1489 | <dl class="attribute"> |
---|
1490 | <dt id="sans.dataloader.data_info.Source.beam_size_name"> |
---|
1491 | <tt class="descname">beam_size_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.beam_size_name" title="Permalink to this definition">¶</a></dt> |
---|
1492 | <dd></dd></dl> |
---|
1493 | |
---|
1494 | <dl class="attribute"> |
---|
1495 | <dt id="sans.dataloader.data_info.Source.beam_size_unit"> |
---|
1496 | <tt class="descname">beam_size_unit</tt><em class="property"> = 'mm'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.beam_size_unit" title="Permalink to this definition">¶</a></dt> |
---|
1497 | <dd></dd></dl> |
---|
1498 | |
---|
1499 | <dl class="attribute"> |
---|
1500 | <dt id="sans.dataloader.data_info.Source.name"> |
---|
1501 | <tt class="descname">name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.name" title="Permalink to this definition">¶</a></dt> |
---|
1502 | <dd></dd></dl> |
---|
1503 | |
---|
1504 | <dl class="attribute"> |
---|
1505 | <dt id="sans.dataloader.data_info.Source.radiation"> |
---|
1506 | <tt class="descname">radiation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.radiation" title="Permalink to this definition">¶</a></dt> |
---|
1507 | <dd></dd></dl> |
---|
1508 | |
---|
1509 | <dl class="attribute"> |
---|
1510 | <dt id="sans.dataloader.data_info.Source.wavelength"> |
---|
1511 | <tt class="descname">wavelength</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength" title="Permalink to this definition">¶</a></dt> |
---|
1512 | <dd></dd></dl> |
---|
1513 | |
---|
1514 | <dl class="attribute"> |
---|
1515 | <dt id="sans.dataloader.data_info.Source.wavelength_max"> |
---|
1516 | <tt class="descname">wavelength_max</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_max" title="Permalink to this definition">¶</a></dt> |
---|
1517 | <dd></dd></dl> |
---|
1518 | |
---|
1519 | <dl class="attribute"> |
---|
1520 | <dt id="sans.dataloader.data_info.Source.wavelength_max_unit"> |
---|
1521 | <tt class="descname">wavelength_max_unit</tt><em class="property"> = 'nm'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_max_unit" title="Permalink to this definition">¶</a></dt> |
---|
1522 | <dd></dd></dl> |
---|
1523 | |
---|
1524 | <dl class="attribute"> |
---|
1525 | <dt id="sans.dataloader.data_info.Source.wavelength_min"> |
---|
1526 | <tt class="descname">wavelength_min</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_min" title="Permalink to this definition">¶</a></dt> |
---|
1527 | <dd></dd></dl> |
---|
1528 | |
---|
1529 | <dl class="attribute"> |
---|
1530 | <dt id="sans.dataloader.data_info.Source.wavelength_min_unit"> |
---|
1531 | <tt class="descname">wavelength_min_unit</tt><em class="property"> = 'nm'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_min_unit" title="Permalink to this definition">¶</a></dt> |
---|
1532 | <dd></dd></dl> |
---|
1533 | |
---|
1534 | <dl class="attribute"> |
---|
1535 | <dt id="sans.dataloader.data_info.Source.wavelength_spread"> |
---|
1536 | <tt class="descname">wavelength_spread</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_spread" title="Permalink to this definition">¶</a></dt> |
---|
1537 | <dd></dd></dl> |
---|
1538 | |
---|
1539 | <dl class="attribute"> |
---|
1540 | <dt id="sans.dataloader.data_info.Source.wavelength_spread_unit"> |
---|
1541 | <tt class="descname">wavelength_spread_unit</tt><em class="property"> = 'percent'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_spread_unit" title="Permalink to this definition">¶</a></dt> |
---|
1542 | <dd></dd></dl> |
---|
1543 | |
---|
1544 | <dl class="attribute"> |
---|
1545 | <dt id="sans.dataloader.data_info.Source.wavelength_unit"> |
---|
1546 | <tt class="descname">wavelength_unit</tt><em class="property"> = 'A'</em><a class="headerlink" href="#sans.dataloader.data_info.Source.wavelength_unit" title="Permalink to this definition">¶</a></dt> |
---|
1547 | <dd></dd></dl> |
---|
1548 | |
---|
1549 | </dd></dl> |
---|
1550 | |
---|
1551 | <dl class="class"> |
---|
1552 | <dt id="sans.dataloader.data_info.Vector"> |
---|
1553 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">Vector</tt><a class="headerlink" href="#sans.dataloader.data_info.Vector" title="Permalink to this definition">¶</a></dt> |
---|
1554 | <dd><p>Vector class to hold multi-dimensional objects</p> |
---|
1555 | <dl class="method"> |
---|
1556 | <dt id="sans.dataloader.data_info.Vector.__init__"> |
---|
1557 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Vector.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1558 | <dd><p>Initialization. Components that are not |
---|
1559 | set a set to None by default.</p> |
---|
1560 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1561 | <col class="field-name" /> |
---|
1562 | <col class="field-body" /> |
---|
1563 | <tbody valign="top"> |
---|
1564 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
1565 | <li><strong>x</strong> – x component</li> |
---|
1566 | <li><strong>y</strong> – y component</li> |
---|
1567 | <li><strong>z</strong> – z component</li> |
---|
1568 | </ul> |
---|
1569 | </td> |
---|
1570 | </tr> |
---|
1571 | </tbody> |
---|
1572 | </table> |
---|
1573 | </dd></dl> |
---|
1574 | |
---|
1575 | <dl class="attribute"> |
---|
1576 | <dt id="sans.dataloader.data_info.Vector.__module__"> |
---|
1577 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.Vector.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1578 | <dd></dd></dl> |
---|
1579 | |
---|
1580 | <dl class="method"> |
---|
1581 | <dt id="sans.dataloader.data_info.Vector.__str__"> |
---|
1582 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.Vector.__str__" title="Permalink to this definition">¶</a></dt> |
---|
1583 | <dd></dd></dl> |
---|
1584 | |
---|
1585 | <dl class="attribute"> |
---|
1586 | <dt id="sans.dataloader.data_info.Vector.x"> |
---|
1587 | <tt class="descname">x</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Vector.x" title="Permalink to this definition">¶</a></dt> |
---|
1588 | <dd></dd></dl> |
---|
1589 | |
---|
1590 | <dl class="attribute"> |
---|
1591 | <dt id="sans.dataloader.data_info.Vector.y"> |
---|
1592 | <tt class="descname">y</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Vector.y" title="Permalink to this definition">¶</a></dt> |
---|
1593 | <dd></dd></dl> |
---|
1594 | |
---|
1595 | <dl class="attribute"> |
---|
1596 | <dt id="sans.dataloader.data_info.Vector.z"> |
---|
1597 | <tt class="descname">z</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.Vector.z" title="Permalink to this definition">¶</a></dt> |
---|
1598 | <dd></dd></dl> |
---|
1599 | |
---|
1600 | </dd></dl> |
---|
1601 | |
---|
1602 | <dl class="class"> |
---|
1603 | <dt id="sans.dataloader.data_info.plottable_1D"> |
---|
1604 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">plottable_1D</tt><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D" title="Permalink to this definition">¶</a></dt> |
---|
1605 | <dd><p>Data1D is a place holder for 1D plottables.</p> |
---|
1606 | <dl class="method"> |
---|
1607 | <dt id="sans.dataloader.data_info.plottable_1D.__init__"> |
---|
1608 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1609 | <dd></dd></dl> |
---|
1610 | |
---|
1611 | <dl class="attribute"> |
---|
1612 | <dt id="sans.dataloader.data_info.plottable_1D.__module__"> |
---|
1613 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1614 | <dd></dd></dl> |
---|
1615 | |
---|
1616 | <dl class="attribute"> |
---|
1617 | <dt id="sans.dataloader.data_info.plottable_1D._xaxis"> |
---|
1618 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
1619 | <dd></dd></dl> |
---|
1620 | |
---|
1621 | <dl class="attribute"> |
---|
1622 | <dt id="sans.dataloader.data_info.plottable_1D._xunit"> |
---|
1623 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
1624 | <dd></dd></dl> |
---|
1625 | |
---|
1626 | <dl class="attribute"> |
---|
1627 | <dt id="sans.dataloader.data_info.plottable_1D._yaxis"> |
---|
1628 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
1629 | <dd></dd></dl> |
---|
1630 | |
---|
1631 | <dl class="attribute"> |
---|
1632 | <dt id="sans.dataloader.data_info.plottable_1D._yunit"> |
---|
1633 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
1634 | <dd></dd></dl> |
---|
1635 | |
---|
1636 | <dl class="attribute"> |
---|
1637 | <dt id="sans.dataloader.data_info.plottable_1D.dx"> |
---|
1638 | <tt class="descname">dx</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.dx" title="Permalink to this definition">¶</a></dt> |
---|
1639 | <dd></dd></dl> |
---|
1640 | |
---|
1641 | <dl class="attribute"> |
---|
1642 | <dt id="sans.dataloader.data_info.plottable_1D.dxl"> |
---|
1643 | <tt class="descname">dxl</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.dxl" title="Permalink to this definition">¶</a></dt> |
---|
1644 | <dd></dd></dl> |
---|
1645 | |
---|
1646 | <dl class="attribute"> |
---|
1647 | <dt id="sans.dataloader.data_info.plottable_1D.dxw"> |
---|
1648 | <tt class="descname">dxw</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.dxw" title="Permalink to this definition">¶</a></dt> |
---|
1649 | <dd></dd></dl> |
---|
1650 | |
---|
1651 | <dl class="attribute"> |
---|
1652 | <dt id="sans.dataloader.data_info.plottable_1D.dy"> |
---|
1653 | <tt class="descname">dy</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.dy" title="Permalink to this definition">¶</a></dt> |
---|
1654 | <dd></dd></dl> |
---|
1655 | |
---|
1656 | <dl class="attribute"> |
---|
1657 | <dt id="sans.dataloader.data_info.plottable_1D.x"> |
---|
1658 | <tt class="descname">x</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.x" title="Permalink to this definition">¶</a></dt> |
---|
1659 | <dd></dd></dl> |
---|
1660 | |
---|
1661 | <dl class="method"> |
---|
1662 | <dt id="sans.dataloader.data_info.plottable_1D.xaxis"> |
---|
1663 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
1664 | <dd><p>set the x axis label and unit</p> |
---|
1665 | </dd></dl> |
---|
1666 | |
---|
1667 | <dl class="attribute"> |
---|
1668 | <dt id="sans.dataloader.data_info.plottable_1D.y"> |
---|
1669 | <tt class="descname">y</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.y" title="Permalink to this definition">¶</a></dt> |
---|
1670 | <dd></dd></dl> |
---|
1671 | |
---|
1672 | <dl class="method"> |
---|
1673 | <dt id="sans.dataloader.data_info.plottable_1D.yaxis"> |
---|
1674 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_1D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
1675 | <dd><p>set the y axis label and unit</p> |
---|
1676 | </dd></dl> |
---|
1677 | |
---|
1678 | </dd></dl> |
---|
1679 | |
---|
1680 | <dl class="class"> |
---|
1681 | <dt id="sans.dataloader.data_info.plottable_2D"> |
---|
1682 | <em class="property">class </em><tt class="descclassname">sans.dataloader.data_info.</tt><tt class="descname">plottable_2D</tt><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D" title="Permalink to this definition">¶</a></dt> |
---|
1683 | <dd><p>Data2D is a place holder for 2D plottables.</p> |
---|
1684 | <dl class="method"> |
---|
1685 | <dt id="sans.dataloader.data_info.plottable_2D.__init__"> |
---|
1686 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
1687 | <dd></dd></dl> |
---|
1688 | |
---|
1689 | <dl class="attribute"> |
---|
1690 | <dt id="sans.dataloader.data_info.plottable_2D.__module__"> |
---|
1691 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.data_info'</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
1692 | <dd></dd></dl> |
---|
1693 | |
---|
1694 | <dl class="attribute"> |
---|
1695 | <dt id="sans.dataloader.data_info.plottable_2D._xaxis"> |
---|
1696 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
1697 | <dd></dd></dl> |
---|
1698 | |
---|
1699 | <dl class="attribute"> |
---|
1700 | <dt id="sans.dataloader.data_info.plottable_2D._xunit"> |
---|
1701 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
1702 | <dd></dd></dl> |
---|
1703 | |
---|
1704 | <dl class="attribute"> |
---|
1705 | <dt id="sans.dataloader.data_info.plottable_2D._yaxis"> |
---|
1706 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
1707 | <dd></dd></dl> |
---|
1708 | |
---|
1709 | <dl class="attribute"> |
---|
1710 | <dt id="sans.dataloader.data_info.plottable_2D._yunit"> |
---|
1711 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
1712 | <dd></dd></dl> |
---|
1713 | |
---|
1714 | <dl class="attribute"> |
---|
1715 | <dt id="sans.dataloader.data_info.plottable_2D._zaxis"> |
---|
1716 | <tt class="descname">_zaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._zaxis" title="Permalink to this definition">¶</a></dt> |
---|
1717 | <dd></dd></dl> |
---|
1718 | |
---|
1719 | <dl class="attribute"> |
---|
1720 | <dt id="sans.dataloader.data_info.plottable_2D._zunit"> |
---|
1721 | <tt class="descname">_zunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D._zunit" title="Permalink to this definition">¶</a></dt> |
---|
1722 | <dd></dd></dl> |
---|
1723 | |
---|
1724 | <dl class="attribute"> |
---|
1725 | <dt id="sans.dataloader.data_info.plottable_2D.data"> |
---|
1726 | <tt class="descname">data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.data" title="Permalink to this definition">¶</a></dt> |
---|
1727 | <dd></dd></dl> |
---|
1728 | |
---|
1729 | <dl class="attribute"> |
---|
1730 | <dt id="sans.dataloader.data_info.plottable_2D.dqx_data"> |
---|
1731 | <tt class="descname">dqx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.dqx_data" title="Permalink to this definition">¶</a></dt> |
---|
1732 | <dd></dd></dl> |
---|
1733 | |
---|
1734 | <dl class="attribute"> |
---|
1735 | <dt id="sans.dataloader.data_info.plottable_2D.dqy_data"> |
---|
1736 | <tt class="descname">dqy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.dqy_data" title="Permalink to this definition">¶</a></dt> |
---|
1737 | <dd></dd></dl> |
---|
1738 | |
---|
1739 | <dl class="attribute"> |
---|
1740 | <dt id="sans.dataloader.data_info.plottable_2D.err_data"> |
---|
1741 | <tt class="descname">err_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.err_data" title="Permalink to this definition">¶</a></dt> |
---|
1742 | <dd></dd></dl> |
---|
1743 | |
---|
1744 | <dl class="attribute"> |
---|
1745 | <dt id="sans.dataloader.data_info.plottable_2D.mask"> |
---|
1746 | <tt class="descname">mask</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.mask" title="Permalink to this definition">¶</a></dt> |
---|
1747 | <dd></dd></dl> |
---|
1748 | |
---|
1749 | <dl class="attribute"> |
---|
1750 | <dt id="sans.dataloader.data_info.plottable_2D.q_data"> |
---|
1751 | <tt class="descname">q_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.q_data" title="Permalink to this definition">¶</a></dt> |
---|
1752 | <dd></dd></dl> |
---|
1753 | |
---|
1754 | <dl class="attribute"> |
---|
1755 | <dt id="sans.dataloader.data_info.plottable_2D.qx_data"> |
---|
1756 | <tt class="descname">qx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.qx_data" title="Permalink to this definition">¶</a></dt> |
---|
1757 | <dd></dd></dl> |
---|
1758 | |
---|
1759 | <dl class="attribute"> |
---|
1760 | <dt id="sans.dataloader.data_info.plottable_2D.qy_data"> |
---|
1761 | <tt class="descname">qy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.qy_data" title="Permalink to this definition">¶</a></dt> |
---|
1762 | <dd></dd></dl> |
---|
1763 | |
---|
1764 | <dl class="method"> |
---|
1765 | <dt id="sans.dataloader.data_info.plottable_2D.xaxis"> |
---|
1766 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
1767 | <dd><p>set the x axis label and unit</p> |
---|
1768 | </dd></dl> |
---|
1769 | |
---|
1770 | <dl class="attribute"> |
---|
1771 | <dt id="sans.dataloader.data_info.plottable_2D.xmax"> |
---|
1772 | <tt class="descname">xmax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.xmax" title="Permalink to this definition">¶</a></dt> |
---|
1773 | <dd></dd></dl> |
---|
1774 | |
---|
1775 | <dl class="attribute"> |
---|
1776 | <dt id="sans.dataloader.data_info.plottable_2D.xmin"> |
---|
1777 | <tt class="descname">xmin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.xmin" title="Permalink to this definition">¶</a></dt> |
---|
1778 | <dd></dd></dl> |
---|
1779 | |
---|
1780 | <dl class="method"> |
---|
1781 | <dt id="sans.dataloader.data_info.plottable_2D.yaxis"> |
---|
1782 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
1783 | <dd><p>set the y axis label and unit</p> |
---|
1784 | </dd></dl> |
---|
1785 | |
---|
1786 | <dl class="attribute"> |
---|
1787 | <dt id="sans.dataloader.data_info.plottable_2D.ymax"> |
---|
1788 | <tt class="descname">ymax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.ymax" title="Permalink to this definition">¶</a></dt> |
---|
1789 | <dd></dd></dl> |
---|
1790 | |
---|
1791 | <dl class="attribute"> |
---|
1792 | <dt id="sans.dataloader.data_info.plottable_2D.ymin"> |
---|
1793 | <tt class="descname">ymin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.ymin" title="Permalink to this definition">¶</a></dt> |
---|
1794 | <dd></dd></dl> |
---|
1795 | |
---|
1796 | <dl class="method"> |
---|
1797 | <dt id="sans.dataloader.data_info.plottable_2D.zaxis"> |
---|
1798 | <tt class="descname">zaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.data_info.plottable_2D.zaxis" title="Permalink to this definition">¶</a></dt> |
---|
1799 | <dd><p>set the z axis label and unit</p> |
---|
1800 | </dd></dl> |
---|
1801 | |
---|
1802 | </dd></dl> |
---|
1803 | |
---|
1804 | </div> |
---|
1805 | </div> |
---|
1806 | |
---|
1807 | |
---|
1808 | </div> |
---|
1809 | </div> |
---|
1810 | </div> |
---|
1811 | <div class="sphinxsidebar"> |
---|
1812 | <div class="sphinxsidebarwrapper"> |
---|
1813 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
1814 | <ul> |
---|
1815 | <li><a class="reference internal" href="#">data_info</a><ul> |
---|
1816 | <li><a class="reference internal" href="#sans-dataloader-data-info"><tt class="docutils literal"><span class="pre">sans.dataloader.data_info</span></tt></a></li> |
---|
1817 | </ul> |
---|
1818 | </li> |
---|
1819 | </ul> |
---|
1820 | |
---|
1821 | <h4>Previous topic</h4> |
---|
1822 | <p class="topless"><a href="index.html" |
---|
1823 | title="previous chapter">Reference</a></p> |
---|
1824 | <h4>Next topic</h4> |
---|
1825 | <p class="topless"><a href="loader.html" |
---|
1826 | title="next chapter">loader</a></p> |
---|
1827 | <h3>This Page</h3> |
---|
1828 | <ul class="this-page-menu"> |
---|
1829 | <li><a href="../_sources/api/data_info.txt" |
---|
1830 | rel="nofollow">Show Source</a></li> |
---|
1831 | </ul> |
---|
1832 | <div id="searchbox" style="display: none"> |
---|
1833 | <h3>Quick search</h3> |
---|
1834 | <form class="search" action="../search.html" method="get"> |
---|
1835 | <input type="text" name="q" /> |
---|
1836 | <input type="submit" value="Go" /> |
---|
1837 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
1838 | <input type="hidden" name="area" value="default" /> |
---|
1839 | </form> |
---|
1840 | <p class="searchtip" style="font-size: 90%"> |
---|
1841 | Enter search terms or a module, class or function name. |
---|
1842 | </p> |
---|
1843 | </div> |
---|
1844 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
1845 | </div> |
---|
1846 | </div> |
---|
1847 | <div class="clearer"></div> |
---|
1848 | </div> |
---|
1849 | <div class="related"> |
---|
1850 | <h3>Navigation</h3> |
---|
1851 | <ul> |
---|
1852 | <li class="right" style="margin-right: 10px"> |
---|
1853 | <a href="../genindex.html" title="General Index" |
---|
1854 | >index</a></li> |
---|
1855 | <li class="right" > |
---|
1856 | <a href="../py-modindex.html" title="Python Module Index" |
---|
1857 | >modules</a> |</li> |
---|
1858 | <li class="right" > |
---|
1859 | <a href="loader.html" title="loader" |
---|
1860 | >next</a> |</li> |
---|
1861 | <li class="right" > |
---|
1862 | <a href="index.html" title="Reference" |
---|
1863 | >previous</a> |</li> |
---|
1864 | <li><a href="../index.html">DataLoader 0.1.0 documentation</a> »</li> |
---|
1865 | <li><a href="index.html" >Reference</a> »</li> |
---|
1866 | </ul> |
---|
1867 | </div> |
---|
1868 | <div class="footer"> |
---|
1869 | © Copyright 2010, sans group. |
---|
1870 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
1871 | </div> |
---|
1872 | </body> |
---|
1873 | </html> |
---|