Time-of-Flight Neutron Indirect Geometry Spectrometer

From NeXus

Jump to: navigation, search

Contents

XML Meta-DTD Definition for NXtofnigs.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<!--
URL: http://definition.nexusformat.org/NXtofnigs
$Id: NXtofnigs.xml 46 2007-09-26 19:01:29Z L.lerusse $
  
Instrument Definition for a Time-of-flight Inverse Geometry Spectrometer

-->
<NXroot>
 <NXentry name="{Name of Entry}">+
   <NXinstrument name="{instrument name}">
    
    <NXsource name="{Name of facility}">
  			<name>{facility name}</name>
     	    <type>{type of beamline: "pulsed muon source" | "continuous muon source" | "low energy muon source"}</type>
     		<probe>"neutrons"</probe>
	</NXsource>

	<NXmoderator name="{Name of moderator}">
		<distance type="NX_FLOAT">{Effective distance as seen by measuring radiation}?</distance>
		<type type="NX_CHAR">{ "H20" | "D20"  |  "Liquid H2"  | "Liquid CH4" | "Liquid D2" | "Solid D2" | "C" |"Solid CH4" | "Solid H2"}?</type>
        <poison_depth NAPItype="NX_FLOAT" units="centimetre"></poison_depth>
        <poison_material>Gd</poison_material>
        <temperature NAPItype="NX_FLOAT" units="Kelvin"></temperature>
	</NXmoderator>

    <NXdetector name="{name of detector or bank}">+
        <counts type="NX_INT[i]" units="counts" signal="1">{array of counts}</counts>
        <x_pixel_offset NAPItype="NX_FLOAT[i]" axis="NX_INT:1" units="metre" primary="NX_INT:1"></x_pixel_offset>
        <y_pixel_offset NAPItype="NX_FLOAT[i]" axis="NX_INT:2" units="metre" primary="NX_INT:1"></y_pixel_offset>
        <polar_angle NAPItype="NX_FLOAT[i]" axis="NX_INT:1" units="radian" primary="NX_INT:2"></polar_angle>
        <azimuthal_angle NAPItype="NX_FLOAT[i]" units="radian"></azimuthal_angle>
        <distance NAPItype="NX_FLOAT[i]" axis="NX_INT:2" units="metre" primary="NX_INT:2"></distance>
        <NXgeometry name="origin">
          <description>Position of the detector ceter relative to the origin of the instrument</description>
          <NXtranslation name="translation">
            <distance NAPItype="NX_FLOAT[3]" units="metre"></distance>
          </NXtranslation>
          <NXorientation name="orientation">
            <description>The orientation is with the positive x-axis pointing in the original positive z-direction</description>
            <value NAPItype="NX_FLOAT[3]"></value>
          </NXorientation>
          <NXshape name="shape">
            <description>diameter,height</description>
            <shape>nxcylinder</shape>
            <size NAPItype="NX_FLOAT[2]" units="metre"></size>
          </NXshape>
        </NXgeometry>
    </NXdetector>
    
    <NXcrystal name="{name of analyzer}">+
        <type>{type}</type>
        <wavelength NAPItype="NX_FLOAT[i]" units="Angstroms"></wavelength>
        <NXgeometry name="origin">
          <description>Position of the analyzer crystal relative to the origin of the instrument</description>
          <NXtranslation name="translation">
            <distance NAPItype="NX_FLOAT[3]" units="metre"></distance>
          </NXtranslation>
          <NXorientation name="orientation">
            <description>The orientation is with the positive x-axis pointing in the original positive z-direction</description>
            <value NAPItype="NX_FLOAT[6]"></value>
          </NXorientation>
          <NXshape name="shape">
            <shape>nxsphere</shape>
            <size NAPItype="NX_FLOAT" units="metre"></size>
          </NXshape>
        </NXgeometry>
    </NXcrystal>

   </NXinstrument>
   
   <NXmonitor name="{name of monitor}">+
      <distance NAPItype="NX_FLOAT" units="metre"></distance>
   </NXmonitor>
   
   <NXdata name="{name of data}">+
     	<NAPIlink name="counts">{link to detector counts}</NAPIlink>
        <NAPIlink name="wavelength">{link to analyser wavelength}</NAPIlink>
   </NXdata>
   
   </NXentry>
  </NXroot>

