cansas1d documentation: Difference between revisions

From canSAS
(standard header)
(point at tagged version)
 
(88 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Disclaimer==
This manual has been superseded (replaced) by a PDF:


This description is meant to inform the community how to layout
http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0/doc/cansas-1d-1_0-manual.pdf?format=raw
the information within the XML files.  However, should the
information in this document and the [[cansas1d.xsd | 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==
 
===required XML file header===
<pre>
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="example.xsl" ?>
<SASroot version="1.0"
xmlns="http://www.smallangles.net/cansas1d"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.smallangles.net/cansas1d/ http://www.smallangles.net/cansas1d/1.0/cansas1d.xsd"
>
</pre>
 
===alternative XML file header (referencing a stylesheet)===
<pre>
<?xml version="1.0"?>
<?xml-stylesheet type="text/xsl" href="example.xsl" ?>
<SASroot version="1.0">
</pre>
 
===overall file: layout of SASroot===
*SASroot
**SASentry
**SASentry
**SASentry ... (for each data set, time-slice, step in a series, new sample, etc.)
 
===each data set: layout of the SASentry===
 
*SASentry
**Title
**Run
**SASdata (this is where the reduced 1-D SAS data is stored)
**SASsample
**SASinstrument
**SASprocess
**SASprocess
**SASprocess... (for each processing or analysis step)
**SASnote
**SASnote
**SASnote... (anything at all)
 
==Definition of terms==
 
Note:
* Each term (element or attribute) is listed by its [http://www.w3schools.com/xpath/  XPath] in the XML file.
* Elements are shown below sorted by their XPath.  In the XML file, the order of elements is defined by the XML Schema.  An example is given in the file: [[cansas1d_template.xml]]
* Each term in the standard is shown with a comment embedded.
* The comment indicates
** the name of the element,
** how many times the element can be used,
*** [0..1] : element is optional but can only appear once within enclosing element
*** [1..1] : element is required and can only appear once within enclosing element
*** [1..inf] : element is required but can appear as many times as needed within enclosing element
*** [0..inf] : element is optional and can appear as many times as needed within enclosing element
*** [] : element is optional, number of appearances within enclosing element is not specified
** and a short description.
* When shown in the template below with the "/@unit" XPath, the "unit" attribute is required.
 
 
;<TT>/SASroot </TT>: [1..1] The canSAS reduced 1-D SAS data will be in the SASroot database. This is similar to NXroot used by NeXus. <br />
;<TT>/SASroot/@version </TT>: [1..1] version="1.0" Required attribute to indicate the version of the standard to which this XML document is encoded. <br />
;<TT>/SASroot/SASentry </TT>: [1..] A single SAS scan is reported in a SASentry. A SASentry can use the optional "name" attribute to provide a string for this SASentry. Use of this string is not defined by this standard. <br />
;<TT>/SASroot/SASentry/@name </TT>: [0..1] Optional string attribute to identify this particular SASentry. <br />
;<TT>/SASroot/SASentry/Run </TT>: [1..inf] Run identification for this SASentry. For many facilities, this is an integer. Use multiple instances of Run as needed. Note: How to correlate this with SASinstrument configurations has not yet been defined. <br />
;<TT>/SASroot/SASentry/SASdata </TT>: [1..inf] Reduced 1-D SAS data for this SASentry. Use multiple SASdata elements to represent multiple frames. <br />
;<TT>/SASroot/SASentry/SASdata/@name </TT>: [0..1] Optional string attribute to identify this particular SASdata. <br />
;<TT>/SASroot/SASentry/SASdata/Idata </TT>: [1..inf] Idata describes a single SAS data point. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/I </TT>: [1..1] Intensity of the detected radiation. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/I/@unit </TT>: [1..1] Required unit for I. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Idev </TT>: [1..1] Estimated standard deviation of I. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Idev/@unit </TT>: [1..1] Required unit for Idev. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Q </TT>: [1..1] Q = (4 pi / lambda) sin(theta) where lambda is the wavelength of the radiation and 2theta is the angle through which the detected radiation has been scattered. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Q/@unit </TT>: [1..1] Required unit for Q. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qdev </TT>: [0..1] Estimated standard deviation of Q. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qdev/@unit </TT>: [1..1] Required unit for Qdev. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qfwhm </TT>: [0..1] Q resolution of this datum, defined as full-width in Q at half-maximum intensity. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qfwhm/@unit </TT>: [1..1] Required unit for Qfwhm. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qmean </TT>: [0..1] Mean value of Q for this datum. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Qmean/@unit </TT>: [1..1] Required unit for Qmean. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASdata/Idata/Shadowfactor </TT>: [0..1] Describes the adjustment due to the beam stop penumbra. (This definition needs revision. NIST?) NOTE: There is no "unit" attribute. <br />
;<TT>/SASroot/SASentry/SASinstrument </TT>: [1..1] Description of the instrument. <br />
;<TT>/SASroot/SASentry/SASinstrument/name </TT>: [1..1] Name of the instrument. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation </TT>: [] Description of the instrument collimation. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/@name </TT>: [0..1] Optional text to describe this collimation element. (This is redundant with, but not the same as, /SASroot/SASentry/SASinstrument/SAScollimation/name and should be removed.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture </TT>: [0..inf] Slit or aperture. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/@name </TT>: [0..1] Optional name for this aperture. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/@type </TT>: [1..1] Optional text to describe the type aperture (pinhole, 4-blade slit, Soller slit, ...). <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/distance </TT>: [0..1] Is this necessary? What is the difference between /SASroot/SASentry/SASinstrument/SAScollimation/distance and /SASroot/SASentry/SASinstrument/SAScollimation/aperture/distance? <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/distance/@unit </TT>: [1..1] distance requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size </TT>: [0..1] Opening dimensions of this aperture. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/@name </TT>: [1..1] Optional attribute to clarify the name of this beam size. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/x </TT>: [0..1] Dimension of the aperture in X. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/y </TT>: [0..1] Dimension of the aperture in Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/z </TT>: [0..1] Dimension of the aperture in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/aperture/size/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/distance </TT>: [0..1] Distance from this collimation element to the sample. <br />
;<TT>/SASroot/SASentry/SASinstrument/SAScollimation/distance/@unit </TT>: [1..1] distance requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector </TT>: [1..inf] Description of a single or composite detector. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center </TT>: [0..1] Center of the beam on the detector in X and Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/@name </TT>: Optional attribute to clarify the name of this detector beam center. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/x </TT>: [0..1] Center of the beam on the detector in X. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/y </TT>: [0..1] Center of the beam on the detector in Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/z </TT>: [0..1] Center of the beam on the detector in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/beam_center/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/name </TT>: [1..1] Name of the detector. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset </TT>: [0..1] Offset of the detector position in X, Y, and Z. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/@name </TT>: Optional attribute to clarify the name of this beam size. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/x </TT>: [0..1] Offset of the detector position in X. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/y </TT>: [0..1] Offset of the detector position in Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/z </TT>: [0..1] Offset of the detector position in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/offset/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation </TT>: [0..1] Orientation (rotation) of the detector in roll, pitch, and yaw. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/@name </TT>: Optional attribute to name this orientation. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/pitch </TT>: [0..1] Optional rotation of the detector about the X axis (pitch). <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/pitch/@unit </TT>: [1..1] Required unit for the dimension of pitch. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/roll </TT>: [0..1] Optional rotation of the detector about the Z axis (roll). <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/roll/@unit </TT>: [1..1] Required unit for the dimension of roll. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/yaw </TT>: [0..1] Optional rotation of the detector about the Y axis (yaw). <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/orientation/yaw/@unit </TT>: [1..1] Required unit for the dimension of yaw. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size </TT>: [0..1] Size of detector pixels in X and Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/@name </TT>: Optional attribute to clarify the name of this detector pixel size. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/x </TT>: [0..1] Size of detector pixels in X. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/y </TT>: [0..1] Size of detector pixels in Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/z </TT>: [0..1] Size of detector pixels in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/pixel_size/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/SDD </TT>: [0..1] Distance between sample and detector. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/SDD/@unit </TT>: [1..1] Required unit for SDD. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/slit_length </TT>: [0..1] Slit length of the instrument for this detector. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASdetector/slit_length/@unit </TT>: [1..1] Required unit for the slit length. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource </TT>: [] Description of the source of the radiation. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/@name </TT>: [0..1] Optional text description of the source of the radiation (incident on the sample). This can be different from /SASroot/SASentry/SASinstrument/SASsource/radiation. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_shape </TT>: [0..1] Text description of the shape of the beam (incident on the sample). <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size </TT>: [0..1] Physical dimension of the beam (incident on the sample). Note: If beam is round, just use X dimension. Note: While Z dimension is allowed by the standard, it does not make sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/@name </TT>: Optional attribute to clarify the name of this beam size. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/x </TT>: [0..1] Dimension of the beam size in X. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/y </TT>: [0..1] Dimension of the beam size in Y. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/z </TT>: [0..1] Dimension of the beam size in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/beam_size/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/radiation </TT>: [1..1] Name of the radiation used (neutron, X-ray, synchrotron X-ray, Cu Ka X-ray tube, ..." <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength </TT>: [0..1] wavelength of radiation incident on the sample. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength/@unit </TT>: [1..1] wavelength of radiation requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_max </TT>: [0..1] Some facilities specify wavelength using a range. The maximum of such a range is given by wavelength_max. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_max/@unit </TT>: [1..1] wavelength_max requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_min </TT>: [0..1] Some facilities specify wavelength using a range. The minimum of such a range is given by wavelength_min. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_min/@unit </TT>: [1..1] wavelength_min requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_spread </TT>: [0..1] Some facilities specify the width of the wavelength spectrum. The minimum of such a range is given by wavelength_spread. <br />
;<TT>/SASroot/SASentry/SASinstrument/SASsource/wavelength_spread/@unit </TT>: [1..1] wavelength_spread requires a unit to be specified. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASnote </TT>: [1..] Free form description of anything not covered by other elements. <br />
;<TT>/SASroot/SASentry/SASprocess </TT>: [0..inf] Description of a processing or analysis step. <br />
;<TT>/SASroot/SASentry/SASprocess/@name </TT>: [0..1] Optional attribute to provide a name for this SASprocess. It is redundant with /SASroot/SASentry/SASprocess/name but it is not the same. It should probably be removed. <br />
;<TT>/SASroot/SASentry/SASprocess/date </TT>: [0..1] Optional date for this data processing or analysis step. *** SHOULD WE SPECIFY THE FORMAT FOR THE DATE? *** <br />
;<TT>/SASroot/SASentry/SASprocess/description </TT>: [0..1] Optional description for this data processing or analysis step. <br />
;<TT>/SASroot/SASentry/SASprocess/name </TT>: [0..1] Optional name for this data processing or analysis step. <br />
;<TT>/SASroot/SASentry/SASprocess/SASprocessnote </TT>: [1..inf] This element is used to describe anything about SASprocess that is not already described. <br />
;<TT>/SASroot/SASentry/SASprocess/term </TT>: [0..1] This is used to specify the value of a single variable, parameter, or term related to the SASprocess step. <br />
;<TT>/SASroot/SASentry/SASprocess/term/@name </TT>: [1..1] Name of the term. <br />
;<TT>/SASroot/SASentry/SASprocess/term/@unit </TT>: [1..1] Unit (string) of the term. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample </TT>: [] Description of the sample. <br />
;<TT>/SASroot/SASentry/SASsample/@name </TT>: [0..1] Optional attribute to name this sample. (Should be the same as SASsample/ID) <br />
;<TT>/SASroot/SASentry/SASsample/details </TT>: [0..inf] Text string to supply additional sample details. <br />
;<TT>/SASroot/SASentry/SASsample/ID </TT>: [1..1] Text string that identifies this sample. <br />
;<TT>/SASroot/SASentry/SASsample/orientation </TT>: [0..1] Orientation (rotation) of the sample. <br />
;<TT>/SASroot/SASentry/SASsample/orientation/@name </TT>: Optional attribute to name this orientation. <br />
;<TT>/SASroot/SASentry/SASsample/orientation/pitch </TT>: [0..1] Optional rotation of the sample about the X axis (pitch). <br />
;<TT>/SASroot/SASentry/SASsample/orientation/pitch/@unit </TT>: [1..1] Required unit for the dimension of pitch. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/orientation/roll </TT>: [0..1] Optional rotation of the sample about the Z axis (roll). <br />
;<TT>/SASroot/SASentry/SASsample/orientation/roll/@unit </TT>: [1..1] Required unit for the dimension of roll. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/orientation/yaw </TT>: [0..1] Optional rotation of the sample about the Y axis (yaw). <br />
;<TT>/SASroot/SASentry/SASsample/orientation/yaw/@unit </TT>: [1..1] Required unit for the dimension of yaw. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/position </TT>: [0..1] Location in X, Y, and Z of the sample. Must specify the unit as an attribute to each position. <br />
;<TT>/SASroot/SASentry/SASsample/position/@name </TT>: Optional attribute to name this position. <br />
;<TT>/SASroot/SASentry/SASsample/position/x </TT>: [0..1] Location of the sample in X. <br />
;<TT>/SASroot/SASentry/SASsample/position/x/@unit </TT>: [1..1] Required unit for the dimension of x. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/position/y </TT>: [0..1] Location of the sample in Y. <br />
;<TT>/SASroot/SASentry/SASsample/position/y/@unit </TT>: [1..1] Required unit for the dimension of y. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/position/z </TT>: [0..1] Location of the sample in Z. While this is allowed by the standard, it does not make much sense for small-angle scattering. <br />
;<TT>/SASroot/SASentry/SASsample/position/z/@unit </TT>: [1..1] Required unit for the dimension of z. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/temperature </TT>: [0..1] Temperature of this sample. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASsample/temperature/@unit </TT>: [1..1] Required unit for temperature. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/thickness </TT>: [0..1] Thickness of this sample. Must specify the unit as an attribute. <br />
;<TT>/SASroot/SASentry/SASsample/thickness/@unit </TT>: [1..1] Required unit for thickness. (See @unit for details.) <br />
;<TT>/SASroot/SASentry/SASsample/transmission </TT>: [0..1] Transmission (1-attenuation) of this sample. Express this as a fraction, not as a percentage. NOTE: there is not "unit" attribute. <br />
;<TT>/SASroot/SASentry/Title </TT>: [1..1] Title of this SASentry. <br />
;<TT>@unit </TT>: Data unit to be given in standard SI abbreviations (e.g., m, cm, mm, nm, K) with the following exceptions: um=micrometres C=celsius A=Angstroms percent=%. fraction a.u.=arbitrary units none=no units are relevant (such as dimensionless) <br />
;<TT>orientation/pitch </TT>: [0..1] Rotation about about the X axis. Unit must be specified. <br />
;<TT>orientation/roll </TT>: [0..1] Rotation about about the Z axis. Unit must be specified. <br />
;<TT>orientation/yaw </TT>: [0..1] Rotation about about the Y axis. Unit must be specified. <br />
;<TT>position/x </TT>: [0..1] Translation in the horizontal direction, orthogonal to Y and Z. Positive X direction increases as defined by Y and Z. Unit must be specified. <br />
;<TT>position/y </TT>: [0..1] Translation along the vertical gravitational direction. Positive direction increases upward. Unit must be specified. <br />
;<TT>position/z </TT>: [0..1] Translation along the beam direction. Positive direction increases from source towards detector. Unit must be specified. <br />
;<TT>roll, pitch, yaw </TT>: Coordinates for (roll, pitch, yaw) values representing an orientation or rotation. Unit must be specified for each. <br />
;<TT>x, y, z </TT>: Coordinates for (x, y, z) values representing a position or dimension. Unit must be specified for each. <br />
 
==attributes==
 
;<tt>name</tt>:
;<tt>type</tt>:
;<tt>unit</tt>:
;<tt>version</tt>:
 
==rules==
# no whitespace padding of value fields
# Q=(4 &pi; / &lambda;) sin(&theta;) <br> where &lambda; is the wavelength of the radiation and 2&theta; is the angle through which the detected radiation has been scattered.
# units to be given in standard SI abbreviations (eg, m, cm, mm, nm, K) with the following exceptions:
##um=micrometres
##C=celsius
##A=Angstroms
##percent=%.
##fraction
##a.u.=arbitrary units
##none=no units are relevant (such as dimensionless)
# where reciprocal units need to be quoted the format shall be "1/abbreviation"
# Unicode characters MUST NOT be used
# axes:
##z is along the flight path (positive value in the direction of the detector)
##x is orthogonal to z in the horizontal plane (positive values increase to the right when viewed towards the incoming radiation)
##y is orthogonal to z and x in the vertical plane (positive values increase upwards)
#angles:
##roll is about z
##pitch is about x
##yaw is about y
 
==Validation of XML against the Schema==
# open browser to:  http://www.xmlvalidation.com/
# paste content of candidate XML file into the form
# replace standard canSAS1D XML header with canSAS1D XML Schema validation header (see below)
# press <validate>
# paste content of [[cansas1d.xsd]] XSD file into form and press <continue validation>
# check the results
 
==alternative XML header for validating against the XML Schema==
<pre><?xml version="1.0"?>
<SASroot xmlns="http://www.smallangles.net/cansas1d"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.smallangles.net/cansas1d/ http://www.smallangles.net/cansas1d/1.0/cansas1d.xsd"
version="1.0">
</pre>

Latest revision as of 04:39, 30 November 2009

This manual has been superseded (replaced) by a PDF:

http://svn.smallangles.net/trac/canSAS/browser/1dwg/tags/v1.0/doc/cansas-1d-1_0-manual.pdf?format=raw

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