Monochromatic Neutron and X-ray Triple-Axis Spectrometer

From NeXus

Jump to: navigation, search

Contents

XML Meta-DTD Definition for NXmonotas.xml

This follows the XML Meta-DTD Definition format and can be downloaded from http://svn.nexusformat.org/definitions/tags/PRE_NXDL/instruments/NXmonotas.xml

<!--
URL:     http://www.nexus.anl.gov/classes/xml/NXmonotas.xml
Editor:  NIAC
NIAC Version: 0.1
$Id: NXmonotas.xml 46 2007-09-26 19:01:29Z L.lerusse $

Template of a generic NeXus file containing neutron or x-ray triple-axis data.

Multianalyzer systems are going to be complicated.  Each analyzer is measuring a
separate H-K-L-dE.  How this measurement is performed will vary from instrument
to instrument.  Some will have a different detector for each analyzer.  Others
will have windows within a 2D detector.  The detector group (which must be
named "detector") will contain the counts associated with each analyzer.  There 
may in addition be raw_detector groups which contains the raw detector 
counts independent of the masks.

H-K-L-dE are all stored with the sample.  In the multianalyzer case these will
be arrays with one for each scan point (length np) and one for each analyzer
(length na).  Note that np must be the first listed dimension.

Note that the image for each analyzer on the detector could be 0, 1 or 2D,
depending on whether i,j indices are present.
-->
<NXentry name="{Name of entry}">
  <title>
    {Extended title for entry}
  </title>
  <definition URL="http://www.nexus.anl.gov/instruments/xml/NXmonotas.xml"
      version="1.0">
    NXmonotas
  </definition>
  <start_time type="ISO8601">
    {Starting time of measurement}
  </start_time>
  <NXsample name="{name of sample}">
    <name type="NX_CHAR">
      {Descriptive name of sample}?
    </name>
    <unit_cell type="NX_FLOAT[1,6])">
      {Unit cell parameters (lengths and angles)}?
    </unit_cell>
    <orientation_matrix type="NX_FLOAT[3,3]">?
        {Orientation matrix when appropriate}
    </orientation_matrix> 
    <plane_vector_0 type="NX_FLOAT[3]">
      {Reciprocal space vector of primary reflection in the scattering plane}
    </plane_vector_0>
    <plane_vector_1 type="NX_FLOAT[3]">
      {Reciprocal space vector of secondary reflection in the scattering plane}
    </plane_vector_1>
    <polar_angle units="degree" type="NX_FLOAT[np]">
      {Polar angle of the sample with respect to the beam incident on the monochromator}
    </polar_angle>
    <azimuthal_angle units="degree" type="NX_FLOAT">
      {Azimuthal angle of the sample with respect to the beam incident on the
      monochromator}
    </azimuthal_angle>
    <rotation_angle units="degree" type="NX_FLOAT[np]">
      {Rotation angle of the sample}
    </rotation_angle>
    <sgu type="NX_FLOAT[np]" units="degree">?
        {Sample stage tilt angle as defined by Lumsden}
    </sgu>
    <sgl type="NX_FLOAT[np]" units="degree">?
        {Sample stage tilt angle as defined by Lumsden}
    </sgl>
    <Qh type="NX_FLOAT[np,na?]">
      {Reciprocal space component of scan}
    </Qh>
    <Qk type="NX_FLOAT[np,na?]">
      {Reciprocal space component of scan}
    </Qk>
    <Ql type="NX_FLOAT[np,na?]">
      {Reciprocal space component of scan}
    </Ql>
    <energy_transfer units="meV" type="NX_FLOAT[np,na?]">
      {Energy transfer of scan}
    </energy_transfer>
  </NXsample>
  <NXinstrument name="{Name of instrument}">
    <NXcollimator name="premonochromator_collimator">?
      <type type="NX_CHAR">
        "Soller"|"radial"
      </type>
      <soller_angle units="minute" type="NX_FLOAT">
        {Angular divergence of Soller collimator}
      </soller_angle>
    </NXcollimator>
    <NXfilter name="premonochromator_filter">?
      <description type="NX_CHAR">
        {"Beryllium" | "Pyrolytic Graphite" | "Graphite"}
      </description>
    </NXfilter>
    <NXcrystal name="monochromator">
      <type type="NX_CHAR">
        {"PG (Highly Oriented Pyrolytic Graphite)" | "Ge" | "Si" | "Cu" |
        "Fe3Si" | "CoFe" | "Cu2MnAl (Heusler)" | "Multilayer"}
      </type>
      <energy units="meV" type="NX_FLOAT[np]">
        {Optimum diffracted energy}
      </energy>
      <d_spacing units="Angstrom" type="NX_FLOAT">
        {The planar spacing of the nominal reflection}
      </d_spacing>
      <rotation_angle units="degree" type="NX_FLOAT[np]">
        {Rotation angle of the monochromator}
      </rotation_angle>
      <curvature_horizontal type="NX_FLOAT" units="degrees">?
		{Horizontal curvature of focusing crystal}?
      </curvature_horizontal>
      <curvature_vertical type="NX_FLOAT" units="degrees">?
		{Vertical curvature of focusing crystal}?
      </curvature_vertical>
    </NXcrystal>
    <NXcollimator name="presample_collimator">?
      <type type="NX_CHAR">
        "Soller"|"radial"
      </type>
      <soller_angle units="minute" type="NX_FLOAT">
        {Angular divergence of Soller collimator}
      </soller_angle>
    </NXcollimator>
    <NXfilter name="presample_filter">?
      <description type="NX_CHAR">
        {"Beryllium" | "Pyrolytic Graphite" | "Graphite"}
      </description>
    </NXfilter>
    <NXcollimator name="preanalyzer_collimator">?
      <type type="NX_CHAR">
        "Soller"|"radial"
      </type>
      <soller_angle units="minute" type="NX_FLOAT">
        {Angular divergence of Soller collimator}
      </soller_angle>
    </NXcollimator>
    <NXfilter name="preanalyzer_filter">?
      <description type="NX_CHAR">
        {"Beryllium" | "Pyrolytic Graphite" | "Graphite"}
      </description>
    </NXfilter>
    <NXcrystal name="analyzer">
      <type type="NX_CHAR">
        {"PG (Highly Oriented Pyrolytic Graphite)" | "Ge" | "Si" | "Cu" |
        "Fe3Si" | "CoFe" | "Cu2MnAl (Heusler)" | "Multilayer"}
      </type>
      <energy units="meV" type="NX_FLOAT[np,na]">
        {Optimum diffracted energy}
      </energy>
      <d_spacing units="Angstrom" type="NX_FLOAT">
        {The planar spacing of the nominal reflection}
      </d_spacing>
      <polar_angle units="degree" type="NX_FLOAT[np,na?]">
        {Polar angle of the analyzer with respect to the beam incident on the
        monochromator}
      </polar_angle>
      <azimuthal_angle units="degree" type="NX_FLOAT">
        {Azimuthal angle of the analyzer with respect to the beam incident on
        the monochromator}
      </azimuthal_angle>
      <rotation_angle units="degree" type="NX_FLOAT[np,na?]">
        {Rotation angle of the monochromator}
      </rotation_angle>
      <curvature_horizontal type="NX_FLOAT" units="degrees">?
		{Horizontal curvature of focusing crystal}?
      </curvature_horizontal>
      <curvature_vertical type="NX_FLOAT" units="degrees">?
		{Vertical curvature of focusing crystal}?
      </curvature_vertical>
    </NXcrystal>
    <NXcollimator name="predetector_collimator">?
      <type type="NX_CHAR">
        "Soller"|"radial"
      </type>
      <soller_angle units="minute" type="NX_FLOAT">
        {Angular divergence of Soller collimator}
      </soller_angle>
    </NXcollimator>
    <NXdetector name="detector">
      <counts signal="1" axes="energy_transfer|Qh|Qk|Ql" type="NX_INT[np,na?,i?,j?]">
        {Integer counts}
      </counts>
      <polar_angle units="degree" type="NX_FLOAT[np,na?,i?,j?]">
        {Polar angle of the detector with respect to the beam incident on the
        monochromator}
      </polar_angle>
      <azimuthal_angle units="degree" type="NX_FLOAT[na?,i?,j?]">
        {Azimuthal angle of the detector with respect to the beam incident on
        the analyzer}
      </azimuthal_angle>
      <weight units="dimensionless" type="NX_FLOAT[np,na?]">?
        {Relative weight of the different analyzers e.g., because the integrated
         regions are not all the same size.}
      </weight>
    </NXdetector>
    <NXdetector name="{raw_detector}">*
      {Possible set of raw detectors in case the "detector" detector is really
       a virtual detector.}
    </NXdetector>
  </NXinstrument>
  <NXmonitor name="control">
    <mode type="NX_CHAR">
      "monitor"|"timer"
    </mode>
    <preset type="NX_FLOAT">
      {preset value for time or monitor}
    </preset>
    <data type="NX_INT[np]">
      {Monitor data}?
    </data>
    <count_time type="NX_FLOAT[np]" units="second">
     {Elapsed time for each scan point}
    </count_time>
  </NXmonitor>
  <NXdata name="data">
    <Qh NAPIlink="NXentry/NXsample/Qh">
    </Qh>
    <Qk NAPIlink="NXentry/NXsample/Qk">
    </Qk>
    <Ql NAPIlink="NXentry/NXsample/Ql">
    </Ql>
    <energy_transfer NAPIlink="NXentry/NXsample/energy_transfer">
    </energy_transfer>
    <counts NAPIlink="NXentry/NXinstrument/detector/counts">
    </counts>
    <energy NAPIlink="NXentry/NXinstrument/analyzer/energy">
    </energy>
  </NXdata>
