cansas1d SASdata: Difference between revisions

From canSAS
(New page: <gallery caption="block diagrams"> Image:cansas1d-v1-2-SASdata.png </gallery> {| {{Tablestyle}} |- ! {{Headcellstyle}} | Name ! {{Headcellstyle}} | Type ! {{Headcellstyle}} | occurrence !...)
 
(Note the 3 types of intensity that may be used)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<gallery caption="block diagrams">
<gallery>
Image:cansas1d-v1-2-SASdata.png
Image:cansas1d-v1-2-SASdata.png | block diagram
Image:Q-geometry.jpg | Q geometry
</gallery>
</gallery>
* parent: [[cansas1d_SASentry | SASentry]]
== SASdata ==


{| {{Tablestyle}}
{| {{Tablestyle}}
Line 11: Line 17:
! {{Headcellstyle}} | Attributes
! {{Headcellstyle}} | Attributes
|-
|-
|| [[cansas1d_Idata | '''Idata''']]
|| [[#Idata | '''Idata''']]
|| container
|| container
| align="center" | [0..unbounded]
| align="center" | [1..unbounded]
|| Idata describes a single SAS data point.
|| Idata describes a single SAS data point.
||  
||  
|-
|-
|}
|}
== Idata ==
{| {{Tablestyle}}
|-
! {{Headcellstyle}} | Name
! {{Headcellstyle}} | Type
! {{Headcellstyle}} | occurrence
! {{Headcellstyle}} | Description
! {{Headcellstyle}} | Attributes
|-
|| '''Q'''
|| floating-point number
| align="center" | [1..1]
|| ''Q=(4 &pi; / &lambda;) sin(&theta;)'' where ''&lambda;'' is the wavelength of the radiation and ''2&theta;'' is the angle through which the detected radiation has been scattered. 
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  Either ''1/A'' or ''1/nm'' are typical.
|| '''unit'''="{units}"
|-
|| '''I'''
|| floating-point number
| align="center" | [1..1]
|| Intensity of the detected radiation.
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  One possibility might be''1/cm'' for absolute units when the intensity describes a ''differential cross-section per unit volume per unit solid angle''. <br />
'''NOTE''': Be aware that there are different types of intensity that may be reported (see [[Talk:cansas1d_documentation#The_Intensity_Problem]]) and one should be very careful to inspect the '''unit''' attribute to determine how to handle subsequent data processing, especially in the area of units conversion.
|| '''unit'''="{units}"
|-
|| '''''Idev'''''
|| floating-point number
| align="center" | [0..1]
|| Estimated standard deviation of '''I'''.
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  One possibility might be''1/cm''.
|| '''unit'''="{units}"
|-
|| '''''Qdev'''''
|| floating-point number
| align="center" | [0..1]
|| Estimated standard deviation of '''Q'''. (optional: see note below on usage)
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  Either ''1/A'' or ''1/nm'' are typical.
|| '''unit'''="{units}"
|-
|| '''''dQw'''''
|| floating-point number
| align="center" | [0..1]
|| '''Q''' resolution along the axis of scanning (the high-resolution ''slit width'' direction).  Useful for defining resolution data from slit-smearing instruments such as Bonse-Hart geometry.  (optional: see note below on usage)
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  Either ''1/A'' or ''1/nm'' are typical.
|| '''unit'''="{units}"
|-
|| '''''dQl'''''
|| floating-point number
| align="center" | [0..1]
|| '''Q''' resolution perpendicular to the axis of scanning (the low-resolution ''slit length'' direction).  Useful for defining resolution data from slit-smearing instruments such as Bonse-Hart geometry.  (optional: see note below on usage)
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  Either ''1/A'' or ''1/nm'' are typical.
|| '''unit'''="{units}"
|-
|| '''''Qmean'''''
|| floating-point number
| align="center" | [0..1]
|| Mean value of '''Q''' for this datum.  Useful when describing data that has been binned from higher-resolution or from area detectors.
The '''unit''' attribute is required.  See [[cansas1d_documentation#Rules]] for acceptable values.  Either ''1/A'' or ''1/nm'' are typical.
|| '''unit'''="{units}"
|-
|| '''''Shadowfactor'''''
|| floating-point number
| align="center" | [0..1]
|| Describes the adjustment due to the beam stop penumbra.
'''(This definition needs revision. NIST?)'''
NOTE: There is no "unit" attribute.
||
|-
|| [[cansas1d_any | '''''{any}''''']]
|| container
| align="center" | [0..unbounded]
|| Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point.  See [[cansas1d_any | ''{any}'']] for more details.
|| '''''xmlns:{foreign-prefix}'''''="{foreign-namespace}"
|-
|}
== Notes ==
# When an optional element ('''''Idev''''', '''''Qdev''''', ...) is used, it must be given in every [[cansas1d_Idata | '''Idata''']] within the enclosing [[cansas1d_SASdata | '''SASdata''']].
# If either '''''dQw''''' or '''''dQl''''' are used, then '''''Qdev''''' is not permitted to be used.

Latest revision as of 00:59, 15 November 2008


SASdata

Name Type occurrence Description Attributes
Idata container [1..unbounded] Idata describes a single SAS data point.

Idata

Name Type occurrence Description Attributes
Q floating-point number [1..1] Q=(4 π / λ) sin(θ) where λ is the wavelength of the radiation and is the angle through which the detected radiation has been scattered.

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. Either 1/A or 1/nm are typical.

unit="{units}"
I floating-point number [1..1] Intensity of the detected radiation.

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. One possibility might be1/cm for absolute units when the intensity describes a differential cross-section per unit volume per unit solid angle.
NOTE: Be aware that there are different types of intensity that may be reported (see Talk:cansas1d_documentation#The_Intensity_Problem) and one should be very careful to inspect the unit attribute to determine how to handle subsequent data processing, especially in the area of units conversion.

unit="{units}"
Idev floating-point number [0..1] Estimated standard deviation of I.

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. One possibility might be1/cm.

unit="{units}"
Qdev floating-point number [0..1] Estimated standard deviation of Q. (optional: see note below on usage)

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. Either 1/A or 1/nm are typical.

unit="{units}"
dQw floating-point number [0..1] Q resolution along the axis of scanning (the high-resolution slit width direction). Useful for defining resolution data from slit-smearing instruments such as Bonse-Hart geometry. (optional: see note below on usage)

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. Either 1/A or 1/nm are typical.

unit="{units}"
dQl floating-point number [0..1] Q resolution perpendicular to the axis of scanning (the low-resolution slit length direction). Useful for defining resolution data from slit-smearing instruments such as Bonse-Hart geometry. (optional: see note below on usage)

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. Either 1/A or 1/nm are typical.

unit="{units}"
Qmean floating-point number [0..1] Mean value of Q for this datum. Useful when describing data that has been binned from higher-resolution or from area detectors.

The unit attribute is required. See cansas1d_documentation#Rules for acceptable values. Either 1/A or 1/nm are typical.

unit="{units}"
Shadowfactor floating-point number [0..1] Describes the adjustment due to the beam stop penumbra.

(This definition needs revision. NIST?) NOTE: There is no "unit" attribute.

{any} container [0..unbounded] Any element(s) not defined in the cansas1d/1.0 standard can be placed at this point. See {any} for more details. xmlns:{foreign-prefix}="{foreign-namespace}"

Notes

  1. When an optional element (Idev, Qdev, ...) is used, it must be given in every Idata within the enclosing SASdata.
  2. If either dQw or dQl are used, then Qdev is not permitted to be used.