NXdetector

From NeXus

Jump to: navigation, search

Contents

XML Meta-DTD Definition for NXdetector.xml

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

<?xml version="1.0" encoding="UTF-8"?>
<!--
	URL:     http://www.nexusformat.org/NXdetector
	Editor:  NIAC
	$Id: NXdetector.xml 40 2007-09-26 12:07:38Z Pete Jemian $
	
	Template of a detector, detector bank, or multidetector. The indices
	require explanation:
	np - the number of points in a scan. This dimension is only present
	in scanning measurements.
	tof - the number of points in a time-of-flight axis. This is only present
	in time-of-flight measurements.
	i - the number of pixels in the slowest varying direction. This is
	only present in missing in the point detector. 
	j - the number of pixels in the fastest varying direction. This
	exists only in "area" detectors.
	
	HOUSEKEEPING:
	- remove all question marks
	- fix units
	- polar, azimuthal, distance, and wavelength need description
	- remove generic attributes
-->
<NXdetector name="{Name of detector bank}">
	<time_of_flight type="NX_FLOAT[tof+1]" axis="3" 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>
	<raw_time_of_flight type="NX_INT[tof+1]" units="clock_pulses"
		frequency="NX_FLOAT:{Clock frequency in Hz}">
		{In DAQ clock pulses}
	</raw_time_of_flight>
	<detector_number type="NX_INT[i?,j?]">
		{Identifier for detector}?
	</detector_number>
	<data type="NX_FLOAT[np?,i?,j?,tof?]|NX_INT[np?,i?,j?,tof?]"
		signal="1"
		axes="[number of scan points,x_offset?,y_offset?,time_of_flight?]?"
		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[np?,i?,j?,tof?]|NX_INT[np?,i?,j?,tof?]"
		units="number" link="{absolute path to location in NXdetector}">
		{Data values}
	</data_error>
	<x_pixel_offset axis="1" primary="1?" type="NX_FLOAT[i?]"
		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_pixel_offset>
	<y_pixel_offset axis="2" primary="1?" type="NX_FLOAT[j?]"
		units="10-3 meter|10-2 meter" long_name="{Axis label}">
		{offset from the detector center in the y-direction}?
	</y_pixel_offset>
	<distance type="NX_FLOAT[np?,i?,j?]"></distance>
	<polar_angle type="NX_FLOAT[np?,i?,j?"></polar_angle>
	<azimuthal_angle type="NX_FLOAT[np?,i?,j?]"></azimuthal_angle>
	<description type="NX_CHAR">
		{name/manufacturer/model/etc. information}?
	</description>
	<NXgeometry name="">
		{Position and orientation of detector element}?
	</NXgeometry>
	<solid_angle type="NX_FLOAT[i?,j?]" units="steradians">
		{Solid angle subtended by the detector at the sample}?
	</solid_angle>
	<x_pixel_size type="NX_FLOAT[i?,j?]" units="mili*metre">
		{Size of each detector pixel. If it is scalar all pixels are the
		same size}?
	</x_pixel_size>
	<y_pixel_size type="NX_FLOAT[i?,j?]" units="mili*metre">
		{Size of each detector pixel. If it is scalar all pixels are the
		same size}?
	</y_pixel_size>
	<dead_time type="NX_FLOAT[np?,i,j?]">
		{Detector dead time}?
	</dead_time>
	<gas_pressure type="NX_FLOAT[i?,j?]" 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?,j?]" local_name="{Equivalent local term}">
		{Crate number of detector}?
	</crate>
	<slot type="NX_INT[i?,j?]" local_name="{Equivalent local term}">
		{Slot number of detector}?
	</slot>
	<input type="NX_INT[i?,j?]" local_name="{Equivalent local term}">
		{Input number of detector}?
	</input>
	<type type="NX_CHAR">
		{Description of type such as He3 gas cylinder, He3 PSD,
		scintillator, fission chamber, proportion counter, 
		ion chamber, ccd, pixel, image plate, cmos, ...}
	</type>
	<NXdata name="efficiency">
		{Efficiency of detector with respect to e.g. wavelength}
		<efficiency type="NX_FLOAT[i?,j?,k?]" units="">
			{efficiency of the detector}
		</efficiency>
		<wavelength type="NX_FLOAT[i?,j?,k?]" units="" />
	</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>
	<layout type="NX_CHAR">
		point|linear|area{How the detector is represented}
	</layout>
	<count_time type="NX_INT[np?]|NX_FLOAT[np?]" units="">
		{Elapsed actual counting time}
	</count_time>
	<NXnote name="data_file" />
	<NXcharacterization name="{name of the characterization}" />

</NXdetector>

Tabular Representation of XML Meta-DTD

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

NXdetector

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

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

raw_time_of_flightNX_INT[tof+1]In DAQ clock pulses
units="clock_pulses"

frequency="NX_FLOAT:{Clock frequency in Hz}"

detector_numberNX_INT[i?,j?]Identifier for detector
dataNX_FLOAT[np?,i?,j?,tof?]|NX_INT[np?,i?,j?,tof?]Data values
signal="1"

axes="[number of scan points,x_offset?,y_offset?,time_of_flight?]?"
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[np?,i?,j?,tof?]|NX_INT[np?,i?,j?,tof?]Data values
units="number"

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

x_pixel_offsetNX_FLOAT[i?]offset from the detector center in x-direction
axis="1"

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

y_pixel_offsetNX_FLOAT[j?]offset from the detector center in the y-direction
axis="2"

primary="1?"
units="10-3 meter|10-2 meter"
long_name="{Axis label}"

distanceNX_FLOAT[np?,i?,j?]
polar_angleNX_FLOAT[np?,i?,j?
azimuthal_angleNX_FLOAT[np?,i?,j?]
descriptionNX_CHARname/manufacturer/model/etc. information
NXgeometryPosition and orientation of detector element
solid_angleNX_FLOAT[i?,j?]Solid angle subtended by the detector at the sample
units="steradians"
x_pixel_sizeNX_FLOAT[i?,j?]Size of each detector pixel. If it is scalar all pixels are the same size
units="mili*metre"
y_pixel_sizeNX_FLOAT[i?,j?]Size of each detector pixel. If it is scalar all pixels are the same size
units="mili*metre"
dead_timeNX_FLOAT[np?,i,j?]Detector dead time
gas_pressureNX_FLOAT[i?,j?]Detector gas pressure
units="bars"
detection_gas_pathNX_FLOATmaximum drift space dimension
units="cm"
crateNX_INT[i?,j?]Crate number of detector
local_name="{Equivalent local term}"
slotNX_INT[i?,j?]Slot number of detector
local_name="{Equivalent local term}"
inputNX_INT[i?,j?]Input number of detector
local_name="{Equivalent local term}"
typeNX_CHARDescription of type such as He3 gas cylinder, He3 PSD, scintillator, fission chamber, proportion counter, ion chamber, ccd, pixel, image plate, cmos, ...
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
layoutNX_CHAR
count_timeNX_INT[np?]|NX_FLOAT[np?]Elapsed actual counting time
units=""
data_fileNXnote
{name of the characterization}NXcharacterization

Retrieved from "http://www.nexusformat.org/NXdetector"
Personal tools