Changeset 275


Ignore:
Timestamp:
Nov 19, 2012 12:28:35 AM (7 years ago)
Author:
prjemian
Message:

examples for Jan Ilavsky and Brian Pauw

File:
1 edited

Legend:

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

    r227 r275  
    2727* `generic 2-D I(Q)`_ 
    2828* `simple 2-D (image) I(Q)`_ 
    29 * `1D SAS data in a time series I(t,Q)`_ 
    30  
     29* `1D SAS data in a time series I(t,Q(t))`_ 
    3130 
    3231 
     
    9291                                Qy: float[100, 512] 
    9392                                Qx: float[100, 512] 
     93 
     94.. _2-D (image) I(|Q|) with uncertainty: 
     95 
     962-D (image)  :math:`I(|Q|)\pm\sigma(|Q|)` 
     97------------------------------------------------------ 
     98 
     99.. code-block:: text 
     100        :linenos: 
     101         
     102        SASroot 
     103                SASentry 
     104                        SASdata 
     105                                @Q_indices=0,1 
     106                                @I_axes="Q,Q" 
     107                                I: float[300, 300] 
     108                                        @uncertainty=Idev 
     109                                Q: float[300, 300] 
     110                                Idev: float[300, 300] 
    94111 
    951122-D SAS/WAS images 
     
    270287                                Time: float[nTime]       
    271288 
    272 .. _1D SAS data in a time series I(t,Q): 
     289.. _1D SAS data in a time series I(t,Q(t)): 
    273290 
    2742911-D :math:`I(t,Q(t))` 
     
    286303                                @I_axes="Time,Q" 
    287304                                I: float[nTime,100] 
     305                                Q: float[nTime,100] 
     306                                Time: float[nTime] 
     307 
     308.. _1D SAS data in a time series I(t,Q(t)) +/- Idev(t,Q(t)): 
     309 
     3101-D :math:`I(t,Q(t))\pm\sigma(t,Q(t))` 
     311-------------------------------------------- 
     312 
     313Now, provide the uncertainties (where ``Idev`` represents  
     314:math:`\sigma(t,Q(t))` ) of the intensities: 
     315 
     316.. code-block:: text 
     317        :linenos: 
     318                 
     319        SASroot 
     320                SASentry 
     321                        SASdata 
     322                                @Q_indices=0,1 
     323                                @I_axes="Time,Q" 
     324                                I: float[nTime,100] 
     325                                        @uncertainty=Idev 
     326                                Idev: float[nTime,100] 
    288327                                Q: float[nTime,100] 
    289328                                Time: float[nTime] 
     
    411450 
    412451 
     452.. _representing uncertainty components: 
     453 
     454Representing Uncertainty Components 
     455-------------------------------------- 
     456 
     457It is possible to represent the components that contribute 
     458to the uncertainty by use of a subgroup.  Add a *@components* attribute 
     459to the principal uncertainty, naming the subgroup that contains the  
     460contributing datasets. 
     461 
     462As with all uncertainties, each component should have the same *shape*  
     463(rank and dimensions) as its parent dataset. 
     464 
     465Note that a *@basis* attribute indicates how this uncertainty was determined. 
     466The values are expected to be a short list, as yet unspecified. 
     467 
     468.. code-block:: text 
     469        :linenos: 
     470 
     471        SASroot 
     472                SASentry 
     473                        SASdata 
     474                                @Q_indices=0 
     475                                @I_axes=Q 
     476                                Q : float[nI] 
     477                                I : float[nI] 
     478                                   @uncertainty=Idev 
     479                                Idev : float[nI] 
     480                                   @components=I_uncertainties 
     481                                I_uncertainties: 
     482                                   electronic : float[nI] 
     483                                      @basis="Johnson noise" 
     484                                   counting_statistics: float[nI] 
     485                                      @basis="shot noise" 
     486                                   secondary_standard: float[nI] 
     487                                      @basis="esd" 
     488 
     489 
     490.. _proposed expression of multiple uncertainties: 
     491 
     492Expression of Multiple Uncertainties (*proposed*) 
     493---------------------------------------------------- 
     494 
     495.. note::  This is just a proposition.  It is based on the assumption 
     496   that some analysis method might actually know how to handle this case. 
     497 
     498If more than one uncertainty contributes to the intensity (and the method 
     499described above in :ref:`representing uncertainty components`  
     500is not appropriate), it is proposed to 
     501name more than one uncertainty dataset in the *@uncertainty* attribute. 
     502The first member in this list would be the principal uncertainty. 
     503One example be:  
     504 
     505.. code-block:: text 
     506        :linenos: 
     507 
     508        SASroot 
     509                SASentry 
     510                        SASdata 
     511                                @Q_indices=0 
     512                                @I_axes=Q 
     513                                Q : float[nI] 
     514                                I : float[nI] 
     515                                   @uncertainty=Idev,Ierr 
     516                                Idev : float[nI] 
     517                                Ierr : float[nI] 
     518 
     519 
    413520 
    414521.. TODO: Could make this a note 
Note: See TracChangeset for help on using the changeset viewer.