.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXentry.nxdl.xml .. index:: ! NXentry (base class) ! entry (base class) see: entry (base class); NXentry .. _NXentry: ======= NXentry ======= **Status**: base class, extends :ref:`NXobject`, version 1.0 **Description**: (**required**) :ref:`NXentry` describes the measurement. 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. **Symbols**: No symbol table **Groups cited**: :ref:`NXcharacterization`, :ref:`NXcollection`, :ref:`NXdata`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXnote`, :ref:`NXparameters`, :ref:`NXprocess`, :ref:`NXsample`, :ref:`NXsubentry`, :ref:`NXuser` .. index:: NXdata (base class); used in base class, NXnote (base class); used in base class, NXcharacterization (base class); used in base class, NXuser (base class); used in base class, NXsample (base class); used in base class, NXinstrument (base class); used in base class, NXcollection (base class); used in base class, NXmonitor (base class); used in base class, NXparameters (base class); used in base class, NXprocess (base class); used in base class, NXsubentry (base class); used in base class **Structure**: .. index:: default (file attribute) **@default**: :ref:`NX_CHAR ` .. index:: plotting Declares which :ref:`NXdata` (or :ref:`NXsubentry`) group contains the data to be shown by default. It is needed to resolve ambiguity when more than one :ref:`NXdata` group exists. The value is the name of the default :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See http://wiki.nexusformat.org/2014_How_to_find_default_data for a summary of the discussion. .. index:: IDF Version (file attribute) **@IDF_Version**: :ref:`NX_CHAR ` ISIS Muon IDF_Version .. index:: title (field) **title**: :ref:`NX_CHAR ` Extended title for entry .. index:: experiment identifier (field) **experiment_identifier**: :ref:`NX_CHAR ` Unique identifier for the experiment, defined by the facility, possibly linked to the proposals .. index:: experiment description (field) **experiment_description**: :ref:`NX_CHAR ` Brief summary of the experiment, including key objectives. .. index:: collection identifier (field) **collection_identifier**: :ref:`NX_CHAR ` User or Data Acquisition defined group of NeXus files or NXentry .. index:: collection description (field) **collection_description**: :ref:`NX_CHAR ` Brief summary of the collection, including grouping criteria. .. index:: entry identifier (field) **entry_identifier**: :ref:`NX_CHAR ` unique identifier for the measurement, defined by the facility. .. index:: features (field) **features**: :ref:`NX_CHAR ` Reserved for furture use by NIAC. See https://github.com/nexusformat/definitions/issues/382 .. index:: definition (field) **definition**: :ref:`NX_CHAR ` (alternate use: see same field in :ref:`NXsubentry` for preferred) Official NeXus NXDL schema to which this entry conforms. This field is provided so that :ref:`NXentry` can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes. *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position. .. index:: version (field attribute) **@version**: :ref:`NX_CHAR ` NXDL version number .. index:: URL (field attribute) **@URL**: :ref:`NX_CHAR ` URL of NXDL file .. index:: definition local (field) **definition_local**: :ref:`NX_CHAR ` .. index:: deprecated **DEPRECATED**: see same field in :ref:`NXsubentry` for preferred use Local NXDL schema extended from the entry specified in the ``definition`` field. This contains any locally-defined, additional fields in the entry. .. index:: version (field attribute) **@version**: :ref:`NX_CHAR ` NXDL version number .. index:: URL (field attribute) **@URL**: :ref:`NX_CHAR ` URL of NXDL file .. index:: start time (field) **start_time**: :ref:`NX_DATE_TIME ` Starting time of measurement .. index:: end time (field) **end_time**: :ref:`NX_DATE_TIME ` Ending time of measurement .. index:: duration (field) **duration**: :ref:`NX_INT ` {units=\ :ref:`NX_TIME `} Duration of measurement .. index:: collection time (field) **collection_time**: :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME `} Time transpired actually collecting data i.e. taking out time when collection was suspended due to e.g. temperature out of range .. index:: run cycle (field) **run_cycle**: :ref:`NX_CHAR ` Such as "2007-3". Some user facilities organize their beam time into run cycles. .. index:: program name (field) **program_name**: :ref:`NX_CHAR ` Name of program used to generate this file .. index:: version (field attribute) **@version**: :ref:`NX_CHAR ` Program version number .. index:: configuration (field attribute) **@configuration**: :ref:`NX_CHAR ` configuration of the program .. index:: revision (field) **revision**: :ref:`NX_CHAR ` Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ... .. index:: comment (field attribute) **@comment**: :ref:`NX_CHAR ` .. index:: pre sample flightpath (field) **pre_sample_flightpath**: :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} This is the flightpath before the sample position. This can be determined by a chopper, by the moderator or the source itself. In other words: it the distance to the component which gives the T0 signal to the detector electronics. If another component in the NXinstrument hierarchy provides this information, this should be a link. **(data)**: :ref:`NXdata` The required data group **experiment_documentation**: :ref:`NXnote` Description of the full experiment (document in pdf, latex, ...) **notes**: :ref:`NXnote` Notes describing entry **thumbnail**: :ref:`NXnote` A 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. .. index:: type (group attribute) **@type**: :ref:`NX_CHAR ` The mime type should be an ``image/*`` Obligatory value: ``image/*`` **(characterization)**: :ref:`NXcharacterization` **(user)**: :ref:`NXuser` **(sample)**: :ref:`NXsample` **(instrument)**: :ref:`NXinstrument` **(collection)**: :ref:`NXcollection` **(monitor)**: :ref:`NXmonitor` **(parameters)**: :ref:`NXparameters` **(process)**: :ref:`NXprocess` **(subentry)**: :ref:`NXsubentry` **NXDL Source**: https://github.com/nexusformat/definitions/blob/master/base_classes/NXentry.nxdl.xml