Time-of-Flight Neutron Reflectometry

From NeXus

Jump to: navigation, search

Contents

XML Meta-DTD Definition for NXtofnref.xml

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

<?xml version="1.0" ?>
<!--
URL: http://www.nexusformat.org/
Editor: Robert Dalgliesh <r.m.dalgliesh@rl.ac.uk>
Initial version: October 2004
$Id$

Instrument Definition for a Polarised Time of Flight Neutron Reflectometer

Please note this is a rough first draft.

By removing the polarising elements you should be left with a description for a TOF reflectometer
There are a number of  additional components such as guide fields and other collimation components which I have not included. 
-->
<NXentry name="{name of entry}">+

  <definition version="1.0" 
      URL="http://www.nexusformat.org/instruments/xml/tofnref.xml"
      >
    NXtofnref
  </definition>

<NXinstrument name="TOFNREF">
	<name short_name="{abbreviated name of instrument}">{Name of instrument}</name>
	<!-- I'm guessing here that "short_name" is something like 'CRISP'? -->

	<NXsource name="{Name of facility}">
		<NXgeometry name="geometry">
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of target along beam path}</component_index>
			<description type="NX_CHAR">{Optional description/label}?</description>
			<component_index type="NX_INT">{Sequential order of component along beam path}?</component_index>
			<!--If using XML Schema instead would be able to denote that '0' cannot be selected for this component-->
		</NXgeometry>
	</NXsource>

	<NXmoderator name="{Name of moderator}">
		<NXgeometry name="geometry">{"Engineering" position of moderator}?</NXgeometry>
		<distance type="NX_FLOAT">{Effective distance as seen by measuring radiation}?</distance>
			<!-- 2004-10-18 MJB Distance from where? The sample or the target? Can this be combined with NXGeometry? What is engineering position?-->
		<type type="NX_CHAR">{ "H20" | "D20"  |  "Liquid H2"  | "Liquid CH4" | "Liquid D2" | "Solid D2" | "C" |"Solid CH4" | "Solid H2"}?</type>
		<poison_depth type="NX_FLOAT" units="metre" exponent="?">{Poison depth}?</poison_depth>
		<coupled type="NX_BOOLEAN">{whether the moderator is coupled}?</coupled>
		<poison_material type="NX_CHAR">{ Gd | Cd |...}</poison_material>
		<temperature type="NX_FLOAT" Units="Kelvin" exponent="?">{average/nominal moderator temperature}</temperature>
		<temperature_log type="NXlog">{log file of moderator temperature}</temperature_log>
		<pulse_shape type="NXdata">{moderator pulse shape}</pulse_shape>
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of moderator}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of moderator along beam path}</component_index>
		</NXgeometry>
	</NXmoderator>

	<NXGuide name="{Name of guide section}">*
		<!--Guides in total or in segments thgrough to sample position; may be interspersed between other components - Check component index-->
		<!--Can be nested for guides with multiple straight segments-->
		<description type="NX_CHAR">{}</description> 
		<incident_angle type="NX_FLOAT">{}</incident_angle> 
		<reflectivity type="NXdata">{Reflectivity as function of wavelength [nsurf,i]}</reflectivity> 
		<bend_angle_x type="NX_FLOAT">{}</bend_angle_x> 
		<bend_angle_y type="NX_FLOAT">{}</bend_angle_y> 
		<interior_atmosphere type="NX_CHAR">"vacuum"|"helium"|"argon"</interior_atmosphere> 
		<external_material type="NX_CHAR">{external material outside substrate}</external_material> 
		<m_value type="NX_FLOAT[nsurf]">{}</m_value> 
		<substrate_material type="NX_FLOAT[nsurf]">{}</substrate_material> 
		<substrate_thickness type="NX_FLOAT[nsurf]">{}</substrate_thickness> 
		<coating_material type="NX_FLOAT[nsurf]">{}</coating_material> 
		<substrate_roughness type="NX_FLOAT[nsurf]">{}</substrate_roughness> 
		<coating_roughness type="NX_FLOAT[nsurf]">{}</coating_roughness> 
		<number_sections type="NX_INT">{number of substrate sections}</number_sections> 
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of guide}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of guide along beam path}</component_index>
		</NXgeometry>
	</NXGuide>


	<NXt0_chopper name="{Name of chopper}">?
		<!-- 2004-10-18 MJB+RMD This is a T0 blocking chopper phased to the source to block fast neutron and gamma flash.
										  None of the existing chopper types meets this requirement. 
										  In fact, why don't we just have one chopper class?
										  We don't have different detector classes for different varieties.-->
	</NXt0_chopper>
	
	<NXdisk_chopper name="{Name of disk chopper}">
		<!--Some instruments can have multiple choppers in the incident beam-->
		<type type="NX_CHAR">{Chopper type single|contra_rotating_pair|synchro_pair}?</type>
	    <rotation_speed type="NX_FLOAT" units="hertz" exponent="?">{chopper rotation speed}?</rotation_speed>
		<slits type="NX_INT">{Number of slits}</slits>
	   <slit_angle type="NX_FLOAT" units="radians" exponent="?">{angular opening}</slit_angle>
	   <pair_separation type="NX_FLOAT" units="metre" exponent="?"> {disc spacing in direction of beam}?</pair_separation>
	   <radius type="NX_FLOAT" units="metre" exponent="?"> {radius to centre of slit}</radius>
	   <slit_height type="NX_FLOAT" units="metre" exponent="?"> {total slit height}</slit_height>
	   <phase type="NX_FLOAT" units="radians" exponent="?">{chopper phase angle}? </phase>
	   <ratio type="NX_INT">{pulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument}?</ratio>
	   <distance type="NX_FLOAT" units="metre" exponent="?"> {Effective distance to the origin}?</distance>
	   <wavelength_range type="NX_FLOAT[2]" units="metre" exponent="?">{low and high values of wavelength range transmitted}?</wavelength_range>
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of chopper}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of chopper along beam path}</component_index>
		</NXgeometry>
	</NXdisk_chopper>   
	
    <NXaperture name="{Name of beamline aperture}">*		
		<material type="NX_CHAR">{Absorbing material of the aperture}?</material>
		<description type="NX_CHAR">{Description of aperture}?</description>
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of aperture}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of aperture along beam path}</component_index>
		</NXgeometry>
	</NXaperture>
	
    <NXmonitor name="{Name of monitor}">+
		<type type="NX_CHAR">"Fission Chamber"|"Scintillator"?</type>
		<mode type="NX_CHAR">"monitor"|"timer"?</mode>
		<preset type="NX_FLOAT">{preset value for time or monitor}?</preset>
		<distance type="NX_FLOAT" units="metre" exponent="?">{Distance of monitor from sample position}?</distance>
		<efficiency type="Nxdata">{Monitor efficiency as a function of wavelength}?</efficiency>
		<sampled_fraction type="NX_FLOAT" units="dimensionless">{Proportion of incident beam sampled by the monitor}</sampled_fraction>
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of monitor}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of monitor along beam path}</component_index>
		</NXgeometry>
	</NXmonitor>

    <NXmirror name="{Name of supermirror}">
        <!-- Frame overlap mirror -->
        <description type="NX_CHAR">{}</description> 
        <incident_angle type="NX_FLOAT">{}</incident_angle> 
        <reflectivity type="NXdata">{Reflectivity as function of wavelength}</reflectivity> 
        <bend_angle_x type="NX_FLOAT">{}</bend_angle_x> 
        <bend_angle_y type="NX_FLOAT">{}</bend_angle_y> 
        <interior_atmosphere type="NX_CHAR">"vacuum"|"helium"|"argon"</interior_atmosphere> 
        <external_material type="NX_CHAR">{external material outside substrate}</external_material> 
        <m_value type="NX_FLOAT">{}</m_value> 
        <substrate_material type="NX_CHAR">{}</substrate_material> 
        <substrate_thickness type="NX_FLOAT">{}</substrate_thickness> 
        <coating_material type="NX_CHAR">{}</coating_material> 
        <substrate_roughness type="NX_FLOAT">{}</substrate_roughness> 
        <coating_roughness type="NX_FLOAT">{}</coating_roughness> 
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of mirror}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of aperture along beam path}</component_index>
		</NXgeometry>
    </NXmirror>

    <NXpolarizer name="{Name of supermirror}">*
        <!-- Polarising Supermirror -->
        <!-- Not sure how best to deal with this. A polarising supermirror needs the properties of NXmirror
        the NXData class should hopefully be able to take care of the polarisation dependent wavelength spectra 
        In addition the mirror may operate in reflection or transmission geometry which would add the need for an
        absorption correction.
        -->
        <description type="NX_CHAR">{}</description> 
        <incident_angle type="NX_FLOAT">{}</incident_angle> 
        <reflectivity type="NXdata">{Reflectivity as function of wavelength}</reflectivity> 
        <bend_angle_x type="NX_FLOAT">{}</bend_angle_x> 
        <bend_angle_y type="NX_FLOAT">{}</bend_angle_y> 
        <interior_atmosphere type="NX_CHAR">"vacuum"|"helium"|"argon"</interior_atmosphere> 
        <external_material type="NX_CHAR">{external material outside substrate}</external_material> 
        <m_value type="NX_FLOAT">{}</m_value> 
        <substrate_material type="NX_CHAR">{}</substrate_material> 
        <substrate_thickness type="NX_FLOAT">{}</substrate_thickness> 
        <coating_material type="NX_CHAR">{}</coating_material> 
        <substrate_roughness type="NX_FLOAT">{}</substrate_roughness> 
        <coating_roughness type="NX_FLOAT">{}</coating_roughness> 
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of polariser}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of aperture along beam path}</component_index>
		</NXgeometry>
    </NXpolarizer>

    <NXflipper name="{Name of flipper}">*
        <!-- This class may well need to be generalised to include spin manipulation devices such as neutators, precession coils and guide fields
        it would also be useful to have room for an NXData section for the wavelength dependent efficiency of the device
        -->
        <type type="NX_CHAR">{coil|current-sheet}?</type>
        <flip_turns type="NX_FLOAT">{Number of turns/cm in flipping field coils}?</flip_turns>
        <comp_turns type="NX_FLOAT">{Number of turns/cm in compensating field coils}?</comp_turns>
        <guide_turns type="NX_FLOAT">{Number of turns/cm in guide field coils}?</guide_turns>
        <flip_current type="NX_FLOAT" units="amperes">{Flipping field coil current in "on" state"}?</flip_current>
        <comp_current  type="NX_FLOAT" units="amperes">{Compensating field coil current in "on" state"}?</comp_current>
        <guide_current type="NX_FLOAT" units="amperes">{Guide field coil current in "on" state"}?</guide_current>
        <thickness type="NX_FLOAT" units="cm">{thickness along path of neutron travel}?</thickness>
		<!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of flipper}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of aperture along beam path}</component_index>
		</NXgeometry>
    </NXflipper>

    <NXdetector name="{Name of detector bank}">+
        <time_of_flight type="NX_FLOAT[j+1]" axis="1" primary="1?"
      long_name="{Axis label}" units="10^-6 second|10^-7 second" link="{absolute path to location in NXdetector}">
      {Total time of flight}</time_of_flight>
        <detector_number type="NX_INT[i]" axis="2" primary="1?" long_name="{Axis label}" link="{absolute path to location in NXdetector}">{Identifier for detector}?</detector_number>
        <data type="NX_FLOAT[i,j,k?,l?]|NX_INT[i,j,k?,l?]" signal="1" axes="[time_of_flight,detector_number,x_offset?,y_offset?]?" long_name="{Title of measurement}?"
      check_sum="{Integral of data as check of data
      integrity} (NX_INT)?" units="number"  link="{absolute path to location in NXdetector}">
      {Data values}?</data>
        <data_error type="NX_FLOAT[i,j,k?,l?]|NX_INT[i,j,k?,l?]" units="number"  link="{absolute path to location in NXdetector}">
      {Data values}</data_error>
        <x_offset axis="3" primary="1?" type="NX_FLOAT[k+1]" units="10^-3
        meter|10^-2 meter" long_name="{Axis label}"  link="{absolute path to location in NXdetector}">{offset from the
        detector center in x-direction}?</x_offset>
        <y_offset axis="4" primary="1?" type="NX_FLOAT[l+1]" units="10^-3
        meter|10^-2 meter" long_name="{Axis label}"  link="{absolute path to location in NXdetector}">{offset from the
        detector center in the y-direction}?</y_offset>
        <distance type="NX_FLOAT[j,k?,l?]" axes="detector_number,x_offset?,y_offset?"></distance>
        <polar_angle type="NX_FLOAT[j,k?,l?]" axes="detector_number,x_offset?,y_offset?"></polar_angle>
        <azimuthal_angle type="NX_FLOAT[j,k?,l?]" axes="detector_number,x_offset?,y_offset?"></azimuthal_angle>
        <description type="NX_CHAR">{name/manufacturer/model/etc. information}?</description>
        <NXgeometry name="">{Position and orientation of detector element}?</NXgeometry>
        <translation type="NX_FLOAT[2]" units="centimeter">{translation normal to direct beam}?</translation>
        <solid_angle type="NX_FLOAT[i]" units="steradians">{Solid angle subtended by the detector at the sample}?</solid_angle>
        <x_pixelsize type="NX_FLOAT[i?]" units="mili*metre">{Size of each detector pixel. If it is scalar all pixels are the same size}?</x_pixelsize>
        <y_pixelsize type="NX_FLOAT[i?]" units="mili*metre">{Size of each detector pixel. If it is scalar all pixels are the same size}?</y_pixelsize>
        <dead_time type="NX_FLOAT[i]">{Detector dead time}?</dead_time>
        <hold_off type="NX_FLOAT[i]" units="micro.second">{Delay in detector registering an event}?</hold_off>
        <gas_pressure type="NX_FLOAT[i]" units="bars">{Detector gas pressure}?</gas_pressure>
        <detection_gas_path type="NX_FLOAT" units="cm">{maximum drift space dimension}?</detection_gas_path>
        <crate type="NX_INT[i]" local_name="{Equivalent local term}">{Crate number of detector}?</crate>
        <slot type="NX_INT[i]" local_name="{Equivalent local term}">{Slot number of detector}?</slot>
        <input type="NX_INT[i]" local_name="{Equivalent local term}">{Input number of detector}?</input>
        <type type="NX_CHAR">"He3 gas cylinder"|He3 PSD"|"He3 planar multidetector"| "He3 curved multidetector"| "multi-tube He3 PSD"|"BF3 gas"|"scintillator"|"fission chamber"?</type>
        <NXdata name="efficiency">{Efficiency of detector with respect to e.g. wavelength}?</NXdata>
        <calibration_date type="ISO8601">{date of last calibration (geometry and/or efficiency)  measurements}?</calibration_date>
        <calibration_method type="NXnote">{summary of conversion of array data to pixels  (e.g.
        polynomial approximations) and location of details of the calibrations}?</calibration_method>
        <!--Geometrical properties-->
		<NXgeometry name="geometry">{Position and orientation of aperture}?
			<NXtranslation name="?">
				<value type="NX_FLOAT[3]" units="metre" exponent="?">{(x,y,z) position coordinates relative to origin at sample position}?</value>
			</NXtranslation>
			<NXorientation name="?">
				<value type="NX_FLOAT[6]">{The orientation information is stored as direction cosines relative to origin at sample position.}</value>
			</NXorientation>
			<NXshape name="{name of shape}">
				<shape type="NX_CHAR">{"nxcylinder", "nxbox", "nxsphere", ...}?</shape>
				<size type="NX_FLOAT[nshapepar]" units="metre" exponent="?">{ nshapepar dimensions for selected shape}?</size>
			</NXshape>
			<component_index type="NX_INT">{Sequential order of aperture along beam path}</component_index>
		</NXgeometry>
    </NXdetector>
