Changeset 69fee24 in sasview for calculator/docs/sphinx

Timestamp:

May 28, 2010 1:37:18 PM (15 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ddf6df3

Parents:

25a2ee3

Message:

working on documentation

Location:

calculator/docs/sphinx/_build

Files:

• doctrees/api/slit_length_calculator.doctree (modified) (previous)
• doctrees/environment.pickle (modified) (previous)
• html/api/slit_length_calculator.html (modified) (1 diff)
• html/objects.inv (modified) (previous)
• html/searchindex.js (modified) (1 diff)

calculator/docs/sphinx/_build/html/api/slit_length_calculator.html

@@ -65 +65 @@
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
 <tt class="descname">calculate_slit_length</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length" title="Permalink to this definition">¶</a></dt>
-<dd>Calculate slit length.</dd></dl>
+<dd><p>Calculate slit length.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="method">
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
 <tt class="descname">get_slit_length_unit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit" title="Permalink to this definition">¶</a></dt>
-<dd>return the slit length unit.</dd></dl>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="method">
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
 <tt class="descname">set_data</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt>
-<dd>set data
-:param x, y: x array and y array</dd></dl>
+<dd><blockquote>
+Receive two vector x, y and prepare the slit calculator for 
+computation.</blockquote>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>x</strong> &#8211; array</li>
+<li><strong>y</strong> &#8211; array</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>

calculator/docs/sphinx/_build/html/searchindex.js

@@ -1 @@
-Search.setIndex({objects:{"sans.calculator.sld_calculator":{SldCalculator:[3,1,1]},"sans.calculator":{sld_calculator:[3,0,0],slit_length_calculator:[2,0,0]},"sans.calculator.slit_length_calculator.SlitlengthCalculator":{get_slit_length_unit:[2,2,1],calculate_slit_length:[2,2,1],set_data:[2,2,1]},"sans.calculator.sld_calculator.SldCalculator":{calculate_neutron_sld:[3,2,1],calculate_length:[3,2,1],calculate_xray_sld:[3,2,1],set_value:[3,2,1]},"sans.calculator.slit_length_calculator":{SlitlengthCalculator:[2,1,1]}},terms:{thi:[2,3],follow:[1,3],paramet:[],get_slit_length_unit:2,easi:3,param:[2,3],should:[],better:[],densiti:3,arrai:2,real:3,applic:[1,3],"return":[2,3],string:3,get:3,molecul:3,beam:2,calculate_sld_im:[],volum:3,method:3,necessari:1,user_formula:[],each:1,small:[1,2],page:1,set:2,sld_calcul:[0,3],sldcalcul:3,result:3,proper:3,wavelength:3,todo:[],index:1,absorpt:[],sub:1,"3rd":2,section:3,slit_length_calcul:[0,2],content:[],formula:3,imaginari:3,slitlengthcalcul:2,refer:[0,1],alina:[],sansview:1,contain:1,calculate_slit_length:2,calculate_length:3,set_data:2,releas:[0,1],valu:[2,3],search:1,current:1,prior:3,length:[0,1,2,3],base:[2,3],calculate_neutron_sld:3,coh:[],col:2,point:[],modul:[2,1,3],independ:1,"2nd":2,saxsess:2,"1st":2,unit:2,given:3,from:2,call:3,sld_real:3,interfac:3,store:3,quickli:2,tool:[1,2],factor:[],part:3,atom:3,set_valu:3,must:3,none:2,provid:3,calcul:[0,1,2,3],sld:[0,1,3],scatter:3,later:3,comput:[2,1,3],san:[0,2,3],indic:1,packag:[1,3],slit:[0,1,2],exist:3,coher:[],tabl:1,need:[2,3],gervais:[],inc:3,date:[0,1],welcom:[],calculate_xray_sld:3,titl:[],cross:3,note:3,other:1,futur:[],document:[],neutron:3,incoher:3,sld_im:3,relat:[],intend:3,allow:2,max:[],object:[2,3],periodict:3,user:[2,3],mai:[0,1],elementi:3,absorp:[],data:2,"class":[2,3],don:2,calculate_coherence_im:[],author:[],correspond:3,element:3,h2o:3,exampl:3,determin:[2,3],profil:2,order:3},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Reference","Calculator","Slit Length Calculator","Sld Calculator"],objnames:{"0":"Python module","1":"Python class","2":"Python method"},filenames:["api/index","index","api/slit_length_calculator","api/sld_calculator"]})
+Search.setIndex({objects:{"sans.calculator.sld_calculator":{SldCalculator:[2,1,1]},"sans.calculator":{sld_calculator:[2,0,0],slit_length_calculator:[3,0,0]},"sans.calculator.slit_length_calculator.SlitlengthCalculator":{get_slit_length_unit:[3,2,1],calculate_slit_length:[3,2,1],set_data:[3,2,1]},"sans.calculator.sld_calculator.SldCalculator":{set_value:[2,2,1],calculate_xray_sld:[2,2,1],calculate_length:[2,2,1],calculate_neutron_sld:[2,2,1]},"sans.calculator.slit_length_calculator":{SlitlengthCalculator:[3,1,1]}},terms:{follow:[1,2],paramet:3,get_slit_length_unit:3,easi:2,param:2,should:[],better:[],densiti:2,determin:[3,2],modul:[1,2,3],real:2,applic:[1,2],"return":[3,2],string:2,get:2,molecul:2,beam:3,calculate_sld_im:[],volum:2,vector:3,necessari:1,calculate_xray_sld:2,user_formula:[],contain:1,small:[1,3],page:1,set:[],sld_calcul:[0,2],sldcalcul:2,result:2,proper:2,wavelength:2,todo:[],index:1,absorpt:[],sub:1,"3rd":3,imaginari:2,section:2,slit_length_calcul:[0,3],content:[],formula:2,method:2,slitlengthcalcul:3,refer:[0,1],alina:[],sansview:1,each:1,calculate_slit_length:3,calculate_length:2,set_data:3,releas:[0,1],valu:[3,2],search:1,current:1,prior:2,length:[0,1,2,3],base:[3,2],calculate_neutron_sld:2,coh:[],col:3,point:[],arrai:3,independ:1,"2nd":3,saxsess:3,"1st":3,unit:3,given:2,from:3,two:3,call:2,sld_real:2,interfac:2,store:2,quickli:3,tool:[1,3],factor:[],part:2,atom:2,set_valu:2,must:2,none:3,provid:2,prepar:3,calcul:[0,1,2,3],sld:[0,1,2],scatter:2,comput:[1,2,3],san:[0,3,2],indic:1,packag:[1,2],slit:[0,1,3],exist:2,coher:[],tabl:1,need:[3,2],gervais:[],inc:2,mai:[0,1],welcom:[],author:[],receiv:3,titl:[],cross:2,note:2,other:1,futur:[],document:[],neutron:2,incoher:2,sld_im:2,relat:[],intend:2,allow:3,max:[],object:[3,2],periodict:2,user:[3,2],date:[0,1],elementi:2,absorp:[],data:3,"class":[3,2],don:3,calculate_coherence_im:[],later:2,correspond:2,element:2,h2o:2,exampl:2,thi:[3,2],profil:3,order:2},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},titles:["Reference","Calculator","Sld Calculator","Slit Length Calculator"],objnames:{"0":"Python module","1":"Python class","2":"Python method"},filenames:["api/index","index","api/sld_calculator","api/slit_length_calculator"]})