Changeset 997b620 in sasview for sansview/doc


Ignore:
Timestamp:
Feb 25, 2009 10:30:46 AM (16 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:
5b396b3
Parents:
1a6ec25
Message:

documentation added for averaging

Location:
sansview/doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • sansview/doc/averaging_help.html

    r2268d10 r997b620  
     1<html> 
     2<body> 
     3 
     4<h4>Data Averaging</h4> 
     5<ul> 
     6<li><a href="#Description">Description</a></li> 
     7<li><a href="#How to use">How to Average? </a></li> 
     8<p> Below follow the list of available averages: </p> 
     9<li><a href="#Sector"> Sector [Q view]</a></li> 
     10<li><a href="#Annulus"> Annulus [Phi view]</a></li> 
     11<li><a href="#Box sum"> Box sum</a></li> 
     12<li><a href="#Box averaging in Qx"> Box averaging in Qx</a></li> 
     13<li><a href="#Box averaging in Qy"> Box averaging in Qy</a></li> 
     14<li><a href="#Circular Average">Perform Circular Average</a></li> 
     15</ul> 
     16<h5><a name="Description">Description</a></h5> 
     17<p> 
     18 This feature allows you to perform different types of averages on your data, 
     19 and allows you to see what regions of the detector will contribute to  
     20 the average.  
     21Open the Average Panel, and try out some different types of averages. 
     22 The regions to be averaged are clearly shown on the data, and can be easily adjusted.  
     23This feature is available only for 2D Data. 
     24</p> 
     25 
     26 
     27<h5><a name="How to use">How to Average?</a></h5> 
     28<p> 
     29Right click on 2D data for the context menu to appear. Select one type of averages 
     30among <b>"sector [Q view]", "Annulus [Phi view]", "Box sum", "Box averaging in Qx ", 
     31"box averaging on Qy","Perform circular Average".</b> 
     32</p>  
     33<p> 
     34A slicer will appear except for <b> "Perform circular Average"</b> 
     35that you can drag by clicking on a slicer 's marker 
     36 .When the marker is highlighted in red , it means that the slicer can change size.You can 
     37 also move some of the slicer by simply drag its side when highlighted in red. 
     38 the slicer size will be reset to its previous size if the user try to select a region greater  
     39 than the size of the data. 
     40  
     41</p> 
     42 <p>The user can also select a region to average when a slicer has been selected already by <b>right  
     43 clicking </b> on the context menu and selecting <b>Edit Slicer Parameters</b>. The dialog window  
     44 will appears and the user can enter values to selected a region or selected numbers of points to  
     45 plot <b>nbins</b>. 
     46</p> 
     47  
     48<p> 
     49 For <b>Box sum</b> , when the user selects this option, a new panel is created containing  
     50 the result of average of the sum of every pixels contains on  that data.The user can also enter  
     51 values to select a region. 
     52</p> 
     53 
     54 
     55<h5><a name="Sector">Sector [Q view]</a></h5> 
     56<p> 
     57It averages in constant q-arcs. The width of the sector 
     58 is specified in degrees (+/- delta phi) each direction from the central angle (phi) 
     59</p> 
     60 
     61<h5><a name="Annulus"> Annulus [Phi view]</a></h5> 
     62<p> 
     63It performs an average between two q-values centered in (0,0), 
     64 and averaged over a width of a specified number of pixels. 
     65 The data is returned as a function of angle (phi) in degrees.Moving one circle of this slicer 
     66 to radius of zero corresponding to a circular averaging on radius qmax , the outer circle. 
     67</p> 
     68 
     69<h5><a name="Box sum"> Box sum</a></h5> 
     70<p> 
     71Perform the sum of counts in a 2D region of interest.When editing the slicer ,the user can  
     72enter the length and the width the rectangle slicer and the coordinates of the center of this 
     73rectangle. 
     74</p> 
     75<h5><a name="Box averaging in Qx"> Box averaging in Qx</a></h5> 
     76<p> 
     77Computes average I(Qx) for a region of interest.When editing the slicer ,the user can  
     78enter the length and the width the rectangle slicer. 
     79</p> 
     80<h5><a name="Box averaging in Qy"> Box averaging in Qy</a></h5> 
     81<p> 
     82 Computes average I(Qy) for a region of interest.When editing the slicer ,the user can  
     83enter the length and the width the rectangle slicer. 
     84</p> 
     85 
     86 
     87<h5><a name="Circular Average">Perform Circular Average</a></h5> 
     88<p> 
     89It will perform and average in constant q-rings around the (x,y) 
     90 pixel location of the beam center 
     91</p> 
     92</body> 
     93</html> 
     94 

  • sansview/doc/glossaryhelp.html

    rd292959 r997b620  
    1212<li><a href="save_data_help.html">Save data</a></li> 
    1313<li><a href="model_use_help.html">visualize model</a></li> 
     14<li><a href ="doc/averaging_help.html">Data Averaging</a><br></li> 
    1415</ul> 
    1516 
Note: See TracChangeset for help on using the changeset viewer.