</NXinstrument>
</NXentry>

Tabular Representation of XML Meta-DTD

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

NXentry

Name Type Description Attributes
definitionNX_CHAR
version="1.0"

URL="http://www.nexusformat.org/instruments/xml/tofnref.xml"

TOFNREFNXinstrument

NXinstrument

Name Type Description Attributes
nameNX_CHARName of instrument
short_name="{abbreviated name of instrument}"
{Name of facility}NXsource

NXsource

Name Type Description Attributes
geometryNXgeometry

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of target along beam path
descriptionNX_CHAROptional description/label
component_indexNX_INTSequential order of component along beam path

NXinstrument continued (1)

Name Type Description Attributes
{Name of moderator}NXmoderator

NXmoderator

Name Type Description Attributes
geometryNXgeometry"Engineering" position of moderator
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_FLOATPoison depth
units="metre"

exponent="?"

coupledNX_BOOLEANwhether the moderator is coupled
poison_materialNX_CHAR Gd | Cd |...
temperatureNX_FLOATaverage/nominal moderator temperature
Units="Kelvin"

exponent="?"

temperature_logNXloglog file of moderator temperature
pulse_shapeNXdatamoderator pulse shape
geometryNXgeometryPosition and orientation of moderator

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of moderator along beam path

NXinstrument continued (2)