</NXentry>

Tabular Representation of XML Meta-DTD

(automatically generated from http://svn.nexusformat.org/definitions/tags/PRE_NXDL/instruments/NXmonotas.xml)

NXentry

Name Type Description Attributes
titleNX_CHARExtended title for entry
definitionNX_CHAR
URL="http://www.nexus.anl.gov/instruments/xml/NXmonotas.xml"

version="1.0"

start_timeISO 8601Starting time of measurement
{name of sample}NXsample

NXsample

Name Type Description Attributes
nameNX_CHARDescriptive name of sample
unit_cellNX_FLOAT[1,6])Unit cell parameters (lengths and angles)
orientation_matrixNX_FLOAT[3,3]Orientation matrix when appropriate
plane_vector_0NX_FLOAT[3]Reciprocal space vector of primary reflection in the scattering plane
plane_vector_1NX_FLOAT[3]Reciprocal space vector of secondary reflection in the scattering plane
polar_angleNX_FLOAT[np]Polar angle of the sample with respect to the beam incident on the monochromator
units="degree"
azimuthal_angleNX_FLOATAzimuthal angle of the sample with respect to the beam incident on the monochromator
units="degree"
rotation_angleNX_FLOAT[np]Rotation angle of the sample
units="degree"
sguNX_FLOAT[np]Sample stage tilt angle as defined by Lumsden
units="degree"
sglNX_FLOAT[np]Sample stage tilt angle as defined by Lumsden
units="degree"
QhNX_FLOAT[np,na?]Reciprocal space component of scan
QkNX_FLOAT[np,na?]Reciprocal space component of scan
QlNX_FLOAT[np,na?]Reciprocal space component of scan
energy_transferNX_FLOAT[np,na?]Energy transfer of scan
units="meV"

