cansas1d documentation: Difference between revisions

From canSAS
No edit summary
Line 28: Line 28:
==Definition of terms==
==Definition of terms==


Should this list be
;term:quantity <br> description
* in the required order of the XML tags?
;<tt>aperture</tt>: [0..inf] <br> describes an aperture position, size, and shape
* in alphabetical order?
;<tt>beam_center</tt>: [..] <br>  
 
;<tt>beam_shape</tt>: [..] <br>  
<!-- width="100%" border = "1"
;<tt>beam_size</tt>: [..] <br>  
! width="50%" | inconsistent
;<tt>date</tt>: [..] <br>  
! width="50%" | consistent
;<tt>description</tt>: [..] <br>  
-->
;<tt>details</tt>: [..] <br>  
 
;<tt>distance</tt>: [..] <br>  
{|  border="1" style="border:1px solid navy; border-collapse: collapse"
;<tt>I</tt>: [..] <br>  
|-
;<tt>ID</tt>: [..] <br>  
| term
;<tt>Idata</tt>: [..] <br>  
| qty
;<tt>Idev</tt>: [..] <br>  
| description
;<tt>name</tt>: [..] <br>  
|-
;<tt>offset</tt>: [..] <br>  
| <tt>aperture</tt>
;<tt>pitch</tt>: [..] <br>  
|
;<tt>pixel_size</tt>: [..] <br>  
|
;<tt>Q</tt>: [..] <br>  
|-
;<tt>Qdev</tt>: [..] <br>  
| <tt>beam_center</tt>
;<tt>Qfwhm</tt>: [..] <br>  
|
;<tt>Qmean</tt>: [..] <br>  
|
;<tt>radiation</tt>: [..] <br>  
|-
;<tt>roll</tt>: [..] <br>  
| <tt>beam_size</tt>
;<tt>rotation</tt>: [..] <br>  
|
;<tt>Run</tt>: [..] <br>  
|
;<tt>SAScollimation</tt>: [..] <br>  
|-
;<tt>SASdetector</tt>: [..] <br>  
| <tt>beam_shape</tt>
;<tt>SASentry</tt>: [1..inf] <br> Describes a single 1-D SAS data scan.  <br> Time-resolved experiments or others with series data should put each step in the series into its own SASentry.
|
;<tt>SASinstrument</tt>: [1..1] <br> describes the SAS instrument used to provide this SASentry
|
;<tt>SASnote</tt>: [0..inf] <br> allows for other information to be added to a SASentry
|-
;<tt>SASprocess</tt>: [0..inf] <br> describes a data processing or analysis step
| <tt>date</tt>
;<tt>SASprocessnote</tt>: [..] <br>  
|
;<tt>SASroot</tt>: [1..1] <br> (required) root node of the canSAS 1-D reduced SAS data file in XML
|
;<tt>SASsample</tt>: [1..1] <br> describes the sample
|-
;<tt>SASsource</tt>: [..] <br>  
| <tt>description</tt>
;<tt>SDD</tt>: [..] <br>  
|
;<tt>Shadowfactor</tt>: [..] <br>  
|
;<tt>size</tt>: [..] <br>  
|-
;<tt>temperature</tt>: [..] <br>  
| <tt>details</tt>
;<tt>term</tt>: [..] <br>  
|
;<tt>thickness</tt>: [..] <br>  
|
;<tt>Title</tt>: [..] <br>  
|-
;<tt>transmission</tt>: [..] <br>  
| <tt>distance</tt>
;<tt>wavelength_max</tt>: [..] <br>  
|
;<tt>wavelength_min</tt>: [..] <br>  
|
;<tt>wavelength_spread</tt>: [..] <br>  
|-
;<tt>wavelength</tt>: [..] <br>  
| <tt>I</tt>
;<tt>x</tt>: [..] <br>  
|
;<tt>y</tt>: [..] <br>  
|
;<tt>yaw</tt>: [..] <br>  
|-
;<tt>z</tt>: [..] <br>
| <tt>Idev</tt>
|
|
|-
| <tt>ID</tt>
|
|
|-
| <tt>Idata</tt>
|
|
|-
| <tt>name</tt>
|
|
|-
| <tt>offset</tt>
|
|
|-
| <tt>pitch</tt>
|
|
|-
| <tt>pixel_size</tt>
|
|
|-
| <tt>Q</tt>
|
|
|-
| <tt>Qdev</tt>
|
|
|-
| <tt>Qfwhm</tt>
|
|
|-
| <tt>Qmean</tt>
|
|
|-
| <tt>radiation</tt>
|
|
|-
| <tt>roll</tt>
|
|
|-
| <tt>rotation</tt>
|
|
|-
| <tt>Run</tt>
|
|
|-
| <tt>SAScollimation</tt>
|
|
|-
| <tt>SASdetector</tt>
|
|
|-
| <tt>SASentry</tt>
| 1..inf
| describes a single 1-D SAS data scan.  <br> Time-resolved experiments or others with series data should put each step in the series into its own SASentry.
|-
| <tt>SASinstrument</tt>
| 1
| describes the SAS instrument
|-
| <tt>SASnote</tt>
| 0..inf
| allows for other information to be added to a SASentry
|-
| <tt>SASprocess</tt>
| 1
| describes a data processing or analysis step
|-
| <tt>SASprocessnote</tt>
|
|
|-
| <tt>SASroot</tt>
| 1
| (required) root node of the canSAS 1-D reduced SAS data file in XML
|-
| <tt>SASsample</tt>
| 1
| describes the sample
|-
| <tt>SASsource</tt>
|
|
|-
| <tt>SDD</tt>
|
|
|-
| <tt>Shadowfactor</tt>
|
|
|-
| <tt>size</tt>
|
|
|-
| <tt>Title</tt>
|
|
|-
| <tt>temperature</tt>
|
|
|-
| <tt>term</tt>
|
|
|-
| <tt>thickness</tt>
|
|
|-
| <tt>transmission</tt>
|
|
|-
| <tt>wavelength</tt>
|
|
|-
| <tt>wavelength_max</tt>
|
|
|-
| <tt>wavelength_min</tt>
|
|
|-
| <tt>wavelength_spread</tt>
|
|
|-
| <tt>x</tt>
|
|
|-
| <tt>y</tt>
|
|
|-
| <tt>yaw</tt>
|
|
|-
| <tt>z</tt>
|
|
|}