Name Type Description Attributes
{Name of guide section}NXGuide

NXGuide

Name Type Description Attributes
descriptionNX_CHAR
incident_angleNX_FLOAT
reflectivityNXdataReflectivity as function of wavelength [nsurf,i]
bend_angle_xNX_FLOAT
bend_angle_yNX_FLOAT
interior_atmosphereNX_CHAR
external_materialNX_CHARexternal material outside substrate
m_valueNX_FLOAT[nsurf]
substrate_materialNX_FLOAT[nsurf]
substrate_thicknessNX_FLOAT[nsurf]
coating_materialNX_FLOAT[nsurf]
substrate_roughnessNX_FLOAT[nsurf]
coating_roughnessNX_FLOAT[nsurf]
number_sectionsNX_INTnumber of substrate sections
geometryNXgeometryPosition and orientation of guide

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of guide along beam path

NXinstrument continued (3)

Name Type Description Attributes
{Name of chopper}NXt0_chopper
{Name of disk chopper}NXdisk_chopper

NXdisk_chopper

Name Type Description Attributes
typeNX_CHARChopper type single|contra_rotating_pair|synchro_pair
rotation_speedNX_FLOATchopper rotation speed
units="hertz"

exponent="?"

slitsNX_INTNumber of slits
slit_angleNX_FLOATangular opening
units="radians"

