Changeset 337


Ignore:
Timestamp:
May 28, 2014 1:38:15 PM (5 years ago)
Author:
prjemian
Message:

fixed a typo, clarified a point

File:
1 edited

Legend:

Unmodified
Added
Removed
  • canSAS2012/docs/source/examples.rst

    r282 r337  
    33.. _examples: 
    44 
    5 ================================================== 
     5====================================== 
    66Examples of the canSAS2012 data format 
    7 ================================================== 
     7====================================== 
    88 
    99.. sidebar:: TODO:  
     
    3131 
    3232:math:`I(Q)` models 
    33 ============================= 
     33=================== 
    3434 
    3535.. _minimum recommended 1-d I(Q): 
     
    9090        Qx: float[100, 512] 
    9191        Qy: float[100, 512] 
    92         Qx: float[100, 512] 
     92        Qz: float[100, 512] 
    9393 
    9494.. _2-D (image) I(|Q|) with uncertainty: 
    9595 
    96962-D (image)  :math:`I(|Q|)\pm\sigma(|Q|)` 
    97 ------------------------------------------------------ 
     97----------------------------------------- 
    9898 
    9999.. code-block:: text 
     
    201201small-angle neutron and X-ray scattering data.  
    202202Here the SANS data image is 100 x 512 pixels and 
    203 the SAXS data is 256 x 256 pixels. 
     203the SAXS data is 256 x 256 pixels.  (Normally, you will 
     204need more metadata for each probe, such as wavelength, to 
     205make a full analysis using both datasets.) 
    204206 
    205207.. code-block:: text 
     
    210212      SASdata 
    211213        @name="sans" 
     214        @probe_type="neutron" 
    212215        @Q_indices=0 
    213216        @I_axes="Q" 
     
    218221      SASdata 
    219222        @name="saxs" 
     223        @probe_type="xray" 
    220224        @Q_indices=0 
    221225        @I_axes="Q" 
     
    268272 
    269273:math:`I(t,Q)` models with time-dependence 
    270 ========================================================== 
     274========================================== 
    271275 
    2722761-D :math:`I(t,Q)` 
     
    292296 
    2932971-D :math:`I(t,Q(t))` 
    294 ---------------------------------------- 
     298--------------------- 
    295299 
    296300This example is slightly more complex, showing data where :math:`Q` is also time-dependent. 
     
    311315 
    3123161-D :math:`I(t,Q(t))\pm\sigma(t,Q(t))` 
    313 -------------------------------------------- 
     317-------------------------------------- 
    314318 
    315319Now, provide the uncertainties (where ``Idev`` represents  
     
    332336 
    3333372-D :math:`I(t,Q)` 
    334 ------------------- 
     338------------------ 
    335339 
    336340Examples:  
     
    376380 
    3773812-D :math:`I(t,Q(t))` masked image 
    378 ----------------------------------------- 
     382---------------------------------- 
    379383 
    380384This example explores a bit more complexity, adding a mask that is time-dependent. 
     
    453457 
    454458Complicated Uncertainties 
    455 ============================= 
     459========================= 
    456460 
    457461The uncertainties might be derived from several factors, or there may even be 
     
    463467 
    464468Representing Uncertainty Components 
    465 -------------------------------------- 
     469----------------------------------- 
    466470 
    467471It is possible to represent the components that contribute 
     
    501505 
    502506Representing Multiple Uncertainties (*proposed*) 
    503 ---------------------------------------------------- 
     507------------------------------------------------ 
    504508 
    505509.. note::  This is just a proposition.  It is based on the assumption 
     
    538542 
    5395432-D image with :math:`Q_x` & :math:`Q_y` vectors 
    540 ------------------------------------------------------------------------- 
     544------------------------------------------------ 
    541545 
    542546This model is outside the scope of this format.  The method of addressing  
Note: See TracChangeset for help on using the changeset viewer.