[5a9a98f] | 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 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 7 | <head> |
---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 9 | |
---|
| 10 | <title>fitting — sansview v0.1.0 documentation</title> |
---|
| 11 | <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> |
---|
| 12 | <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
---|
| 13 | <script type="text/javascript"> |
---|
| 14 | var DOCUMENTATION_OPTIONS = { |
---|
| 15 | URL_ROOT: '../../../', |
---|
| 16 | VERSION: '0.1.0', |
---|
| 17 | COLLAPSE_INDEX: false, |
---|
| 18 | FILE_SUFFIX: '.html', |
---|
| 19 | HAS_SOURCE: true |
---|
| 20 | }; |
---|
| 21 | </script> |
---|
| 22 | <script type="text/javascript" src="../../../_static/jquery.js"></script> |
---|
| 23 | <script type="text/javascript" src="../../../_static/underscore.js"></script> |
---|
| 24 | <script type="text/javascript" src="../../../_static/doctools.js"></script> |
---|
| 25 | <link rel="top" title="sansview v0.1.0 documentation" href="../../../index.html" /> |
---|
| 26 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 27 | <link rel="next" title="help_panel" href="help_panel.html" /> |
---|
| 28 | <link rel="prev" title="fitproblem" href="fitproblem.html" /> |
---|
| 29 | </head> |
---|
| 30 | <body> |
---|
| 31 | <div class="related"> |
---|
| 32 | <h3>Navigation</h3> |
---|
| 33 | <ul> |
---|
| 34 | <li class="right" style="margin-right: 10px"> |
---|
| 35 | <a href="../../../genindex.html" title="General Index" |
---|
| 36 | accesskey="I">index</a></li> |
---|
| 37 | <li class="right" > |
---|
| 38 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 39 | >modules</a> |</li> |
---|
| 40 | <li class="right" > |
---|
| 41 | <a href="help_panel.html" title="help_panel" |
---|
| 42 | accesskey="N">next</a> |</li> |
---|
| 43 | <li class="right" > |
---|
| 44 | <a href="fitproblem.html" title="fitproblem" |
---|
| 45 | accesskey="P">previous</a> |</li> |
---|
| 46 | <li><a href="../../../index.html">sansview v0.1.0 documentation</a> »</li> |
---|
| 47 | <li><a href="index.html" accesskey="U">Reference</a> »</li> |
---|
| 48 | </ul> |
---|
| 49 | </div> |
---|
| 50 | |
---|
| 51 | <div class="document"> |
---|
| 52 | <div class="documentwrapper"> |
---|
| 53 | <div class="bodywrapper"> |
---|
| 54 | <div class="body"> |
---|
| 55 | |
---|
| 56 | <div class="section" id="fitting"> |
---|
| 57 | <h1>fitting<a class="headerlink" href="#fitting" title="Permalink to this headline">¶</a></h1> |
---|
| 58 | <div class="section" id="module-sans.perspectives.fitting.fitting"> |
---|
| 59 | <span id="sans-perspectives-fitting-fitting"></span><h2><a class="reference internal" href="#module-sans.perspectives.fitting.fitting" title="sans.perspectives.fitting.fitting"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.fitting</span></tt></a><a class="headerlink" href="#module-sans.perspectives.fitting.fitting" title="Permalink to this headline">¶</a></h2> |
---|
| 60 | <dl class="class"> |
---|
| 61 | <dt id="sans.perspectives.fitting.fitting.Plugin"> |
---|
| 62 | <em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.fitting.</tt><tt class="descname">Plugin</tt><big>(</big><em>standalone=False</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin" title="Permalink to this definition">¶</a></dt> |
---|
| 63 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.plugin_base.PluginBase</span></tt></p> |
---|
| 64 | <p>Fitting plugin is used to perform fit</p> |
---|
| 65 | <dl class="method"> |
---|
| 66 | <dt id="sans.perspectives.fitting.fitting.Plugin.add_color"> |
---|
| 67 | <tt class="descname">add_color</tt><big>(</big><em>color</em>, <em>id</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.add_color" title="Permalink to this definition">¶</a></dt> |
---|
| 68 | <dd><p>adds a color as a key with a plot id as its value to a dictionary</p> |
---|
| 69 | </dd></dl> |
---|
| 70 | |
---|
| 71 | <dl class="method"> |
---|
| 72 | <dt id="sans.perspectives.fitting.fitting.Plugin.add_fit_page"> |
---|
| 73 | <tt class="descname">add_fit_page</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.add_fit_page" title="Permalink to this definition">¶</a></dt> |
---|
| 74 | <dd><p>given a data, ask to the fitting panel to create a new fitting page, |
---|
| 75 | get this page and store it into the page_finder of this plug-in</p> |
---|
| 76 | </dd></dl> |
---|
| 77 | |
---|
| 78 | <dl class="method"> |
---|
| 79 | <dt id="sans.perspectives.fitting.fitting.Plugin.can_load_data"> |
---|
| 80 | <tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.can_load_data" title="Permalink to this definition">¶</a></dt> |
---|
| 81 | <dd><p>if return True, then call handler to laod data</p> |
---|
| 82 | </dd></dl> |
---|
| 83 | |
---|
| 84 | <dl class="method"> |
---|
| 85 | <dt id="sans.perspectives.fitting.fitting.Plugin.clear_panel"> |
---|
| 86 | <tt class="descname">clear_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.clear_panel" title="Permalink to this definition">¶</a></dt> |
---|
| 87 | <dd></dd></dl> |
---|
| 88 | |
---|
| 89 | <dl class="method"> |
---|
| 90 | <dt id="sans.perspectives.fitting.fitting.Plugin.delete_data"> |
---|
| 91 | <tt class="descname">delete_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.delete_data" title="Permalink to this definition">¶</a></dt> |
---|
| 92 | <dd><p>delete the given data from panel</p> |
---|
| 93 | </dd></dl> |
---|
| 94 | |
---|
| 95 | <dl class="method"> |
---|
| 96 | <dt id="sans.perspectives.fitting.fitting.Plugin.draw_model"> |
---|
| 97 | <tt class="descname">draw_model</tt><big>(</big><em>model</em>, <em>page_id</em>, <em>data=None</em>, <em>smearer=None</em>, <em>enable1D=True</em>, <em>enable2D=False</em>, <em>state=None</em>, <em>toggle_mode_on=False</em>, <em>qmin=0.001</em>, <em>qmax=0.13</em>, <em>qstep=50</em>, <em>update_chisqr=True</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.draw_model" title="Permalink to this definition">¶</a></dt> |
---|
| 98 | <dd><p>Draw model.</p> |
---|
| 99 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 100 | <col class="field-name" /> |
---|
| 101 | <col class="field-body" /> |
---|
| 102 | <tbody valign="top"> |
---|
| 103 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 104 | <li><strong>model</strong> – the model to draw</li> |
---|
| 105 | <li><strong>name</strong> – the name of the model to draw</li> |
---|
| 106 | <li><strong>data</strong> – the data on which the model is based to be drawn</li> |
---|
| 107 | <li><strong>description</strong> – model’s description</li> |
---|
| 108 | <li><strong>enable1D</strong> – if true enable drawing model 1D</li> |
---|
| 109 | <li><strong>enable2D</strong> – if true enable drawing model 2D</li> |
---|
| 110 | <li><strong>qmin</strong> – Range’s minimum value to draw model</li> |
---|
| 111 | <li><strong>qmax</strong> – Range’s maximum value to draw model</li> |
---|
| 112 | <li><strong>qstep</strong> – number of step to divide the x and y-axis</li> |
---|
| 113 | <li><strong>update_chisqr</strong> – update chisqr [bool]</li> |
---|
| 114 | </ul> |
---|
| 115 | </td> |
---|
| 116 | </tr> |
---|
| 117 | </tbody> |
---|
| 118 | </table> |
---|
| 119 | </dd></dl> |
---|
| 120 | |
---|
| 121 | <dl class="method"> |
---|
| 122 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_context_menu"> |
---|
| 123 | <tt class="descname">get_context_menu</tt><big>(</big><em>plotpanel=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_context_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 124 | <dd><p>Get the context menu items available for P(r).them allow fitting option |
---|
| 125 | for Data2D and Data1D only.</p> |
---|
| 126 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 127 | <col class="field-name" /> |
---|
| 128 | <col class="field-body" /> |
---|
| 129 | <tbody valign="top"> |
---|
| 130 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> – the Graph object to which we attach the context menu</td> |
---|
| 131 | </tr> |
---|
| 132 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body">a list of menu items with call-back function</td> |
---|
| 133 | </tr> |
---|
| 134 | <tr class="field"><th class="field-name">Note :</th><td class="field-body">if Data1D was generated from Theory1D |
---|
| 135 | the fitting option is not allowed</td> |
---|
| 136 | </tr> |
---|
| 137 | </tbody> |
---|
| 138 | </table> |
---|
| 139 | </dd></dl> |
---|
| 140 | |
---|
| 141 | <dl class="method"> |
---|
| 142 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_extensions"> |
---|
| 143 | <tt class="descname">get_extensions</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_extensions" title="Permalink to this definition">¶</a></dt> |
---|
| 144 | <dd><p>return state reader and its extensions</p> |
---|
| 145 | </dd></dl> |
---|
| 146 | |
---|
| 147 | <dl class="method"> |
---|
| 148 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_page_finder"> |
---|
| 149 | <tt class="descname">get_page_finder</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_page_finder" title="Permalink to this definition">¶</a></dt> |
---|
| 150 | <dd><p>return self.page_finder used also by simfitpage.py</p> |
---|
| 151 | </dd></dl> |
---|
| 152 | |
---|
| 153 | <dl class="method"> |
---|
| 154 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_panels"> |
---|
| 155 | <tt class="descname">get_panels</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_panels" title="Permalink to this definition">¶</a></dt> |
---|
| 156 | <dd><p>Create and return a list of panel objects</p> |
---|
| 157 | </dd></dl> |
---|
| 158 | |
---|
| 159 | <dl class="method"> |
---|
| 160 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_perspective"> |
---|
| 161 | <tt class="descname">get_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 162 | <dd><p>Get the list of panel names for this perspective</p> |
---|
| 163 | </dd></dl> |
---|
| 164 | |
---|
| 165 | <dl class="method"> |
---|
| 166 | <dt id="sans.perspectives.fitting.fitting.Plugin.get_tools"> |
---|
| 167 | <tt class="descname">get_tools</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.get_tools" title="Permalink to this definition">¶</a></dt> |
---|
| 168 | <dd><p>Returns a set of menu entries for tools</p> |
---|
| 169 | </dd></dl> |
---|
| 170 | |
---|
| 171 | <dl class="method"> |
---|
| 172 | <dt id="sans.perspectives.fitting.fitting.Plugin.help"> |
---|
| 173 | <tt class="descname">help</tt><big>(</big><em>evt</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.help" title="Permalink to this definition">¶</a></dt> |
---|
| 174 | <dd><p>Show a general help dialog.</p> |
---|
| 175 | </dd></dl> |
---|
| 176 | |
---|
| 177 | <dl class="method"> |
---|
| 178 | <dt id="sans.perspectives.fitting.fitting.Plugin.is_always_active"> |
---|
| 179 | <tt class="descname">is_always_active</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.is_always_active" title="Permalink to this definition">¶</a></dt> |
---|
| 180 | <dd><p>return True is this plugin is always active and it is local to guiframe |
---|
| 181 | even if the user is switching between perspectives</p> |
---|
| 182 | </dd></dl> |
---|
| 183 | |
---|
| 184 | <dl class="method"> |
---|
| 185 | <dt id="sans.perspectives.fitting.fitting.Plugin.is_in_use"> |
---|
| 186 | <tt class="descname">is_in_use</tt><big>(</big><em>data_id</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.is_in_use" title="Permalink to this definition">¶</a></dt> |
---|
| 187 | <dd><dl class="docutils"> |
---|
| 188 | <dt>get a data id a list of data name if data data is</dt> |
---|
| 189 | <dd>currently used by the plugin and the name of the plugin</dd> |
---|
| 190 | </dl> |
---|
| 191 | <p>data_name = ‘None’ |
---|
| 192 | in_use = False |
---|
| 193 | example [(data_name, self.sub_menu)]</p> |
---|
| 194 | </dd></dl> |
---|
| 195 | |
---|
| 196 | <dl class="method"> |
---|
| 197 | <dt id="sans.perspectives.fitting.fitting.Plugin.load_data"> |
---|
| 198 | <tt class="descname">load_data</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.load_data" title="Permalink to this definition">¶</a></dt> |
---|
| 199 | <dd><p>Load data</p> |
---|
| 200 | </dd></dl> |
---|
| 201 | |
---|
| 202 | <dl class="method"> |
---|
| 203 | <dt id="sans.perspectives.fitting.fitting.Plugin.load_folder"> |
---|
| 204 | <tt class="descname">load_folder</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.load_folder" title="Permalink to this definition">¶</a></dt> |
---|
| 205 | <dd><p>Load entire folder</p> |
---|
| 206 | </dd></dl> |
---|
| 207 | |
---|
| 208 | <dl class="method"> |
---|
| 209 | <dt id="sans.perspectives.fitting.fitting.Plugin.onFit"> |
---|
| 210 | <tt class="descname">onFit</tt><big>(</big><em>uid=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.onFit" title="Permalink to this definition">¶</a></dt> |
---|
| 211 | <dd><p>perform fit</p> |
---|
| 212 | </dd></dl> |
---|
| 213 | |
---|
| 214 | <dl class="method"> |
---|
| 215 | <dt id="sans.perspectives.fitting.fitting.Plugin.on_add_new_page"> |
---|
| 216 | <tt class="descname">on_add_new_page</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_add_new_page" title="Permalink to this definition">¶</a></dt> |
---|
| 217 | <dd><p>ask fit panel to create a new empty page</p> |
---|
| 218 | </dd></dl> |
---|
| 219 | |
---|
| 220 | <dl class="method"> |
---|
| 221 | <dt id="sans.perspectives.fitting.fitting.Plugin.on_add_sim_page"> |
---|
| 222 | <tt class="descname">on_add_sim_page</tt><big>(</big><em>event</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_add_sim_page" title="Permalink to this definition">¶</a></dt> |
---|
| 223 | <dd><p>Create a page to access simultaneous fit option</p> |
---|
| 224 | </dd></dl> |
---|
| 225 | |
---|
| 226 | <dl class="method"> |
---|
| 227 | <dt id="sans.perspectives.fitting.fitting.Plugin.on_batch_selection"> |
---|
| 228 | <tt class="descname">on_batch_selection</tt><big>(</big><em>flag</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
| 229 | <dd><p>switch the the notebook of batch mode or not</p> |
---|
| 230 | </dd></dl> |
---|
| 231 | |
---|
| 232 | <dl class="method"> |
---|
| 233 | <dt id="sans.perspectives.fitting.fitting.Plugin.on_perspective"> |
---|
| 234 | <tt class="descname">on_perspective</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 235 | <dd><p>Call back function for the perspective menu item. |
---|
| 236 | We notify the parent window that the perspective |
---|
| 237 | has changed.</p> |
---|
| 238 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 239 | <col class="field-name" /> |
---|
| 240 | <col class="field-body" /> |
---|
| 241 | <tbody valign="top"> |
---|
| 242 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>event</strong> – menu event</td> |
---|
| 243 | </tr> |
---|
| 244 | </tbody> |
---|
| 245 | </table> |
---|
| 246 | </dd></dl> |
---|
| 247 | |
---|
| 248 | <dl class="method"> |
---|
| 249 | <dt id="sans.perspectives.fitting.fitting.Plugin.on_set_state_helper"> |
---|
| 250 | <tt class="descname">on_set_state_helper</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.on_set_state_helper" title="Permalink to this definition">¶</a></dt> |
---|
| 251 | <dd><p>Set_state_helper. This actually sets state |
---|
| 252 | after plotting data from state file.</p> |
---|
| 253 | <dl class="docutils"> |
---|
| 254 | <dt>: event: FitStateUpdateEvent called </dt> |
---|
| 255 | <dd>by dataloader.plot_data from guiframe</dd> |
---|
| 256 | </dl> |
---|
| 257 | </dd></dl> |
---|
| 258 | |
---|
| 259 | <dl class="method"> |
---|
| 260 | <dt id="sans.perspectives.fitting.fitting.Plugin.populate_file_menu"> |
---|
| 261 | <tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.populate_file_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 262 | <dd><p>Append menu item under file menu item of the frame</p> |
---|
| 263 | </dd></dl> |
---|
| 264 | |
---|
| 265 | <dl class="method"> |
---|
| 266 | <dt id="sans.perspectives.fitting.fitting.Plugin.populate_menu"> |
---|
| 267 | <tt class="descname">populate_menu</tt><big>(</big><em>owner</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.populate_menu" title="Permalink to this definition">¶</a></dt> |
---|
| 268 | <dd><p>Create a menu for the Fitting plug-in</p> |
---|
| 269 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 270 | <col class="field-name" /> |
---|
| 271 | <col class="field-body" /> |
---|
| 272 | <tbody valign="top"> |
---|
| 273 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 274 | <li><strong>id</strong> – id to create a menu</li> |
---|
| 275 | <li><strong>owner</strong> – owner of menu</li> |
---|
| 276 | </ul> |
---|
| 277 | </td> |
---|
| 278 | </tr> |
---|
| 279 | <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of information to populate the main menu</p> |
---|
| 280 | </td> |
---|
| 281 | </tr> |
---|
| 282 | </tbody> |
---|
| 283 | </table> |
---|
| 284 | </dd></dl> |
---|
| 285 | |
---|
| 286 | <dl class="method"> |
---|
| 287 | <dt id="sans.perspectives.fitting.fitting.Plugin.post_init"> |
---|
| 288 | <tt class="descname">post_init</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.post_init" title="Permalink to this definition">¶</a></dt> |
---|
| 289 | <dd><p>Post initialization call back to close the loose ends</p> |
---|
| 290 | </dd></dl> |
---|
| 291 | |
---|
| 292 | <dl class="method"> |
---|
| 293 | <dt id="sans.perspectives.fitting.fitting.Plugin.ready_fit"> |
---|
| 294 | <tt class="descname">ready_fit</tt><big>(</big><em>calc_fit</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.ready_fit" title="Permalink to this definition">¶</a></dt> |
---|
| 295 | <dd><p>Ready for another fit</p> |
---|
| 296 | </dd></dl> |
---|
| 297 | |
---|
| 298 | <dl class="method"> |
---|
| 299 | <dt id="sans.perspectives.fitting.fitting.Plugin.remove_plot"> |
---|
| 300 | <tt class="descname">remove_plot</tt><big>(</big><em>uid</em>, <em>theory=False</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.remove_plot" title="Permalink to this definition">¶</a></dt> |
---|
| 301 | <dd><p>remove model plot when a fit page is closed</p> |
---|
| 302 | </dd></dl> |
---|
| 303 | |
---|
| 304 | <dl class="method"> |
---|
| 305 | <dt id="sans.perspectives.fitting.fitting.Plugin.save_fit_state"> |
---|
| 306 | <tt class="descname">save_fit_state</tt><big>(</big><em>filepath</em>, <em>fitstate</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.save_fit_state" title="Permalink to this definition">¶</a></dt> |
---|
| 307 | <dd><p>save fit page state into file</p> |
---|
| 308 | </dd></dl> |
---|
| 309 | |
---|
| 310 | <dl class="method"> |
---|
| 311 | <dt id="sans.perspectives.fitting.fitting.Plugin.schedule_for_fit"> |
---|
| 312 | <tt class="descname">schedule_for_fit</tt><big>(</big><em>value=0</em>, <em>uid=None</em>, <em>fitproblem=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.schedule_for_fit" title="Permalink to this definition">¶</a></dt> |
---|
| 313 | <dd><p>Set the fit problem field to 0 or 1 to schedule that problem to fit. |
---|
| 314 | Schedule the specified fitproblem or get the fit problem related to |
---|
| 315 | the current page and set value.</p> |
---|
| 316 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 317 | <col class="field-name" /> |
---|
| 318 | <col class="field-body" /> |
---|
| 319 | <tbody valign="top"> |
---|
| 320 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 321 | <li><strong>value</strong> – integer 0 or 1</li> |
---|
| 322 | <li><strong>fitproblem</strong> – fitproblem to schedule or not to fit</li> |
---|
| 323 | </ul> |
---|
| 324 | </td> |
---|
| 325 | </tr> |
---|
| 326 | </tbody> |
---|
| 327 | </table> |
---|
| 328 | </dd></dl> |
---|
| 329 | |
---|
| 330 | <dl class="method"> |
---|
| 331 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_batch_selection"> |
---|
| 332 | <tt class="descname">set_batch_selection</tt><big>(</big><em>flag</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_batch_selection" title="Permalink to this definition">¶</a></dt> |
---|
| 333 | <dd><p>the plugin to its batch state if flag is True</p> |
---|
| 334 | </dd></dl> |
---|
| 335 | |
---|
| 336 | <dl class="method"> |
---|
| 337 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_data"> |
---|
| 338 | <tt class="descname">set_data</tt><big>(</big><em>data_list=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_data" title="Permalink to this definition">¶</a></dt> |
---|
| 339 | <dd><p>receive a list of data to fit</p> |
---|
| 340 | </dd></dl> |
---|
| 341 | |
---|
| 342 | <dl class="method"> |
---|
| 343 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_default_perspective"> |
---|
| 344 | <tt class="descname">set_default_perspective</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_default_perspective" title="Permalink to this definition">¶</a></dt> |
---|
| 345 | <dd><p>Call back method that True to notify the parent that the current plug-in |
---|
| 346 | can be set as default perspective. |
---|
| 347 | when returning False, the plug-in is not candidate for an automatic |
---|
| 348 | default perspective setting</p> |
---|
| 349 | </dd></dl> |
---|
| 350 | |
---|
| 351 | <dl class="method"> |
---|
| 352 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_fit_range"> |
---|
| 353 | <tt class="descname">set_fit_range</tt><big>(</big><em>uid</em>, <em>qmin</em>, <em>qmax</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_fit_range" title="Permalink to this definition">¶</a></dt> |
---|
| 354 | <dd><p>Set the fitting range of a given page</p> |
---|
| 355 | </dd></dl> |
---|
| 356 | |
---|
| 357 | <dl class="method"> |
---|
| 358 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_ftol"> |
---|
| 359 | <tt class="descname">set_ftol</tt><big>(</big><em>ftol=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_ftol" title="Permalink to this definition">¶</a></dt> |
---|
| 360 | <dd><p>Set ftol: Relative error desired in the sum of chi squares.</p> |
---|
| 361 | </dd></dl> |
---|
| 362 | |
---|
| 363 | <dl class="method"> |
---|
| 364 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_is_active"> |
---|
| 365 | <tt class="descname">set_is_active</tt><big>(</big><em>active=False</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_is_active" title="Permalink to this definition">¶</a></dt> |
---|
| 366 | <dd></dd></dl> |
---|
| 367 | |
---|
| 368 | <dl class="method"> |
---|
| 369 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_page_finder"> |
---|
| 370 | <tt class="descname">set_page_finder</tt><big>(</big><em>modelname</em>, <em>names</em>, <em>values</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_page_finder" title="Permalink to this definition">¶</a></dt> |
---|
| 371 | <dd><p>Used by simfitpage.py to reset a parameter given the string constrainst.</p> |
---|
| 372 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 373 | <col class="field-name" /> |
---|
| 374 | <col class="field-body" /> |
---|
| 375 | <tbody valign="top"> |
---|
| 376 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 377 | <li><strong>modelname</strong> – the name ot the model for with the parameter |
---|
| 378 | has to reset</li> |
---|
| 379 | <li><strong>value</strong> – can be a string in this case.</li> |
---|
| 380 | <li><strong>names</strong> – the paramter name</li> |
---|
| 381 | </ul> |
---|
| 382 | </td> |
---|
| 383 | </tr> |
---|
| 384 | <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">expecting park used for fit.</p> |
---|
| 385 | </td> |
---|
| 386 | </tr> |
---|
| 387 | </tbody> |
---|
| 388 | </table> |
---|
| 389 | </dd></dl> |
---|
| 390 | |
---|
| 391 | <dl class="method"> |
---|
| 392 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_smearer"> |
---|
| 393 | <tt class="descname">set_smearer</tt><big>(</big><em>uid</em>, <em>smearer</em>, <em>qmin=None</em>, <em>qmax=None</em>, <em>draw=True</em>, <em>enable2D=False</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_smearer" title="Permalink to this definition">¶</a></dt> |
---|
| 394 | <dd><p>Get a smear object and store it to a fit problem</p> |
---|
| 395 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 396 | <col class="field-name" /> |
---|
| 397 | <col class="field-body" /> |
---|
| 398 | <tbody valign="top"> |
---|
| 399 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> – smear object to allow smearing data</td> |
---|
| 400 | </tr> |
---|
| 401 | </tbody> |
---|
| 402 | </table> |
---|
| 403 | </dd></dl> |
---|
| 404 | |
---|
| 405 | <dl class="method"> |
---|
| 406 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_state"> |
---|
| 407 | <tt class="descname">set_state</tt><big>(</big><em>state=None</em>, <em>datainfo=None</em>, <em>format=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_state" title="Permalink to this definition">¶</a></dt> |
---|
| 408 | <dd><p>Call-back method for the fit page state reader. |
---|
| 409 | This method is called when a .fitv/.svs file is loaded.</p> |
---|
| 410 | <p>: param state: PageState object |
---|
| 411 | : param datainfo: data</p> |
---|
| 412 | </dd></dl> |
---|
| 413 | |
---|
| 414 | <dl class="method"> |
---|
| 415 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_theory"> |
---|
| 416 | <tt class="descname">set_theory</tt><big>(</big><em>theory_list=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_theory" title="Permalink to this definition">¶</a></dt> |
---|
| 417 | <dd></dd></dl> |
---|
| 418 | |
---|
| 419 | <dl class="method"> |
---|
| 420 | <dt id="sans.perspectives.fitting.fitting.Plugin.set_top_panel"> |
---|
| 421 | <tt class="descname">set_top_panel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.set_top_panel" title="Permalink to this definition">¶</a></dt> |
---|
| 422 | <dd><p>Close default (welcome) panel</p> |
---|
| 423 | </dd></dl> |
---|
| 424 | |
---|
| 425 | <dl class="method"> |
---|
| 426 | <dt id="sans.perspectives.fitting.fitting.Plugin.show_ftol_dialog"> |
---|
| 427 | <tt class="descname">show_ftol_dialog</tt><big>(</big><em>event=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.show_ftol_dialog" title="Permalink to this definition">¶</a></dt> |
---|
| 428 | <dd><p>Dialog to select ftol for Scipy</p> |
---|
| 429 | </dd></dl> |
---|
| 430 | |
---|
| 431 | <dl class="method"> |
---|
| 432 | <dt id="sans.perspectives.fitting.fitting.Plugin.split_string"> |
---|
| 433 | <tt class="descname">split_string</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.split_string" title="Permalink to this definition">¶</a></dt> |
---|
| 434 | <dd><p>receive a word containing dot and split it. used to split parameterset |
---|
| 435 | name into model name and parameter name example:</p> |
---|
| 436 | <div class="highlight-python"><pre>paramaterset (item) = M1.A |
---|
| 437 | Will return model_name = M1 , parameter name = A</pre> |
---|
| 438 | </div> |
---|
| 439 | </dd></dl> |
---|
| 440 | |
---|
| 441 | <dl class="method"> |
---|
| 442 | <dt id="sans.perspectives.fitting.fitting.Plugin.stop_fit"> |
---|
| 443 | <tt class="descname">stop_fit</tt><big>(</big><em>uid</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.stop_fit" title="Permalink to this definition">¶</a></dt> |
---|
| 444 | <dd><p>Stop the fit engine</p> |
---|
| 445 | </dd></dl> |
---|
| 446 | |
---|
| 447 | <dl class="method"> |
---|
| 448 | <dt id="sans.perspectives.fitting.fitting.Plugin.store_data"> |
---|
| 449 | <tt class="descname">store_data</tt><big>(</big><em>uid</em>, <em>data=None</em>, <em>data_list=None</em>, <em>caption=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.store_data" title="Permalink to this definition">¶</a></dt> |
---|
| 450 | <dd><p>Helper to save page reference into the plug-in</p> |
---|
| 451 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 452 | <col class="field-name" /> |
---|
| 453 | <col class="field-body" /> |
---|
| 454 | <tbody valign="top"> |
---|
| 455 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>page</strong> – page to store</td> |
---|
| 456 | </tr> |
---|
| 457 | </tbody> |
---|
| 458 | </table> |
---|
| 459 | </dd></dl> |
---|
| 460 | |
---|
| 461 | <dl class="method"> |
---|
| 462 | <dt id="sans.perspectives.fitting.fitting.Plugin.update_fit"> |
---|
| 463 | <tt class="descname">update_fit</tt><big>(</big><em>result=None</em>, <em>msg=''</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.update_fit" title="Permalink to this definition">¶</a></dt> |
---|
| 464 | <dd></dd></dl> |
---|
| 465 | |
---|
| 466 | <dl class="method"> |
---|
| 467 | <dt id="sans.perspectives.fitting.fitting.Plugin.use_data"> |
---|
| 468 | <tt class="descname">use_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fitting.Plugin.use_data" title="Permalink to this definition">¶</a></dt> |
---|
| 469 | <dd><p>return True if these plugin use data</p> |
---|
| 470 | </dd></dl> |
---|
| 471 | |
---|
| 472 | </dd></dl> |
---|
| 473 | |
---|
| 474 | </div> |
---|
| 475 | </div> |
---|
| 476 | |
---|
| 477 | |
---|
| 478 | </div> |
---|
| 479 | </div> |
---|
| 480 | </div> |
---|
| 481 | <div class="sphinxsidebar"> |
---|
| 482 | <div class="sphinxsidebarwrapper"> |
---|
| 483 | <h3><a href="../../../index.html">Table Of Contents</a></h3> |
---|
| 484 | <ul> |
---|
| 485 | <li><a class="reference internal" href="#">fitting</a><ul> |
---|
| 486 | <li><a class="reference internal" href="#module-sans.perspectives.fitting.fitting"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.fitting</span></tt></a></li> |
---|
| 487 | </ul> |
---|
| 488 | </li> |
---|
| 489 | </ul> |
---|
| 490 | |
---|
| 491 | <h4>Previous topic</h4> |
---|
| 492 | <p class="topless"><a href="fitproblem.html" |
---|
| 493 | title="previous chapter">fitproblem</a></p> |
---|
| 494 | <h4>Next topic</h4> |
---|
| 495 | <p class="topless"><a href="help_panel.html" |
---|
| 496 | title="next chapter">help_panel</a></p> |
---|
| 497 | <h3>This Page</h3> |
---|
| 498 | <ul class="this-page-menu"> |
---|
| 499 | <li><a href="../../../_sources/api/perspectives/fitting/fitting.txt" |
---|
| 500 | rel="nofollow">Show Source</a></li> |
---|
| 501 | </ul> |
---|
| 502 | <div id="searchbox" style="display: none"> |
---|
| 503 | <h3>Quick search</h3> |
---|
| 504 | <form class="search" action="../../../search.html" method="get"> |
---|
| 505 | <input type="text" name="q" size="18" /> |
---|
| 506 | <input type="submit" value="Go" /> |
---|
| 507 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 508 | <input type="hidden" name="area" value="default" /> |
---|
| 509 | </form> |
---|
| 510 | <p class="searchtip" style="font-size: 90%"> |
---|
| 511 | Enter search terms or a module, class or function name. |
---|
| 512 | </p> |
---|
| 513 | </div> |
---|
| 514 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 515 | </div> |
---|
| 516 | </div> |
---|
| 517 | <div class="clearer"></div> |
---|
| 518 | </div> |
---|
| 519 | <div class="related"> |
---|
| 520 | <h3>Navigation</h3> |
---|
| 521 | <ul> |
---|
| 522 | <li class="right" style="margin-right: 10px"> |
---|
| 523 | <a href="../../../genindex.html" title="General Index" |
---|
| 524 | >index</a></li> |
---|
| 525 | <li class="right" > |
---|
| 526 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
| 527 | >modules</a> |</li> |
---|
| 528 | <li class="right" > |
---|
| 529 | <a href="help_panel.html" title="help_panel" |
---|
| 530 | >next</a> |</li> |
---|
| 531 | <li class="right" > |
---|
| 532 | <a href="fitproblem.html" title="fitproblem" |
---|
| 533 | >previous</a> |</li> |
---|
| 534 | <li><a href="../../../index.html">sansview v0.1.0 documentation</a> »</li> |
---|
| 535 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 536 | </ul> |
---|
| 537 | </div> |
---|
| 538 | <div class="footer"> |
---|
| 539 | © Copyright 2010, sans group. |
---|
| 540 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. |
---|
| 541 | </div> |
---|
| 542 | </body> |
---|
| 543 | </html> |
---|