exponent="?"

pair_separationNX_FLOATdisc spacing in direction of beam
units="metre"

exponent="?"

radiusNX_FLOATradius to centre of slit
units="metre"

exponent="?"

slit_heightNX_FLOATtotal slit height
units="metre"

exponent="?"

phaseNX_FLOATchopper phase angle
units="radians"

exponent="?"

ratioNX_INTpulse reduction factor of this chopper in relation to other choppers/fastest pulse in the instrument
distanceNX_FLOATEffective distance to the origin
units="metre"

exponent="?"

wavelength_rangeNX_FLOAT[2]low and high values of wavelength range transmitted
units="metre"

exponent="?"

geometryNXgeometryPosition and orientation of chopper

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of chopper along beam path

NXinstrument continued (4)

Name Type Description Attributes
{Name of beamline aperture}NXaperture

NXaperture

Name Type Description Attributes
materialNX_CHARAbsorbing material of the aperture
descriptionNX_CHARDescription of aperture
geometryNXgeometryPosition and orientation of aperture

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of aperture along beam path

NXinstrument continued (5)

Name Type Description Attributes
{Name of monitor}NXmonitor

NXmonitor

Name Type Description Attributes
typeNX_CHAR
modeNX_CHAR
presetNX_FLOATpreset value for time or monitor
distanceNX_FLOATDistance of monitor from sample position
units="metre"

