[a462c6a] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
---|
| 3 | |
---|
| 4 | |
---|
| 5 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 6 | <head> |
---|
| 7 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 8 | |
---|
| 9 | <title>sas.perspectives.fitting.plugin_models.testmodel — SasView 3.0.0 documentation</title> |
---|
| 10 | |
---|
| 11 | <link rel="stylesheet" href="../../../../../_static/default.css" type="text/css" /> |
---|
| 12 | <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" /> |
---|
| 13 | |
---|
| 14 | <script type="text/javascript"> |
---|
| 15 | var DOCUMENTATION_OPTIONS = { |
---|
| 16 | URL_ROOT: '../../../../../', |
---|
| 17 | VERSION: '3.0.0', |
---|
| 18 | COLLAPSE_INDEX: false, |
---|
| 19 | FILE_SUFFIX: '.html', |
---|
| 20 | HAS_SOURCE: true |
---|
| 21 | }; |
---|
| 22 | </script> |
---|
| 23 | <script type="text/javascript" src="../../../../../_static/jquery.js"></script> |
---|
| 24 | <script type="text/javascript" src="../../../../../_static/underscore.js"></script> |
---|
| 25 | <script type="text/javascript" src="../../../../../_static/doctools.js"></script> |
---|
| 26 | <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
| 27 | <link rel="top" title="SasView 3.0.0 documentation" href="../../../../../index.html" /> |
---|
| 28 | <link rel="up" title="sas.perspectives.fitting" href="../../fitting.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><a href="../../../../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
| 41 | <li><a href="../../../../index.html" >Module code</a> »</li> |
---|
| 42 | <li><a href="../../fitting.html" accesskey="U">sas.perspectives.fitting</a> »</li> |
---|
| 43 | </ul> |
---|
| 44 | </div> |
---|
| 45 | |
---|
| 46 | <div class="document"> |
---|
| 47 | <div class="documentwrapper"> |
---|
| 48 | <div class="bodywrapper"> |
---|
| 49 | <div class="body"> |
---|
| 50 | |
---|
| 51 | <h1>Source code for sas.perspectives.fitting.plugin_models.testmodel</h1><div class="highlight"><pre> |
---|
| 52 | <span class="sd">"""</span> |
---|
| 53 | <span class="sd">Test plug-in model</span> |
---|
| 54 | <span class="sd">These are links of available functions:</span> |
---|
| 55 | |
---|
| 56 | <span class="sd">http://docs.python.org/library/math.html</span> |
---|
| 57 | <span class="sd">http://www.scipy.org/Numpy_Functions_by_Category</span> |
---|
| 58 | <span class="sd">"""</span> |
---|
| 59 | |
---|
| 60 | <span class="sd">"""</span> |
---|
| 61 | <span class="sd">## *****************************************************************************</span> |
---|
| 62 | <span class="sd">Please select the 'Compile' from the menubar after the modification and saving.</span> |
---|
| 63 | <span class="sd">Note that we recommend to save the file as a different file name.</span> |
---|
| 64 | <span class="sd">Otherwise, it could be removed in the future on re-installation of the SasView.</span> |
---|
| 65 | <span class="sd">## *****************************************************************************</span> |
---|
| 66 | <span class="sd">"""</span> |
---|
| 67 | |
---|
| 68 | <span class="kn">from</span> <span class="nn">sas.models.pluginmodel</span> <span class="kn">import</span> <span class="n">Model1DPlugin</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 69 | <span class="kn">import</span> <span class="nn">math</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 70 | <span class="kn">import</span> <span class="nn">numpy</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 71 | <span class="kn">import</span> <span class="nn">os</span> |
---|
| 72 | <span class="kn">import</span> <span class="nn">sys</span> |
---|
| 73 | <span class="c">##PLEASE READ COMMENTS CAREFULLY !!! COMMENT ARE IN CAPITAL LETTERS AND AFTER ##</span> |
---|
| 74 | <span class="c">## THESE COMMENTS ARE THERE TO GUIDE YOU. YOU CAN REMOVE THEM ONLY WHEN YOU ARE</span> |
---|
| 75 | <span class="c">## CONFORTABLE ENOUGH WITH OUR MODEL PLUGIN OPTION</span> |
---|
| 76 | |
---|
| 77 | |
---|
| 78 | <span class="c">## <----- SIGN DEFINES WHERE YOU CAN MODIFY THE CODE</span> |
---|
| 79 | |
---|
| 80 | <div class="viewcode-block" id="Model"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.testmodel.Model">[docs]</a><span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">Model1DPlugin</span><span class="p">):</span><span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 81 | <span class="sd">"""</span> |
---|
| 82 | <span class="sd"> ##YOU CAN BE MODIFY ANYTHING BETWEEN """</span> <span class="s">"""</span> |
---|
| 83 | <span class="s"> ##DESCRIPTION OF MODEL PLUG-IN GOES HERE</span> |
---|
| 84 | <span class="s"> </span> |
---|
| 85 | <span class="s"> ##EXAMPLE:Class that evaluates a cos(x) model. </span> |
---|
| 86 | <span class="s"> """</span> |
---|
| 87 | <span class="n">name</span> <span class="o">=</span> <span class="s">""</span> |
---|
| 88 | |
---|
| 89 | <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
---|
| 90 | <span class="sd">"""</span> |
---|
| 91 | <span class="sd"> Initialization</span> |
---|
| 92 | <span class="sd"> """</span> |
---|
| 93 | <span class="n">Model1DPlugin</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 94 | |
---|
| 95 | <span class="c">## EDIT PARAMETERS' NAMES AND VALUE</span> |
---|
| 96 | <span class="c">## DELETE MODIFIABLE LINE HERE WILL REDUCE THE NUMBER OF PARAMETERS</span> |
---|
| 97 | <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 98 | <span class="c"># Set the name same as the file name</span> |
---|
| 99 | <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fname</span><span class="p">()</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 100 | <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN ' ' AND NUMBER </span> |
---|
| 101 | <span class="c">## YOU CAN ALSO DELETE THIS LINE</span> |
---|
| 102 | <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'A'</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="c">## <----- </span> |
---|
| 103 | <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN ' ' AND NUMBER </span> |
---|
| 104 | <span class="c">## YOU CAN ALSO DELETE THIS LINE </span> |
---|
| 105 | <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'B'</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="c">## <----- </span> |
---|
| 106 | <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN ' ' AND NUMBER </span> |
---|
| 107 | <span class="c">## YOU CAN ALSO DELETE THIS LINE </span> |
---|
| 108 | <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'C'</span><span class="p">]</span> <span class="o">=</span> <span class="mf">10.0</span> <span class="c">## <----- </span> |
---|
| 109 | |
---|
| 110 | <span class="c">## DEFINE DEFAULT DETAILS</span> |
---|
| 111 | <span class="bp">self</span><span class="o">.</span><span class="n">set_details</span><span class="p">()</span> <span class="c">##DO NOT DELETE OR CHANGE THIS LINE!!!</span> |
---|
| 112 | |
---|
| 113 | <span class="c">## YOU CAN MODIFY THE LINE BELLOW.MODIFY WORDS BETWEEN """ """ ONLY!!!!</span> |
---|
| 114 | <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">"F(x)=A+Bcos(2x)+Csin(2x) "</span> <span class="c">## <----- </span> |
---|
| 115 | |
---|
| 116 | <div class="viewcode-block" id="Model.function"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.testmodel.Model.function">[docs]</a> <span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span> |
---|
| 117 | <span class="sd">"""</span> |
---|
| 118 | <span class="sd"> Evaluate the model</span> |
---|
| 119 | <span class="sd"> </span> |
---|
| 120 | <span class="sd"> :param x: input x</span> |
---|
| 121 | <span class="sd"> </span> |
---|
| 122 | <span class="sd"> :return: function value</span> |
---|
| 123 | <span class="sd"> </span> |
---|
| 124 | <span class="sd"> """</span> |
---|
| 125 | <span class="c">## ADD YOUR FUNCTION HERE.</span> |
---|
| 126 | <span class="c">## REUSE THE PARAMETERS DEFINED PREVIOUSLY TO WRITE YOUR FUNCTION.</span> |
---|
| 127 | |
---|
| 128 | <span class="c">## IN THIS EXAMPLE THE FUNTION IS:</span> |
---|
| 129 | <span class="c">## A+Bcos(2x)+Csin(2x)</span> |
---|
| 130 | <span class="c">## YOU CAN USE math.sin or sin directly</span> |
---|
| 131 | <span class="c">## NOTE: sin, cos ARE FUNCTIONS IMPORTED FROM PYTHON MATH LIBRARY</span> |
---|
| 132 | <span class="c">## FOR MORE INFORMATION CHECK http://docs.python.org/library/math.html </span> |
---|
| 133 | <span class="c">## OTHER FUNCTIONS ARE ALSO </span> |
---|
| 134 | <span class="c">## AVAILABLE http://www.scipy.org/Numpy_Functions_by_Category</span> |
---|
| 135 | <span class="c">## numpy FUNCTIONS ARE FOR EXPERT USER</span> |
---|
| 136 | |
---|
| 137 | <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'A'</span><span class="p">]</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'B'</span><span class="p">]</span><span class="o">*</span><span class="n">math</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">x</span><span class="p">)</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">'C'</span><span class="p">]</span><span class="o">*</span><span class="n">math</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="mf">2.0</span><span class="o">*</span><span class="n">x</span><span class="p">)</span> |
---|
| 138 | |
---|
| 139 | <span class="c">## DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!! </span></div> |
---|
| 140 | <div class="viewcode-block" id="Model.get_fname"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.testmodel.Model.get_fname">[docs]</a> <span class="k">def</span> <span class="nf">get_fname</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
---|
| 141 | <span class="sd">"""</span> |
---|
| 142 | <span class="sd"> Get the model name same as the file name</span> |
---|
| 143 | <span class="sd"> """</span> |
---|
| 144 | <span class="n">path</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_filename</span> |
---|
| 145 | <span class="n">basename</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
---|
| 146 | <span class="n">name</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">basename</span><span class="p">)</span> |
---|
| 147 | <span class="k">return</span> <span class="n">name</span> |
---|
| 148 | |
---|
| 149 | <span class="c">## DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!! </span></div></div> |
---|
| 150 | <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span> |
---|
| 151 | <span class="n">m</span><span class="o">=</span> <span class="n">Model</span><span class="p">()</span> |
---|
| 152 | <span class="n">out1</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="mf">0.0</span><span class="p">)</span> |
---|
| 153 | <span class="n">out2</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="mf">0.01</span><span class="p">)</span> |
---|
| 154 | <span class="n">isfine1</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">out1</span><span class="p">)</span> |
---|
| 155 | <span class="n">isfine2</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">out2</span><span class="p">)</span> |
---|
| 156 | <span class="k">print</span> <span class="s">"Testing the value at Q = 0.0:"</span> |
---|
| 157 | <span class="k">print</span> <span class="n">out1</span><span class="p">,</span> <span class="s">" : finite? "</span><span class="p">,</span> <span class="n">isfine1</span> |
---|
| 158 | <span class="k">print</span> <span class="s">"Testing the value at Q = 0.01:"</span> |
---|
| 159 | <span class="k">print</span> <span class="n">out2</span><span class="p">,</span> <span class="s">" : finite? "</span><span class="p">,</span> <span class="n">isfine2</span> |
---|
| 160 | <span class="k">if</span> <span class="n">isfine1</span> <span class="ow">and</span> <span class="n">isfine2</span><span class="p">:</span> |
---|
| 161 | <span class="k">print</span> <span class="s">"===> Simple Test: Passed!"</span> |
---|
| 162 | <span class="k">else</span><span class="p">:</span> |
---|
| 163 | <span class="k">print</span> <span class="s">"===> Simple Test: Failed!"</span> |
---|
| 164 | </pre></div> |
---|
| 165 | |
---|
| 166 | </div> |
---|
| 167 | </div> |
---|
| 168 | </div> |
---|
| 169 | <div class="sphinxsidebar"> |
---|
| 170 | <div class="sphinxsidebarwrapper"> |
---|
| 171 | <div id="searchbox" style="display: none"> |
---|
| 172 | <h3>Quick search</h3> |
---|
| 173 | <form class="search" action="../../../../../search.html" method="get"> |
---|
| 174 | <input type="text" name="q" /> |
---|
| 175 | <input type="submit" value="Go" /> |
---|
| 176 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 177 | <input type="hidden" name="area" value="default" /> |
---|
| 178 | </form> |
---|
| 179 | <p class="searchtip" style="font-size: 90%"> |
---|
| 180 | Enter search terms or a module, class or function name. |
---|
| 181 | </p> |
---|
| 182 | </div> |
---|
| 183 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 184 | </div> |
---|
| 185 | </div> |
---|
| 186 | <div class="clearer"></div> |
---|
| 187 | </div> |
---|
| 188 | <div class="related"> |
---|
| 189 | <h3>Navigation</h3> |
---|
| 190 | <ul> |
---|
| 191 | <li class="right" style="margin-right: 10px"> |
---|
| 192 | <a href="../../../../../genindex.html" title="General Index" |
---|
| 193 | >index</a></li> |
---|
| 194 | <li class="right" > |
---|
| 195 | <a href="../../../../../py-modindex.html" title="Python Module Index" |
---|
| 196 | >modules</a> |</li> |
---|
| 197 | <li><a href="../../../../../index.html">SasView 3.0.0 documentation</a> »</li> |
---|
| 198 | <li><a href="../../../../index.html" >Module code</a> »</li> |
---|
| 199 | <li><a href="../../fitting.html" >sas.perspectives.fitting</a> »</li> |
---|
| 200 | </ul> |
---|
| 201 | </div> |
---|
| 202 | <div class="footer"> |
---|
| 203 | © Copyright 2013, The SasView Project. |
---|
| 204 | Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. |
---|
| 205 | </div> |
---|
| 206 | </body> |
---|
| 207 | </html> |
---|