Changeset 276


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

formatting (examples were too wide using tabs, replace with two spaces)

File:
1 edited

Legend:

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

    r275 r276  
    99.. sidebar:: TODO:  
    1010 
    11         Describe, in general, the examples.  Explain how they were created and  
    12         what assumptions were involved. 
    13          
     11  Describe, in general, the examples.  Explain how they were created and  
     12  what assumptions were involved. 
     13   
    1414It is useful to express the canSAS2012 data structure in terms of some common  
    1515data models used for the analysis of small-angle scattering data.  These models 
     
    4040.. sidebar::  Compare... 
    4141 
    42         This model could describe data stored in the the canSAS1d/1.0 format (with the addition of  
    43         *uncertainty* data and some additional metadata). 
     42  This model could describe data stored in the the canSAS1d/1.0 format (with the addition of  
     43  *uncertainty* data and some additional metadata). 
    4444 
    4545 
     
    4949 
    5050.. code-block:: text 
    51         :linenos: 
    52          
    53         SASroot 
    54                 SASentry 
    55                         SASdata 
    56                                 @Q_indices=0 
    57                                 @I_axes="Q" 
    58                                 I: float[100] 
    59                                 Q: float[100]    
     51  :linenos: 
     52   
     53  SASroot 
     54    SASentry 
     55      SASdata 
     56        @Q_indices=0 
     57        @I_axes="Q" 
     58        I: float[100] 
     59        Q: float[100] 
    6060 
    6161 
     
    6767 
    6868.. note:: For clarity, the other possible metadata has been left out  
    69                 from the remainder of the examples here. 
     69    from the remainder of the examples here. 
    7070 
    7171 
     
    7575--------- 
    7676 
    77 Examples:        
     77Examples: 
    7878:download:`HDF5 <../../examples/hdf5/simple2dcase.h5>` 
    7979:download:`XML <../../examples/xml/simple2dcase.xml>`  
    8080 
    8181.. code-block:: text 
    82         :linenos: 
    83          
    84         SASroot 
    85                 SASentry 
    86                         SASdata 
    87                                 @Q_indices=0,1 
    88                                 @I_axes="Q,Q" 
    89                                 I: float[100, 512] 
    90                                 Qx: float[100, 512] 
    91                                 Qy: float[100, 512] 
    92                                 Qx: float[100, 512] 
     82  :linenos: 
     83   
     84  SASroot 
     85    SASentry 
     86      SASdata 
     87        @Q_indices=0,1 
     88        @I_axes="Q,Q" 
     89        I: float[100, 512] 
     90        Qx: float[100, 512] 
     91        Qy: float[100, 512] 
     92        Qx: float[100, 512] 
    9393 
    9494.. _2-D (image) I(|Q|) with uncertainty: 
     
    9898 
    9999.. 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] 
     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] 
    111111 
    1121122-D SAS/WAS images 
     
    122122 
    123123.. code-block:: text 
    124         :linenos: 
    125                  
    126         SASroot 
    127                 SASentry 
    128                         SASdata 
    129                                 @name="sasdata" 
    130                                 @Q_indices=0,1 
    131                                 @I_axes="Q,Q" 
    132                                 I: float[100, 512] 
    133                                 Qx: float[100, 512] 
    134                                 Qy: float[100, 512] 
    135                                 Qz: float[100, 512] 
    136                         SASdata 
    137                                 @name="wasdata" 
    138                                 @Q_indices=0,1 
    139                                 @I_axes="Q,Q" 
    140                                 I: float[256, 256] 
    141                                 Qx: float[256, 256] 
    142                                 Qy: float[256, 256] 
    143                                 Qz: float[256, 256] 
     124  :linenos: 
     125     
     126  SASroot 
     127    SASentry 
     128      SASdata 
     129        @name="sasdata" 
     130        @Q_indices=0,1 
     131        @I_axes="Q,Q" 
     132        I: float[100, 512] 
     133        Qx: float[100, 512] 
     134        Qy: float[100, 512] 
     135        Qz: float[100, 512] 
     136      SASdata 
     137        @name="wasdata" 
     138        @Q_indices=0,1 
     139        @I_axes="Q,Q" 
     140        I: float[256, 256] 
     141        Qx: float[256, 256] 
     142        Qy: float[256, 256] 
     143        Qz: float[256, 256] 
    144144 
    1451452-D masked image 
    146146---------------- 
    147147 
    148 Examples:        
     148Examples:     
    149149:download:`HDF5 <../../examples/hdf5/simple2dmaskedcase.h5>` 
    150150:download:`XML <../../examples/xml/simple2dmaskedcase.xml>`  
    151151 
    152152.. code-block:: text 
    153         :linenos: 
    154          
    155         SASroot 
    156                 SASentry 
    157                         SASdata 
    158                                 @Q_indices=0,1 
    159                                 @I_axes="Q,Q" 
    160                                 @Mask_indices=0,1 
    161                                 I: float[100, 512] 
    162                                 Qx: float[100, 512] 
    163                                 Qy: float[100, 512] 
    164                                 Qz: float[100, 512] 
    165                                 Mask: int[100, 512] 
     153  :linenos: 
     154   
     155  SASroot 
     156    SASentry 
     157      SASdata 
     158        @Q_indices=0,1 
     159        @I_axes="Q,Q" 
     160        @Mask_indices=0,1 
     161        I: float[100, 512] 
     162        Qx: float[100, 512] 
     163        Qy: float[100, 512] 
     164        Qz: float[100, 512] 
     165        Mask: int[100, 512] 
    166166 
    167167 
     
    176176of any geometry.  This is the most flexible. 
    177177 
    178 Examples:        
     178Examples:      
    179179:download:`HDF5 <../../examples/hdf5/generic2dcase.h5>` 
    180180:download:`XML <../../examples/xml/generic2dcase.xml>` 
    181181 
    182182.. code-block:: text 
    183         :linenos: 
    184          
    185         SASroot 
    186                 SASentry 
    187                         SASdata 
    188                                 @Q_indices=0 
    189                                 @I_axes="Q" 
    190                                 I: float[100*512] 
    191                                 Qx: float[100*512] 
    192                                 Qy: float[100*512] 
    193                                 Qz: float[100*512] 
     183  :linenos: 
     184   
     185  SASroot 
     186    SASentry 
     187      SASdata 
     188        @Q_indices=0 
     189        @I_axes="Q" 
     190        I: float[100*512] 
     191        Qx: float[100*512] 
     192        Qy: float[100*512] 
     193        Qz: float[100*512] 
    194194 
    1951952-D SANS and SAXS 
     
    202202 
    203203.. code-block:: text 
    204         :linenos: 
    205          
    206         SASroot 
    207                 SASentry 
    208                         SASdata 
    209                                 @name="sans" 
    210                                 @Q_indices=0 
    211                                 @I_axes="Q" 
    212                                 I: float[100*512] 
    213                                 Qx: float[100*512] 
    214                                 Qy: float[100*512] 
    215                                 Qz: float[100*512] 
    216                         SASdata 
    217                                 @name="saxs" 
    218                                 @Q_indices=0 
    219                                 @I_axes="Q" 
    220                                 I: float[256*256] 
    221                                 Qx: float[256*256] 
    222                                 Qy: float[256*256] 
    223                                 Qz: float[256*256] 
     204  :linenos: 
     205   
     206  SASroot 
     207    SASentry 
     208      SASdata 
     209        @name="sans" 
     210        @Q_indices=0 
     211        @I_axes="Q" 
     212        I: float[100*512] 
     213        Qx: float[100*512] 
     214        Qy: float[100*512] 
     215        Qz: float[100*512] 
     216      SASdata 
     217        @name="saxs" 
     218        @Q_indices=0 
     219        @I_axes="Q" 
     220        I: float[256*256] 
     221        Qx: float[256*256] 
     222        Qy: float[256*256] 
     223        Qz: float[256*256] 
    224224 
    225225 
     
    234234Also, a certain number of pixels (``nDiscardedPixels``) have been discarded 
    235235previously from the data for various reasons. 
    236          
    237         .. tip::  Typical data might have fewer useful pixels due to various 
    238                 detector artifacts such as zingers, streaks, and dead spots, as well 
    239                 as an applied intensity mask.  There is no need to write such useless pixels 
    240                 to the data objects. 
    241  
    242         ==============  ========   ==================== 
    243         intensity       detector   shape 
    244         ==============  ========   ==================== 
    245         :math:`I_a(Q)`  2-D        100 x 512 pixels 
    246         :math:`I_b(Q)`  1-D        2000 pixels 
    247         :math:`I_c(Q)`  2-D        256 x 256 pixels 
    248         ==============  ========   ==================== 
    249  
    250         Data from a SAXS/MAXS/WAXS instrument might be represented thus. 
    251  
    252 .. code-block:: text 
    253         :linenos: 
    254                  
    255         SASroot 
    256                 SASentry 
    257                         SASdata 
    258                                 @Q_indices=0 
    259                                 @I_axes="Q" 
    260                                 I: float[100*512  + 2000 + 256*256 - nDiscardedPixels] 
    261                                 Qx: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
    262                                 Qy: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
    263                                 Qz: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
     236   
     237  .. tip::  Typical data might have fewer useful pixels due to various 
     238    detector artifacts such as zingers, streaks, and dead spots, as well 
     239    as an applied intensity mask.  There is no need to write such useless pixels 
     240    to the data objects. 
     241 
     242  ==============  ========   ==================== 
     243  intensity       detector   shape 
     244  ==============  ========   ==================== 
     245  :math:`I_a(Q)`  2-D        100 x 512 pixels 
     246  :math:`I_b(Q)`  1-D        2000 pixels 
     247  :math:`I_c(Q)`  2-D        256 x 256 pixels 
     248  ==============  ========   ==================== 
     249 
     250  Data from a SAXS/MAXS/WAXS instrument might be represented thus. 
     251 
     252.. code-block:: text 
     253  :linenos: 
     254     
     255  SASroot 
     256    SASentry 
     257      SASdata 
     258        @Q_indices=0 
     259        @I_axes="Q" 
     260        I: float[100*512  + 2000 + 256*256 - nDiscardedPixels] 
     261        Qx: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
     262        Qy: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
     263        Qz: float[100*512 + 2000 + 256*256 - nDiscardedPixels] 
    264264 
    265265 
     
    276276 
    277277.. code-block:: text 
    278         :linenos: 
    279          
    280         SASroot 
    281                 SASentry 
    282                         SASdata 
    283                                 @Q_indices=1 
    284                                 @I_axes="Time,Q" 
    285                                 I: float[nTime,100] 
    286                                 Q: float[100] 
    287                                 Time: float[nTime]       
     278  :linenos: 
     279   
     280  SASroot 
     281    SASentry 
     282      SASdata 
     283        @Q_indices=1 
     284        @I_axes="Time,Q" 
     285        I: float[nTime,100] 
     286        Q: float[100] 
     287        Time: float[nTime]   
    288288 
    289289.. _1D SAS data in a time series I(t,Q(t)): 
     
    295295 
    296296.. code-block:: text 
    297         :linenos: 
    298                  
    299         SASroot 
    300                 SASentry 
    301                         SASdata 
    302                                 @Q_indices=0,1 
    303                                 @I_axes="Time,Q" 
    304                                 I: float[nTime,100] 
    305                                 Q: float[nTime,100] 
    306                                 Time: float[nTime] 
     297  :linenos: 
     298     
     299  SASroot 
     300    SASentry 
     301      SASdata 
     302        @Q_indices=0,1 
     303        @I_axes="Time,Q" 
     304        I: float[nTime,100] 
     305        Q: float[nTime,100] 
     306        Time: float[nTime] 
    307307 
    308308.. _1D SAS data in a time series I(t,Q(t)) +/- Idev(t,Q(t)): 
     
    315315 
    316316.. 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] 
    327                                 Q: float[nTime,100] 
    328                                 Time: float[nTime] 
     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] 
     327        Q: float[nTime,100] 
     328        Time: float[nTime] 
    329329 
    330330 
     
    337337 
    338338.. code-block:: text 
    339         :linenos: 
    340          
    341         SASroot 
    342                 SASentry 
    343                         SASdata 
    344                                 @Q_indices=1 
    345                                 @I_axes="Time,Q" 
    346                                 I: float[nTime,100*512] 
    347                                 Qx: float[100*512] 
    348                                 Qy: float[100*512] 
    349                                 Qz: float[100*512] 
    350                                 Time: float[nTime] 
     339  :linenos: 
     340   
     341  SASroot 
     342    SASentry 
     343      SASdata 
     344        @Q_indices=1 
     345        @I_axes="Time,Q" 
     346        I: float[nTime,100*512] 
     347        Qx: float[100*512] 
     348        Qy: float[100*512] 
     349        Qz: float[100*512] 
     350        Time: float[nTime] 
    351351 
    352352.. _2-D I(t,Q(t)): 
     
    358358 
    359359.. code-block:: text 
    360         :linenos: 
    361          
    362         SASroot 
    363                 SASentry 
    364                         SASdata 
    365                                 @Q_indices=0,1 
    366                                 @I_axes="Time,Q" 
    367                                 I: float[nTime,100*512] 
    368                                 Qx: float[nTime,100*512] 
    369                                 Qy: float[nTime,100*512] 
    370                                 Qz: float[nTime,100*512] 
    371                                 Time: float[nTime] 
     360  :linenos: 
     361   
     362  SASroot 
     363    SASentry 
     364      SASdata 
     365        @Q_indices=0,1 
     366        @I_axes="Time,Q" 
     367        I: float[nTime,100*512] 
     368        Qx: float[nTime,100*512] 
     369        Qy: float[nTime,100*512] 
     370        Qz: float[nTime,100*512] 
     371        Time: float[nTime] 
    372372 
    373373.. _2-D.time-dependent.masked.image: 
     
    379379 
    380380.. code-block:: text 
    381         :linenos: 
    382          
    383         SASroot 
    384                 SASentry 
    385                         SASdata 
    386                                 @Q_indices=0,1,2 
    387                                 @I_axes="Time,Q,Q" 
    388                                 @Mask_indices=1,2 
    389                                 I: float[nTime,100,512] 
    390                                 Qx: float[nTime,100,512] 
    391                                 Qy: float[nTime,100,512] 
    392                                 Qz: float[nTime,100,512] 
    393                                 Time: float[nTime] 
    394                                 Mask: int[100,512] 
     381  :linenos: 
     382   
     383  SASroot 
     384    SASentry 
     385      SASdata 
     386        @Q_indices=0,1,2 
     387        @I_axes="Time,Q,Q" 
     388        @Mask_indices=1,2 
     389        I: float[nTime,100,512] 
     390        Qx: float[nTime,100,512] 
     391        Qy: float[nTime,100,512] 
     392        Qz: float[nTime,100,512] 
     393        Time: float[nTime] 
     394        Mask: int[100,512] 
    395395 
    396396 
     
    407407Examples:   
    408408:download:`HDF5 <../../examples/hdf5/generic2dtimetpseries.h5>` 
    409 :download:`XML <../../examples/xml/generic2dtimetpseries.xml>`   
    410  
    411 .. code-block:: text 
    412         :linenos: 
    413                  
    414         SASroot 
    415                 SASentry 
    416                         SASdata 
    417                                 @Q_indices=0,1,2,3 
    418                                 @I_axes="Time,Temperature,Pressure,Q" 
    419                                 I: float[nTime,nTemperature,nPressure,100*512] 
    420                                 Qx: float[nTime,nTemperature,nPressure,100*512] 
    421                                 Qy: float[nTime,nTemperature,nPressure,100*512] 
    422                                 Qz: float[nTime,nTemperature,nPressure,100*512] 
    423                                 Time: float[nTime] 
    424                                 T: float[nTemperature] 
    425                                 P: float[nPressure] 
     409:download:`XML <../../examples/xml/generic2dtimetpseries.xml>`    
     410 
     411.. code-block:: text 
     412  :linenos: 
     413     
     414  SASroot 
     415    SASentry 
     416      SASdata 
     417        @Q_indices=0,1,2,3 
     418        @I_axes="Time,Temperature,Pressure,Q" 
     419        I: float[nTime,nTemperature,nPressure,100*512] 
     420        Qx: float[nTime,nTemperature,nPressure,100*512] 
     421        Qy: float[nTime,nTemperature,nPressure,100*512] 
     422        Qz: float[nTime,nTemperature,nPressure,100*512] 
     423        Time: float[nTime] 
     424        T: float[nTemperature] 
     425        P: float[nPressure] 
    426426 
    427427.. _2-D.images.with.varied.T.t.P: 
     
    434434 
    435435.. code-block:: text 
    436         :linenos: 
    437          
    438         SASroot 
    439                 SASentry 
    440                         SASdata 
    441                                 @Q_indices=1,3,4 
    442                                 @I_axes="Temperature,Time,Pressure,Q,Q" 
    443                                 I: float[nTemperature,nTime,nPressure,100,512] 
    444                                 Qx: float[nTime,100,512] 
    445                                 Qy: float[nTime,100,512] 
    446                                 Qz: float[nTime,100,512] 
    447                                 Time: float[nTime] 
    448                                 Temperature: float[nTemperature] 
    449                                 Pressure: float[nPressure] 
    450  
     436  :linenos: 
     437   
     438  SASroot 
     439    SASentry 
     440      SASdata 
     441        @Q_indices=1,3,4 
     442        @I_axes="Temperature,Time,Pressure,Q,Q" 
     443        I: float[nTemperature,nTime,nPressure,100,512] 
     444        Qx: float[nTime,100,512] 
     445        Qy: float[nTime,100,512] 
     446        Qz: float[nTime,100,512] 
     447        Time: float[nTime] 
     448        Temperature: float[nTemperature] 
     449        Pressure: float[nPressure] 
     450 
     451 
     452Complicated Uncertainties 
     453============================= 
     454 
     455The uncertainties might be derived from several factors, or there may even be 
     456several uncertainties contributing.  In practical terms, these are special  
     457cases for analysis software.  In the interest of completeness, it is  
     458interesting to describe how they might be represented. 
    451459 
    452460.. _representing uncertainty components: 
     
    467475 
    468476.. 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  
    492 Expression of Multiple Uncertainties (*proposed*) 
     477  :linenos: 
     478 
     479  SASroot 
     480    SASentry 
     481      SASdata 
     482        @Q_indices=0 
     483        @I_axes=Q 
     484        Q : float[nI] 
     485        I : float[nI] 
     486           @uncertainty=Idev 
     487        Idev : float[nI] 
     488           @components=I_uncertainties 
     489        I_uncertainties: 
     490           electronic : float[nI] 
     491              @basis="Johnson noise" 
     492           counting_statistics: float[nI] 
     493              @basis="shot noise" 
     494           secondary_standard: float[nI] 
     495              @basis="esd" 
     496 
     497 
     498.. _representing multiple uncertainties ... proposed: 
     499 
     500Representing Multiple Uncertainties (*proposed*) 
    493501---------------------------------------------------- 
    494502 
     
    504512 
    505513.. 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] 
     514  :linenos: 
     515 
     516  SASroot 
     517    SASentry 
     518      SASdata 
     519        @Q_indices=0 
     520        @I_axes=Q 
     521        Q : float[nI] 
     522        I : float[nI] 
     523          @uncertainty=Idev,Ierr 
     524        Idev : float[nI] 
     525        Ierr : float[nI] 
    518526 
    519527 
     
    534542 
    535543.. code-block:: text 
    536         :linenos: 
    537                  
    538         SASroot 
    539                 SASentry 
    540                         SASdata 
    541                                 @Q_indices="*,*" 
    542                                 @I_axes=" ??? " 
    543                                 I: float[100, 512] 
    544                                 Qx: float[100] 
    545                                 Qy: float[512] 
     544  :linenos: 
     545     
     546  SASroot 
     547    SASentry 
     548      SASdata 
     549        @Q_indices="*,*" 
     550        @I_axes=" ??? " 
     551        I: float[100, 512] 
     552        Qx: float[100] 
     553        Qy: float[512] 
    546554 
    547555Instead, use either the model titled:  
Note: See TracChangeset for help on using the changeset viewer.