exponent="?"

efficiencyNxdataMonitor efficiency as a function of wavelength
sampled_fractionNX_FLOATProportion of incident beam sampled by the monitor
units="dimensionless"
geometryNXgeometryPosition and orientation of monitor

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of monitor along beam path

NXinstrument continued (6)

Name Type Description Attributes
{Name of supermirror}NXmirror

NXmirror

Name Type Description Attributes
descriptionNX_CHAR
incident_angleNX_FLOAT
reflectivityNXdataReflectivity as function of wavelength
bend_angle_xNX_FLOAT
bend_angle_yNX_FLOAT
interior_atmosphereNX_CHAR
external_materialNX_CHARexternal material outside substrate
m_valueNX_FLOAT
substrate_materialNX_CHAR
substrate_thicknessNX_FLOAT
coating_materialNX_CHAR
substrate_roughnessNX_FLOAT
coating_roughnessNX_FLOAT
geometryNXgeometryPosition and orientation of mirror

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of aperture along beam path

NXinstrument continued (7)

Name Type Description Attributes
{Name of supermirror}NXpolarizer

NXpolarizer

Name Type Description Attributes
descriptionNX_CHAR
incident_angleNX_FLOAT
reflectivityNXdataReflectivity as function of wavelength
bend_angle_xNX_FLOAT
bend_angle_yNX_FLOAT
interior_atmosphereNX_CHAR
external_materialNX_CHARexternal material outside substrate
m_valueNX_FLOAT
substrate_materialNX_CHAR
substrate_thicknessNX_FLOAT
coating_materialNX_CHAR
substrate_roughnessNX_FLOAT
coating_roughnessNX_FLOAT
geometryNXgeometryPosition and orientation of polariser

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of aperture along beam path

