[89b7858] | 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>invariant_state — invariantview 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="invariantview 0.1.0 documentation" href="../index.html" /> |
---|
| 29 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 30 | <link rel="next" title="invariant_widgets" href="invariant_widgets.html" /> |
---|
| 31 | <link rel="prev" title="invariant_panel" href="invariant_panel.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="invariant_widgets.html" title="invariant_widgets" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="invariant_panel.html" title="invariant_panel" |
---|
| 48 | accesskey="P">previous</a> |</li> |
---|
| 49 | <li><a href="../index.html">invariantview 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="invariant-state"> |
---|
| 60 | <h1>invariant_state<a class="headerlink" href="#invariant-state" title="Permalink to this headline">¶</a></h1> |
---|
| 61 | <div class="section" id="sans-perspectives-invariant-invariant-state"> |
---|
| 62 | <h2><a class="reference internal" href="#module-sans.perspectives.invariant.invariant_state" title="sans.perspectives.invariant.invariant_state"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.invariant.invariant_state</span></tt></a><a class="headerlink" href="#sans-perspectives-invariant-invariant-state" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.perspectives.invariant.invariant_state"></span><dl class="class"> |
---|
| 64 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState"> |
---|
| 65 | <em class="property">class </em><tt class="descclassname">sans.perspectives.invariant.invariant_state.</tt><tt class="descname">InvariantState</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState" title="Permalink to this definition">¶</a></dt> |
---|
| 66 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> |
---|
| 67 | <p>Class to hold the state information of the InversionControl panel.</p> |
---|
| 68 | <dl class="attribute"> |
---|
| 69 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__class__"> |
---|
| 70 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 71 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 72 | </dd></dl> |
---|
| 73 | |
---|
| 74 | <dl class="attribute"> |
---|
| 75 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__delattr__"> |
---|
| 76 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 77 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 78 | </dd></dl> |
---|
| 79 | |
---|
| 80 | <dl class="attribute"> |
---|
| 81 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__dict__"> |
---|
| 82 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x061CCCB0></em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 83 | <dd></dd></dl> |
---|
| 84 | |
---|
| 85 | <dl class="attribute"> |
---|
| 86 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__getattribute__"> |
---|
| 87 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 88 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 89 | </dd></dl> |
---|
| 90 | |
---|
| 91 | <dl class="attribute"> |
---|
| 92 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__hash__"> |
---|
| 93 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 94 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 95 | </dd></dl> |
---|
| 96 | |
---|
| 97 | <dl class="method"> |
---|
| 98 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__init__"> |
---|
| 99 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 100 | <dd><p>Default values</p> |
---|
| 101 | </dd></dl> |
---|
| 102 | |
---|
| 103 | <dl class="attribute"> |
---|
| 104 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__module__"> |
---|
| 105 | <tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.invariant.invariant_state'</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 106 | <dd></dd></dl> |
---|
| 107 | |
---|
| 108 | <dl class="staticmethod"> |
---|
| 109 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__new__"> |
---|
| 110 | <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 111 | <dd></dd></dl> |
---|
| 112 | |
---|
| 113 | <dl class="method"> |
---|
| 114 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__reduce__"> |
---|
| 115 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 116 | <dd><p>helper for pickle</p> |
---|
| 117 | </dd></dl> |
---|
| 118 | |
---|
| 119 | <dl class="method"> |
---|
| 120 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__reduce_ex__"> |
---|
| 121 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 122 | <dd><p>helper for pickle</p> |
---|
| 123 | </dd></dl> |
---|
| 124 | |
---|
| 125 | <dl class="attribute"> |
---|
| 126 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__repr__"> |
---|
| 127 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 128 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 129 | </dd></dl> |
---|
| 130 | |
---|
| 131 | <dl class="attribute"> |
---|
| 132 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__setattr__"> |
---|
| 133 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 134 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 135 | </dd></dl> |
---|
| 136 | |
---|
| 137 | <dl class="method"> |
---|
| 138 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__str__"> |
---|
| 139 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 140 | <dd><p>Pretty print</p> |
---|
| 141 | <p>: return: string representing the state</p> |
---|
| 142 | </dd></dl> |
---|
| 143 | |
---|
| 144 | <dl class="attribute"> |
---|
| 145 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.__weakref__"> |
---|
| 146 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 147 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 148 | </dd></dl> |
---|
| 149 | |
---|
| 150 | <dl class="method"> |
---|
| 151 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState._check_html_format"> |
---|
| 152 | <tt class="descname">_check_html_format</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState._check_html_format" title="Permalink to this definition">¶</a></dt> |
---|
| 153 | <dd><p>Check string ‘%’ for html format</p> |
---|
| 154 | </dd></dl> |
---|
| 155 | |
---|
| 156 | <dl class="method"> |
---|
| 157 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.clone_state"> |
---|
| 158 | <tt class="descname">clone_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.clone_state" title="Permalink to this definition">¶</a></dt> |
---|
| 159 | <dd><p>deepcopy the state</p> |
---|
| 160 | </dd></dl> |
---|
| 161 | |
---|
| 162 | <dl class="method"> |
---|
| 163 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.fromXML"> |
---|
| 164 | <tt class="descname">fromXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.fromXML" title="Permalink to this definition">¶</a></dt> |
---|
| 165 | <dd><p>Load invariant states from a file</p> |
---|
| 166 | <p>: param file: .inv file |
---|
| 167 | : param node: node of a XML document to read from</p> |
---|
| 168 | </dd></dl> |
---|
| 169 | |
---|
| 170 | <dl class="method"> |
---|
| 171 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.set_plot_state"> |
---|
| 172 | <tt class="descname">set_plot_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.set_plot_state" title="Permalink to this definition">¶</a></dt> |
---|
| 173 | <dd><p>Build image state that wx.html understand |
---|
| 174 | by plotting, putting it into wx.FileSystem image object</p> |
---|
| 175 | <p>: extrap_high,extra_low: low/high extrapolations |
---|
| 176 | are possible extra-plots</p> |
---|
| 177 | </dd></dl> |
---|
| 178 | |
---|
| 179 | <dl class="method"> |
---|
| 180 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.set_report_string"> |
---|
| 181 | <tt class="descname">set_report_string</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.set_report_string" title="Permalink to this definition">¶</a></dt> |
---|
| 182 | <dd><p>Get the values (strings) from __str__ for report</p> |
---|
| 183 | </dd></dl> |
---|
| 184 | |
---|
| 185 | <dl class="method"> |
---|
| 186 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.set_saved_state"> |
---|
| 187 | <tt class="descname">set_saved_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.set_saved_state" title="Permalink to this definition">¶</a></dt> |
---|
| 188 | <dd><p>Set the state list</p> |
---|
| 189 | <p>: param name: name of the state component |
---|
| 190 | : param value: value of the state component</p> |
---|
| 191 | </dd></dl> |
---|
| 192 | |
---|
| 193 | <dl class="method"> |
---|
| 194 | <dt id="sans.perspectives.invariant.invariant_state.InvariantState.toXML"> |
---|
| 195 | <tt class="descname">toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.InvariantState.toXML" title="Permalink to this definition">¶</a></dt> |
---|
| 196 | <dd><p>Writes the state of the InversionControl panel to file, as XML.</p> |
---|
| 197 | <p>Compatible with standalone writing, or appending to an |
---|
| 198 | already existing XML document. In that case, the XML document |
---|
| 199 | is required. An optional entry node in the XML document |
---|
| 200 | may also be given.</p> |
---|
| 201 | <p>: param file: file to write to |
---|
| 202 | : param doc: XML document object [optional] |
---|
| 203 | : param entry_node: XML node within the XML document at which</p> |
---|
| 204 | <blockquote> |
---|
| 205 | <div>we will append the data [optional]</div></blockquote> |
---|
| 206 | </dd></dl> |
---|
| 207 | |
---|
| 208 | </dd></dl> |
---|
| 209 | |
---|
| 210 | <dl class="class"> |
---|
| 211 | <dt id="sans.perspectives.invariant.invariant_state.Reader"> |
---|
| 212 | <em class="property">class </em><tt class="descclassname">sans.perspectives.invariant.invariant_state.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader" title="Permalink to this definition">¶</a></dt> |
---|
| 213 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader.Reader</span></tt></p> |
---|
| 214 | <p>Class to load a .inv invariant file</p> |
---|
| 215 | <dl class="method"> |
---|
| 216 | <dt id="sans.perspectives.invariant.invariant_state.Reader.__init__"> |
---|
| 217 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 218 | <dd><p>Initialize the call-back method to be called |
---|
| 219 | after we load a file</p> |
---|
| 220 | <p>: param call_back: call-back method |
---|
| 221 | : param cansas: True = files will be written/read in CanSAS format</p> |
---|
| 222 | <blockquote> |
---|
| 223 | <div>False = write CanSAS format</div></blockquote> |
---|
| 224 | </dd></dl> |
---|
| 225 | |
---|
| 226 | <dl class="attribute"> |
---|
| 227 | <dt id="sans.perspectives.invariant.invariant_state.Reader.__module__"> |
---|
| 228 | <tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.invariant.invariant_state'</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 229 | <dd></dd></dl> |
---|
| 230 | |
---|
| 231 | <dl class="method"> |
---|
| 232 | <dt id="sans.perspectives.invariant.invariant_state.Reader._parse_entry"> |
---|
| 233 | <tt class="descname">_parse_entry</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._parse_entry" title="Permalink to this definition">¶</a></dt> |
---|
| 234 | <dd><p>Parse a SASentry</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>node</strong> – SASentry node</td> |
---|
| 240 | </tr> |
---|
| 241 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D object</td> |
---|
| 242 | </tr> |
---|
| 243 | </tbody> |
---|
| 244 | </table> |
---|
| 245 | </dd></dl> |
---|
| 246 | |
---|
| 247 | <dl class="method"> |
---|
| 248 | <dt id="sans.perspectives.invariant.invariant_state.Reader._parse_state"> |
---|
| 249 | <tt class="descname">_parse_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._parse_state" title="Permalink to this definition">¶</a></dt> |
---|
| 250 | <dd><p>Read an invariant result from an XML node</p> |
---|
| 251 | <p>: param entry: XML node to read from |
---|
| 252 | : return: InvariantState object</p> |
---|
| 253 | </dd></dl> |
---|
| 254 | |
---|
| 255 | <dl class="method"> |
---|
| 256 | <dt id="sans.perspectives.invariant.invariant_state.Reader._read_cansas"> |
---|
| 257 | <tt class="descname">_read_cansas</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._read_cansas" title="Permalink to this definition">¶</a></dt> |
---|
| 258 | <dd><p>Load data and invariant information from a CanSAS XML file.</p> |
---|
| 259 | <p>: param path: file path |
---|
| 260 | : return: Data1D object if a single SASentry was found,</p> |
---|
| 261 | <blockquote> |
---|
| 262 | <div>or a list of Data1D objects if multiple entries were found, |
---|
| 263 | or None of nothing was found</div></blockquote> |
---|
| 264 | <p>: raise RuntimeError: when the file can’t be opened |
---|
| 265 | : raise ValueError: when the length of the data vectors are inconsistent</p> |
---|
| 266 | </dd></dl> |
---|
| 267 | |
---|
| 268 | <dl class="method"> |
---|
| 269 | <dt id="sans.perspectives.invariant.invariant_state.Reader._read_standalone"> |
---|
| 270 | <tt class="descname">_read_standalone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._read_standalone" title="Permalink to this definition">¶</a></dt> |
---|
| 271 | <dd><p>Load a new invariant state from file. |
---|
| 272 | The invariant node is assumed to be the top element.</p> |
---|
| 273 | <p>: param path: file path |
---|
| 274 | : return: None</p> |
---|
| 275 | </dd></dl> |
---|
| 276 | |
---|
| 277 | <dl class="method"> |
---|
| 278 | <dt id="sans.perspectives.invariant.invariant_state.Reader._store_content"> |
---|
| 279 | <tt class="descname">_store_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._store_content" title="Permalink to this definition">¶</a></dt> |
---|
| 280 | <dd><p>Get the content of a xpath location and store |
---|
| 281 | the result. The value is treated as a string.</p> |
---|
| 282 | <p>The xpath location might or might not exist. |
---|
| 283 | If it does not exist, nothing is done</p> |
---|
| 284 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 285 | <col class="field-name" /> |
---|
| 286 | <col class="field-body" /> |
---|
| 287 | <tbody valign="top"> |
---|
| 288 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 289 | <li><strong>location</strong> – xpath location to fetch</li> |
---|
| 290 | <li><strong>node</strong> – node to read the data from</li> |
---|
| 291 | <li><strong>variable</strong> – name of the data member to store it in [string]</li> |
---|
| 292 | <li><strong>storage</strong> – data object that has the ‘variable’ data member</li> |
---|
| 293 | </ul> |
---|
| 294 | </td> |
---|
| 295 | </tr> |
---|
| 296 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">return a list of errors</p> |
---|
| 297 | </td> |
---|
| 298 | </tr> |
---|
| 299 | </tbody> |
---|
| 300 | </table> |
---|
| 301 | </dd></dl> |
---|
| 302 | |
---|
| 303 | <dl class="method"> |
---|
| 304 | <dt id="sans.perspectives.invariant.invariant_state.Reader._store_float"> |
---|
| 305 | <tt class="descname">_store_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._store_float" title="Permalink to this definition">¶</a></dt> |
---|
| 306 | <dd><p>Get the content of a xpath location and store |
---|
| 307 | the result. Check that the units are compatible |
---|
| 308 | with the destination. The value is expected to |
---|
| 309 | be a float.</p> |
---|
| 310 | <p>The xpath location might or might not exist. |
---|
| 311 | If it does not exist, nothing is done</p> |
---|
| 312 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 313 | <col class="field-name" /> |
---|
| 314 | <col class="field-body" /> |
---|
| 315 | <tbody valign="top"> |
---|
| 316 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 317 | <li><strong>location</strong> – xpath location to fetch</li> |
---|
| 318 | <li><strong>node</strong> – node to read the data from</li> |
---|
| 319 | <li><strong>variable</strong> – name of the data member to store it in [string]</li> |
---|
| 320 | <li><strong>storage</strong> – data object that has the ‘variable’ data member</li> |
---|
| 321 | <li><strong>optional</strong> – if True, no exception will be raised |
---|
| 322 | if unit conversion can’t be done</li> |
---|
| 323 | </ul> |
---|
| 324 | </td> |
---|
| 325 | </tr> |
---|
| 326 | <tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 327 | <tr class="field-even field"><td> </td><td class="field-body"><p class="first last">raised when the units are not recognized</p> |
---|
| 328 | </td> |
---|
| 329 | </tr> |
---|
| 330 | </tbody> |
---|
| 331 | </table> |
---|
| 332 | </dd></dl> |
---|
| 333 | |
---|
| 334 | <dl class="method"> |
---|
| 335 | <dt id="sans.perspectives.invariant.invariant_state.Reader._to_xml_doc"> |
---|
| 336 | <tt class="descname">_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader._to_xml_doc" title="Permalink to this definition">¶</a></dt> |
---|
| 337 | <dd><p>Create an XML document to contain the content of a Data1D</p> |
---|
| 338 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 339 | <col class="field-name" /> |
---|
| 340 | <col class="field-body" /> |
---|
| 341 | <tbody valign="top"> |
---|
| 342 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> – Data1D object</td> |
---|
| 343 | </tr> |
---|
| 344 | </tbody> |
---|
| 345 | </table> |
---|
| 346 | </dd></dl> |
---|
| 347 | |
---|
| 348 | <dl class="attribute"> |
---|
| 349 | <dt id="sans.perspectives.invariant.invariant_state.Reader.ext"> |
---|
| 350 | <tt class="descname">ext</tt><em class="property"> = ['.inv', '.INV', '.svs', 'SVS']</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.ext" title="Permalink to this definition">¶</a></dt> |
---|
| 351 | <dd></dd></dl> |
---|
| 352 | |
---|
| 353 | <dl class="method"> |
---|
| 354 | <dt id="sans.perspectives.invariant.invariant_state.Reader.get_state"> |
---|
| 355 | <tt class="descname">get_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.get_state" title="Permalink to this definition">¶</a></dt> |
---|
| 356 | <dd></dd></dl> |
---|
| 357 | |
---|
| 358 | <dl class="method"> |
---|
| 359 | <dt id="sans.perspectives.invariant.invariant_state.Reader.read"> |
---|
| 360 | <tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.read" title="Permalink to this definition">¶</a></dt> |
---|
| 361 | <dd><p>Load a new invariant state from file</p> |
---|
| 362 | <p>: param path: file path |
---|
| 363 | : return: None</p> |
---|
| 364 | </dd></dl> |
---|
| 365 | |
---|
| 366 | <dl class="attribute"> |
---|
| 367 | <dt id="sans.perspectives.invariant.invariant_state.Reader.type"> |
---|
| 368 | <tt class="descname">type</tt><em class="property"> = ['Invariant file (*.inv)|*.inv', 'SANSView file (*.svs)|*.svs']</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.type" title="Permalink to this definition">¶</a></dt> |
---|
| 369 | <dd></dd></dl> |
---|
| 370 | |
---|
| 371 | <dl class="attribute"> |
---|
| 372 | <dt id="sans.perspectives.invariant.invariant_state.Reader.type_name"> |
---|
| 373 | <tt class="descname">type_name</tt><em class="property"> = 'Invariant'</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.type_name" title="Permalink to this definition">¶</a></dt> |
---|
| 374 | <dd></dd></dl> |
---|
| 375 | |
---|
| 376 | <dl class="attribute"> |
---|
| 377 | <dt id="sans.perspectives.invariant.invariant_state.Reader.version"> |
---|
| 378 | <tt class="descname">version</tt><em class="property"> = '1.0'</em><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.version" title="Permalink to this definition">¶</a></dt> |
---|
| 379 | <dd></dd></dl> |
---|
| 380 | |
---|
| 381 | <dl class="method"> |
---|
| 382 | <dt id="sans.perspectives.invariant.invariant_state.Reader.write"> |
---|
| 383 | <tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.write" title="Permalink to this definition">¶</a></dt> |
---|
| 384 | <dd><p>Write the content of a Data1D as a CanSAS XML file</p> |
---|
| 385 | <p>: param filename: name of the file to write |
---|
| 386 | : param datainfo: Data1D object |
---|
| 387 | : param invstate: InvariantState object</p> |
---|
| 388 | </dd></dl> |
---|
| 389 | |
---|
| 390 | <dl class="method"> |
---|
| 391 | <dt id="sans.perspectives.invariant.invariant_state.Reader.write_toXML"> |
---|
| 392 | <tt class="descname">write_toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.invariant.invariant_state.Reader.write_toXML" title="Permalink to this definition">¶</a></dt> |
---|
| 393 | <dd><p>Write toXML, a helper for write()</p> |
---|
| 394 | <p>: return: xml doc</p> |
---|
| 395 | </dd></dl> |
---|
| 396 | |
---|
| 397 | </dd></dl> |
---|
| 398 | |
---|
| 399 | </div> |
---|
| 400 | </div> |
---|
| 401 | |
---|
| 402 | |
---|
| 403 | </div> |
---|
| 404 | </div> |
---|
| 405 | </div> |
---|
| 406 | <div class="sphinxsidebar"> |
---|
| 407 | <div class="sphinxsidebarwrapper"> |
---|
| 408 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 409 | <ul> |
---|
| 410 | <li><a class="reference internal" href="#">invariant_state</a><ul> |
---|
| 411 | <li><a class="reference internal" href="#sans-perspectives-invariant-invariant-state"><tt class="docutils literal"><span class="pre">sans.perspectives.invariant.invariant_state</span></tt></a></li> |
---|
| 412 | </ul> |
---|
| 413 | </li> |
---|
| 414 | </ul> |
---|
| 415 | |
---|
| 416 | <h4>Previous topic</h4> |
---|
| 417 | <p class="topless"><a href="invariant_panel.html" |
---|
| 418 | title="previous chapter">invariant_panel</a></p> |
---|
| 419 | <h4>Next topic</h4> |
---|
| 420 | <p class="topless"><a href="invariant_widgets.html" |
---|
| 421 | title="next chapter">invariant_widgets</a></p> |
---|
| 422 | <h3>This Page</h3> |
---|
| 423 | <ul class="this-page-menu"> |
---|
| 424 | <li><a href="../_sources/api/invariant_state.txt" |
---|
| 425 | rel="nofollow">Show Source</a></li> |
---|
| 426 | </ul> |
---|
| 427 | <div id="searchbox" style="display: none"> |
---|
| 428 | <h3>Quick search</h3> |
---|
| 429 | <form class="search" action="../search.html" method="get"> |
---|
| 430 | <input type="text" name="q" /> |
---|
| 431 | <input type="submit" value="Go" /> |
---|
| 432 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 433 | <input type="hidden" name="area" value="default" /> |
---|
| 434 | </form> |
---|
| 435 | <p class="searchtip" style="font-size: 90%"> |
---|
| 436 | Enter search terms or a module, class or function name. |
---|
| 437 | </p> |
---|
| 438 | </div> |
---|
| 439 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 440 | </div> |
---|
| 441 | </div> |
---|
| 442 | <div class="clearer"></div> |
---|
| 443 | </div> |
---|
| 444 | <div class="related"> |
---|
| 445 | <h3>Navigation</h3> |
---|
| 446 | <ul> |
---|
| 447 | <li class="right" style="margin-right: 10px"> |
---|
| 448 | <a href="../genindex.html" title="General Index" |
---|
| 449 | >index</a></li> |
---|
| 450 | <li class="right" > |
---|
| 451 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 452 | >modules</a> |</li> |
---|
| 453 | <li class="right" > |
---|
| 454 | <a href="invariant_widgets.html" title="invariant_widgets" |
---|
| 455 | >next</a> |</li> |
---|
| 456 | <li class="right" > |
---|
| 457 | <a href="invariant_panel.html" title="invariant_panel" |
---|
| 458 | >previous</a> |</li> |
---|
| 459 | <li><a href="../index.html">invariantview 0.1.0 documentation</a> »</li> |
---|
| 460 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 461 | </ul> |
---|
| 462 | </div> |
---|
| 463 | <div class="footer"> |
---|
| 464 | © Copyright 2010, sans group. |
---|
| 465 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
| 466 | </div> |
---|
| 467 | </body> |
---|
| 468 | </html> |
---|