NXentry
From NeXus
Contents |
XML Meta-DTD Definition for NXentry.xml
This follows the XML Meta-DTD Definition format and can be downloaded from http://svn.nexusformat.org/definitions/tags/PRE_NXDL/base_classes/NXentry.xml
<?xml version="1.0" encoding="UTF-8"?>
<!--
URL: http://www.nexus.anl.gov/classes/xml/NXentry.xml
Editor: NIAC
$Id: NXentry.xml 43 2007-09-26 12:52:42Z L.lerusse $
Template of the top-level NeXus group which contains all the data and
associated information that comprise a single measurement. It is mandatory that there is at least one group of this type in the NeXus file.
-->
<NXentry name="{Entry Name}">
<title>{Extended title for entry}?</title>
<experiment_identifier type="NX_CHAR[]">
{Unique identifier for the experiment, defined by the facility, possibly linked to the proposals}?
</experiment_identifier>
<experiment_description type="NX_CHAR">
{Brief summary of the experiment, including key objectives.}?
</experiment_description>
<experiment_documentation type="NXNote">
{Description of the full experiment (document in pdf, latex, …)}?
</experiment_documentation>
<collection_identifier type="NX_CHAR">
{User or Data Acquisition defined group of NeXus files or NXentry}?
</collection_identifier>
<collection_description type="NX_CHAR">
{Brief summary of the collection, including grouping criteria.}?
</collection_description>
<entry_identifier type="NX_CHAR">
{unique identifier for the measurement, defined by the facility.}?
</entry_identifier>
<definition version="{DTD version number}" URL="{URL of DTD file}">
{Name of entry DTD}?
</definition>
<definition_local type="NX_CHAR" version="{DTD version number}" URL="{URL of DTD file}">
{Name of entry DTD}?
</definition_local>
<start_time type="ISO8601">
{Starting time of measurement}?
</start_time>
<end_time type="ISO8601">
{Ending time of measurement}?
</end_time>
<duration type="NX_INT" units="seconds">
{Duration of measurement}?
</duration>
<collection_time type="NX_FLOAT" units="seconds">
{Time transpired actually collecting data i.e. taking out time when
collection was suspended due to e.g. temperature out of range}?
</collection_time>
<run_cycle type="NX_CHAR[]">
{}?
</run_cycle>
<program_name version="{Program version number}" configuration="{configuration of the program}">
{Name of program used to generate this file}?
</program_name>
<revision type="NX_CHAR" comment="">
{ Revision id of the file due to re-calibration, reprocessing,
new analysis, new instrument definition format, ... }
</revision>
<notes>
{Notes describing entry}?
</notes>
<thumbnail type="NXnote" mime_type="{image/*}">
{An small image that is representative of the entry.} {An example of this is a 640x480 jpeg image automatically produced by a low resolution plot of the NXdata.}?
</thumbnail>
<NXcharacterizations>
?
</NXcharacterizations>
<NXuser name="{user}">
*
</NXuser>
<NXsample name="{sample}">
?
</NXsample>
<NXinstrument name="{Name of instrument}">
?
</NXinstrument>
<NXmonitor name="{Name of monitor}">
*
</NXmonitor>
<NXdata name="{Name of data block}">
*
</NXdata>
<NXprocess name="{Name of the process}">
?
</NXprocess>
</NXentry>
Tabular Representation of XML Meta-DTD
(automatically generated from http://svn.nexusformat.org/definitions/tags/PRE_NXDL/base_classes/NXentry.xml)
-
NXentry
Name Type Description Attributes title NX_CHAR Extended title for entry experiment_identifier NX_CHAR[] Unique identifier for the experiment, defined by the facility, possibly linked to the proposals experiment_description NX_CHAR Brief summary of the experiment, including key objectives. experiment_documentation NXNote Description of the full experiment (document in pdf, latex, …) collection_identifier NX_CHAR User or Data Acquisition defined group of NeXus files or NXentry collection_description NX_CHAR Brief summary of the collection, including grouping criteria. entry_identifier NX_CHAR unique identifier for the measurement, defined by the facility. definition NX_CHAR Name of entry DTD version="{DTD version number}"
URL="{URL of DTD file}"
definition_local NX_CHAR Name of entry DTD version="{DTD version number}"
URL="{URL of DTD file}"
start_time ISO 8601 Starting time of measurement end_time ISO 8601 Ending time of measurement duration NX_INT Duration of measurement units="seconds"
collection_time NX_FLOAT Time transpired actually collecting data i.e. taking out time when collection was suspended due to e.g. temperature out of range units="seconds"
run_cycle NX_CHAR[] program_name NX_CHAR Name of program used to generate this file version="{Program version number}"
configuration="{configuration of the program}"
revision NX_CHAR Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ... comment=""
notes NX_CHAR Notes describing entry thumbnail NXnote An small image that is representative of the entry.
{An example of this is a 640x480 jpeg image automatically produced by a low resolution plot of the NXdata.}mime_type="{image/*}"
NXcharacterizations NX_CHAR {user} NXuser {sample} NXsample {Name of instrument} NXinstrument {Name of monitor} NXmonitor {Name of data block} NXdata {Name of the process} NXprocess