NXinstrument continued (8)

Name Type Description Attributes
{Name of flipper}NXflipper

NXflipper

Name Type Description Attributes
typeNX_CHARcoil|current-sheet
flip_turnsNX_FLOATNumber of turns/cm in flipping field coils
comp_turnsNX_FLOATNumber of turns/cm in compensating field coils
guide_turnsNX_FLOATNumber of turns/cm in guide field coils
flip_currentNX_FLOATFlipping field coil current in "on" state"
units="amperes"
comp_currentNX_FLOATCompensating field coil current in "on" state"
units="amperes"
guide_currentNX_FLOATGuide field coil current in "on" state"
units="amperes"
thicknessNX_FLOATthickness along path of neutron travel
units="cm"
geometryNXgeometryPosition and orientation of flipper

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of aperture along beam path

NXinstrument continued (9)

Name Type Description Attributes
{Name of detector bank}NXdetector

NXdetector

Name Type Description Attributes
time_of_flightNX_FLOAT[j+1]Total time of flight
axis="1"

primary="1?"
long_name="{Axis label}"
units="10^-6 second|10^-7 second"
link="{absolute path to location in NXdetector}"

detector_numberNX_INT[i]Identifier for detector
axis="2"

primary="1?"
long_name="{Axis label}"
link="{absolute path to location in NXdetector}"