==attributes==
==attributes==

Revision as of 05:31, 21 December 2007

Disclaimer

This description is meant to inform the community how to layout the information within the XML files. However, should the information in this document and the canSAS 1D SAS XML Schema differ, the XML Schema will be deemed to have the most correct description of the standard.

General Layout of the XML Data

  • SASroot
    • SASentry
      • Title
      • Run
      • SASdata
      • SASsample
      • SASinstrument
      • SASprocess
      • SASprocess
      • SASprocess...
      • SASnote
      • SASnote
      • SASnote...
    • SASentry
    • SASentry
    • SASentry ...

Definition of terms

term
quantity
description
aperture
[0..inf]
describes an aperture position, size, and shape
beam_center
[..]
beam_shape
[..]
beam_size
[..]
date
[..]
description
[..]
details
[..]
distance
[..]
I
[..]
ID
[..]
Idata
[..]
Idev
[..]
name
[..]
offset
[..]
pitch
[..]
pixel_size
[..]
Q
[..]
Qdev
[..]
Qfwhm
[..]
Qmean
[..]
radiation
[..]
roll
[..]
rotation
[..]
Run
[..]
SAScollimation
[..]
SASdetector
[..]
SASentry
[1..inf]
Describes a single 1-D SAS data scan.
Time-resolved experiments or others with series data should put each step in the series into its own SASentry.
SASinstrument
[1..1]
describes the SAS instrument used to provide this SASentry
SASnote
[0..inf]
allows for other information to be added to a SASentry
SASprocess
[0..inf]
describes a data processing or analysis step
SASprocessnote
[..]
SASroot
[1..1]
(required) root node of the canSAS 1-D reduced SAS data file in XML
SASsample
[1..1]
describes the sample
SASsource
[..]
SDD
[..]
Shadowfactor
[..]
size
[..]
temperature
[..]
term
[..]
thickness
[..]
Title
[..]
transmission
[..]
wavelength_max
[..]
wavelength_min
[..]
wavelength_spread
[..]
wavelength
[..]
x
[..]
y
[..]
yaw
[..]
z
[..]

attributes

Retrieved from "https://wiki.cansas.org/index.php?title=cansas1d_documentation&oldid=138"