source: 1dwg/branches/v1.1/doc/source/element_SASsample.rst @ 284

Last change on this file since 284 was 284, checked in by prjemian, 6 years ago

simplify to just one XSLT, rename, and revise XML files accordingly, update the docs (and call the format "cansas1d:1.1" now)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision URL
File size: 4.6 KB

SASsample

?
.. index:: ! element; SASsample
parent:

:ref:`SASentry`

?
../../graphics/3-SASsample.png

The SASsample element

?
.. index::
        element; ID
        element; thickness
        element; transmission
        element; temperature
        element; position
        element; orientation
        element; details
        element; {any}
Name Type Occurrence Description Attributes
ID string [1..1] Text string that identifies this sample.  
thickness float [0..1] Thickness of this sample. unit={unit} [1]
transmission float [0..1] Transmission (I ⁄ I0 ) of this sample. Note that there is no unit attribute as this number is dimensionless.  
temperature float [0..1] Temperature of this sample. unit={unit} [1]

:ref:`samp.pos`

?
container [0..1] Location of the sample in X, Y, and Z.  

:ref:`samp.orient`

?
container [0..1] Orientation (rotation) of the sample.  
details string [0..inf] Any additional sample details.  

:ref:`{any}`

?
container [0..inf] Any element(s) not defined in the cansas1d:1.1 standard can be placed at this point. xmlns:{foreign-prefix}={foreign-namespace}

geometry

See the figures in :ref:`axes definition`.

??
.. index:: ! element; position

position

Name Type Occurrence Description Attributes
x float [0..1] Position of the sample in X. unit={unit} [1]
y float [0..1] Position of the sample in Y. unit={unit} [1]
z float [0..1] Position of the sample in Z. unit={unit} [1] [2]
?
.. index:: ! element; orientation

orientation

Note

The orientation element is intended to describe simple rotations about a single axis rather than a full set of rotations as in a crystallographic context.

?
.. index::
        element; roll
        element; pitch
        element; yaw
Name Type Occurrence Description Attributes
roll float [0..1] Rotation about the Z axis (roll). unit={unit} [1]
pitch float [0..1] Rotation about the X axis (pitch). unit={unit} [1]
yaw float [0..1] Rotation about the Y axis (yaw). unit={unit} [1]

Table Notes

[1](1, 2, 3, 4, 5, 6, 7, 8)

The unit attribute is required. See :ref:`rules` for acceptable values.

?
[2]While z is allowed by the standard (provided by use of a standard size element in the XML Schema), it does not make sense to use it for small-angle scattering in some situations as noted. Use of z in such situations may be ignored by processing software.
Note: See TracBrowser for help on using the repository browser.