dataNX_FLOAT[i,j,k?,l?]|NX_INT[i,j,k?,l?]Data values
signal="1"

axes="[time_of_flight,detector_number,x_offset?,y_offset?]?"
long_name="{Title of measurement}?"
check_sum="{Integral of data as check of data integrity} (NX_INT)?"
units="number"
link="{absolute path to location in NXdetector}"

data_errorNX_FLOAT[i,j,k?,l?]|NX_INT[i,j,k?,l?]Data values
units="number"

link="{absolute path to location in NXdetector}"

x_offsetNX_FLOAT[k+1]offset from the detector center in x-direction
axis="3"

primary="1?"
units="10^-3 meter|10^-2 meter"
long_name="{Axis label}"
link="{absolute path to location in NXdetector}"

y_offsetNX_FLOAT[l+1]offset from the detector center in the y-direction
axis="4"

primary="1?"
units="10^-3 meter|10^-2 meter"
long_name="{Axis label}"
link="{absolute path to location in NXdetector}"

distanceNX_FLOAT[j,k?,l?]
axes="detector_number,x_offset?,y_offset?"
polar_angleNX_FLOAT[j,k?,l?]
axes="detector_number,x_offset?,y_offset?"
azimuthal_angleNX_FLOAT[j,k?,l?]
axes="detector_number,x_offset?,y_offset?"
descriptionNX_CHARname/manufacturer/model/etc. information
NXgeometryPosition and orientation of detector element
translationNX_FLOAT[2]translation normal to direct beam
units="centimeter"
solid_angleNX_FLOAT[i]Solid angle subtended by the detector at the sample
units="steradians"
x_pixelsizeNX_FLOAT[i?]Size of each detector pixel. If it is scalar all pixels are the same size
units="mili*metre"
y_pixelsizeNX_FLOAT[i?]Size of each detector pixel. If it is scalar all pixels are the same size
units="mili*metre"
dead_timeNX_FLOAT[i]Detector dead time
hold_offNX_FLOAT[i]Delay in detector registering an event
units="micro.second"
gas_pressureNX_FLOAT[i]Detector gas pressure
units="bars"
detection_gas_pathNX_FLOATmaximum drift space dimension
units="cm"
crateNX_INT[i]Crate number of detector
local_name="{Equivalent local term}"
slotNX_INT[i]Slot number of detector
local_name="{Equivalent local term}"
inputNX_INT[i]Input number of detector
local_name="{Equivalent local term}"
typeNX_CHAR
efficiencyNXdataEfficiency of detector with respect to e.g. wavelength
calibration_dateISO 8601date of last calibration (geometry and/or efficiency) measurements
calibration_methodNXnotesummary of conversion of array data to pixels (e.g. polynomial approximations) and location of details of the calibrations
geometryNXgeometryPosition and orientation of aperture

NXgeometry

Name Type Description Attributes
?NXtranslation

NXtranslation

Name Type Description Attributes
valueNX_FLOAT[3](x,y,z) position coordinates relative to origin at sample position
units="metre"

exponent="?"

NXgeometry continued (1)

Name Type Description Attributes
?NXorientation

NXorientation

Name Type Description Attributes
valueNX_FLOAT[6]The orientation information is stored as direction cosines relative to origin at sample position.

NXgeometry continued (2)

Name Type Description Attributes
{name of shape}NXshape

NXshape

Name Type Description Attributes
shapeNX_CHAR"nxcylinder", "nxbox", "nxsphere", ...
sizeNX_FLOAT[nshapepar] nshapepar dimensions for selected shape
units="metre"

exponent="?"

NXgeometry continued (3)

Name Type Description Attributes
component_indexNX_INTSequential order of aperture along beam path

Retrieved from "http://www.nexusformat.org/Time-of-Flight_Neutron_Reflectometry"
Personal tools