NXentry continued (1)

Name Type Description Attributes
{Name of instrument}NXinstrument

NXinstrument

Name Type Description Attributes
premonochromator_collimatorNXcollimator

NXcollimator

Name Type Description Attributes
typeNX_CHAR
soller_angleNX_FLOATAngular divergence of Soller collimator
units="minute"

NXinstrument continued (1)

Name Type Description Attributes
premonochromator_filterNXfilter

NXfilter

Name Type Description Attributes
descriptionNX_CHAR"Beryllium" | "Pyrolytic Graphite" | "Graphite"

NXinstrument continued (2)

Name Type Description Attributes
monochromatorNXcrystal

NXcrystal

Name Type Description Attributes
typeNX_CHAR"PG (Highly Oriented Pyrolytic Graphite)" | "Ge" | "Si" | "Cu" | "Fe3Si" | "CoFe" | "Cu2MnAl (Heusler)" | "Multilayer"
energyNX_FLOAT[np]Optimum diffracted energy
units="meV"
d_spacingNX_FLOATThe planar spacing of the nominal reflection
units="Angstrom"
rotation_angleNX_FLOAT[np]Rotation angle of the monochromator
units="degree"
curvature_horizontalNX_FLOATHorizontal curvature of focusing crystal
units="degrees"
curvature_verticalNX_FLOATVertical curvature of focusing crystal
units="degrees"