Tabular Representation of XML Meta-DTD

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

NXroot

Name Type Description Attributes
{Name of Entry}NXentry

NXentry

Name Type Description Attributes
{instrument name}NXinstrument

NXinstrument

Name Type Description Attributes
{Name of facility}NXsource

NXsource

Name Type Description Attributes
nameNX_CHARfacility name
typeNX_CHARtype of beamline: "pulsed muon source" | "continuous muon source" | "low energy muon source"
probeNX_CHAR

NXinstrument continued (1)

Name Type Description Attributes
{Name of moderator}NXmoderator

NXmoderator

Name Type Description Attributes
distanceNX_FLOATEffective distance as seen by measuring radiation
typeNX_CHAR "H20" | "D20" | "Liquid H2" | "Liquid CH4" | "Liquid D2" | "Solid D2" | "C" |"Solid CH4" | "Solid H2"
poison_depthNX_CHAR
NAPItype="NX_FLOAT"

units="centimetre"

poison_materialNX_CHAR
temperatureNX_CHAR
NAPItype="NX_FLOAT"

units="Kelvin"

NXinstrument continued (2)

Name Type Description Attributes
{name of detector or bank}NXdetector

NXdetector

Name Type Description Attributes
countsNX_INT[i]array of counts
units="counts"

signal="1"

x_pixel_offsetNX_CHAR
NAPItype="NX_FLOAT[i]"

axis="NX_INT:1"
units="metre"
primary="NX_INT:1"

y_pixel_offsetNX_CHAR
NAPItype="NX_FLOAT[i]"

axis="NX_INT:2"
units="metre"
primary="NX_INT:1"

polar_angleNX_CHAR
NAPItype="NX_FLOAT[i]"

axis="NX_INT:1"
units="radian"
primary="NX_INT:2"

azimuthal_angleNX_CHAR
NAPItype="NX_FLOAT[i]"

units="radian"

distanceNX_CHAR
NAPItype="NX_FLOAT[i]"

axis="NX_INT:2"
units="metre"
primary="NX_INT:2"

originNXgeometry

NXgeometry

Name Type Description Attributes
descriptionNX_CHAR
translationNXtranslation

NXtranslation

Name Type Description Attributes
distanceNX_CHAR
NAPItype="NX_FLOAT[3]"

units="metre"

NXgeometry continued (1)

Name Type Description Attributes
orientationNXorientation

NXorientation

Name Type Description Attributes
descriptionNX_CHAR
valueNX_CHAR
NAPItype="NX_FLOAT[3]"

NXgeometry continued (2)

Name Type Description Attributes
shapeNXshape

NXshape

Name Type Description Attributes
descriptionNX_CHAR
shapeNX_CHAR
sizeNX_CHAR
NAPItype="NX_FLOAT[2]"

units="metre"

NXinstrument continued (3)

Name Type Description Attributes
{name of analyzer}NXcrystal

NXcrystal

Name Type Description Attributes
typeNX_CHARtype
wavelengthNX_CHAR
NAPItype="NX_FLOAT[i]"

units="Angstroms"

originNXgeometry

NXgeometry

Name Type Description Attributes
descriptionNX_CHAR
translationNXtranslation

NXtranslation

Name Type Description Attributes
distanceNX_CHAR
NAPItype="NX_FLOAT[3]"

units="metre"

NXgeometry continued (1)

Name Type Description Attributes
orientationNXorientation

NXorientation

Name Type Description Attributes
descriptionNX_CHAR
valueNX_CHAR
NAPItype="NX_FLOAT[6]"

NXgeometry continued (2)

Name Type Description Attributes
shapeNXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR
sizeNX_CHAR
NAPItype="NX_FLOAT"

units="metre"

NXentry continued (1)

Name Type Description Attributes
{name of monitor}NXmonitor

NXmonitor

Name Type Description Attributes
distanceNX_CHAR
NAPItype="NX_FLOAT"

units="metre"

NXentry continued (2)

Name Type Description Attributes
{name of data}NXdata

NXdata

Name Type Description Attributes
countsNAPIlinklink to detector counts
wavelengthNAPIlinklink to analyser wavelength

Personal tools