NXinstrument continued (3)

Name Type Description Attributes
presample_collimatorNXcollimator

NXcollimator

Name Type Description Attributes
typeNX_CHAR
soller_angleNX_FLOATAngular divergence of Soller collimator
units="minute"

NXinstrument continued (4)

Name Type Description Attributes
presample_filterNXfilter

NXfilter

Name Type Description Attributes
descriptionNX_CHAR"Beryllium" | "Pyrolytic Graphite" | "Graphite"

NXinstrument continued (5)

Name Type Description Attributes
preanalyzer_collimatorNXcollimator

NXcollimator

Name Type Description Attributes
typeNX_CHAR
soller_angleNX_FLOATAngular divergence of Soller collimator
units="minute"

NXinstrument continued (6)

Name Type Description Attributes
preanalyzer_filterNXfilter

NXfilter

Name Type Description Attributes
descriptionNX_CHAR"Beryllium" | "Pyrolytic Graphite" | "Graphite"

NXinstrument continued (7)

Name Type Description Attributes
analyzerNXcrystal

NXcrystal

Name Type Description Attributes
typeNX_CHAR"PG (Highly Oriented Pyrolytic Graphite)" | "Ge" | "Si" | "Cu" | "Fe3Si" | "CoFe" | "Cu2MnAl (Heusler)" | "Multilayer"
energyNX_FLOAT[np,na]Optimum diffracted energy
units="meV"
d_spacingNX_FLOATThe planar spacing of the nominal reflection
units="Angstrom"
polar_angleNX_FLOAT[np,na?]Polar angle of the analyzer with respect to the beam incident on the monochromator
units="degree"
azimuthal_angleNX_FLOATAzimuthal angle of the analyzer with respect to the beam incident on the monochromator
units="degree"
rotation_angleNX_FLOAT[np,na?]Rotation angle of the monochromator
units="degree"
curvature_horizontalNX_FLOATHorizontal curvature of focusing crystal
units="degrees"
curvature_verticalNX_FLOATVertical curvature of focusing crystal
units="degrees"

NXinstrument continued (8)

Name Type Description Attributes
predetector_collimatorNXcollimator

NXcollimator

Name Type Description Attributes
typeNX_CHAR
soller_angleNX_FLOATAngular divergence of Soller collimator
units="minute"

NXinstrument continued (9)

Name Type Description Attributes
detectorNXdetector

NXdetector

Name Type Description Attributes
countsNX_INT[np,na?,i?,j?]Integer counts
signal="1"

axes="energy_transfer|Qh|Qk|Ql"

polar_angleNX_FLOAT[np,na?,i?,j?]Polar angle of the detector with respect to the beam incident on the monochromator
units="degree"
azimuthal_angleNX_FLOAT[na?,i?,j?]Azimuthal angle of the detector with respect to the beam incident on the analyzer
units="degree"
weightNX_FLOAT[np,na?]Relative weight of the different analyzers e.g., because the integrated regions are not all the same size.
units="dimensionless"

NXinstrument continued (10)

Name Type Description Attributes
{raw_detector}NXdetectorPossible set of raw detectors in case the "detector" detector is really a virtual detector.

NXentry continued (2)

Name Type Description Attributes
controlNXmonitor

NXmonitor

Name Type Description Attributes
modeNX_CHAR
presetNX_FLOATpreset value for time or monitor
dataNX_INT[np]Monitor data
count_timeNX_FLOAT[np]Elapsed time for each scan point
units="second"

NXentry continued (3)

Name Type Description Attributes
dataNXdata

NXdata

Name Type Description Attributes
QhNX_CHAR
NAPIlink="NXentry/NXsample/Qh"
QkNX_CHAR
NAPIlink="NXentry/NXsample/Qk"
QlNX_CHAR
NAPIlink="NXentry/NXsample/Ql"
energy_transferNX_CHAR
NAPIlink="NXentry/NXsample/energy_transfer"
countsNX_CHAR
NAPIlink="NXentry/NXinstrument/detector/counts"
energyNX_CHAR
NAPIlink="NXentry/NXinstrument/analyzer/energy"

Personal tools