.. 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` **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:`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, 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**: .. _/NXentry@default-attribute: .. index:: default (file attribute) **@default**: (optional) :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. .. [#] NIAC2014 discussion summary: https://www.nexusformat.org/2014_How_to_find_default_data.html .. _/NXentry@IDF_Version-attribute: .. index:: IDF_Version (file attribute) **@IDF_Version**: (optional) :ref:`NX_CHAR ` ISIS Muon IDF_Version .. _/NXentry/title-field: .. index:: title (field) **title**: (optional) :ref:`NX_CHAR ` Extended title for entry .. _/NXentry/experiment_identifier-field: .. index:: experiment_identifier (field) **experiment_identifier**: (optional) :ref:`NX_CHAR ` Unique identifier for the experiment, defined by the facility, possibly linked to the proposals .. _/NXentry/experiment_description-field: .. index:: experiment_description (field) **experiment_description**: (optional) :ref:`NX_CHAR ` Brief summary of the experiment, including key objectives. .. _/NXentry/collection_identifier-field: .. index:: collection_identifier (field) **collection_identifier**: (optional) :ref:`NX_CHAR ` User or Data Acquisition defined group of NeXus files or NXentry .. _/NXentry/collection_description-field: .. index:: collection_description (field) **collection_description**: (optional) :ref:`NX_CHAR ` Brief summary of the collection, including grouping criteria. .. _/NXentry/entry_identifier-field: .. index:: entry_identifier (field) **entry_identifier**: (optional) :ref:`NX_CHAR ` Unique identifier for the measurement, defined by the facility. .. _/NXentry/entry_identifier_uuid-field: .. index:: entry_identifier_uuid (field) **entry_identifier_uuid**: (optional) :ref:`NX_CHAR ` UUID identifier for the measurement. .. _/NXentry/entry_identifier_uuid@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` Version of UUID used .. _/NXentry/features-field: .. index:: features (field) **features**: (optional) :ref:`NX_CHAR ` Reserved for future use by NIAC. See https://github.com/nexusformat/definitions/issues/382 .. _/NXentry/definition-field: .. index:: definition (field) **definition**: (optional) :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. .. _/NXentry/definition@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` NXDL version number .. _/NXentry/definition@URL-attribute: .. index:: URL (field attribute) **@URL**: (optional) :ref:`NX_CHAR ` URL of NXDL file .. _/NXentry/definition_local-field: .. index:: definition_local (field) **definition_local**: (optional) :ref:`NX_CHAR ` Local NXDL schema extended from the entry specified in the ``definition`` field. This contains any locally-defined, additional fields in the entry. .. _/NXentry/definition_local@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` NXDL version number .. _/NXentry/definition_local@URL-attribute: .. index:: URL (field attribute) **@URL**: (optional) :ref:`NX_CHAR ` URL of NXDL file .. _/NXentry/start_time-field: .. index:: start_time (field) **start_time**: (optional) :ref:`NX_DATE_TIME ` Starting time of measurement .. _/NXentry/end_time-field: .. index:: end_time (field) **end_time**: (optional) :ref:`NX_DATE_TIME ` Ending time of measurement .. _/NXentry/duration-field: .. index:: duration (field) **duration**: (optional) :ref:`NX_INT ` {units=\ :ref:`NX_TIME `} Duration of measurement .. _/NXentry/collection_time-field: .. index:: collection_time (field) **collection_time**: (optional) :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 .. _/NXentry/run_cycle-field: .. index:: run_cycle (field) **run_cycle**: (optional) :ref:`NX_CHAR ` Such as '2007-3'. Some user facilities organize their beam time into run cycles. .. _/NXentry/program_name-field: .. index:: program_name (field) **program_name**: (optional) :ref:`NX_CHAR ` Name of program used to generate this file .. _/NXentry/program_name@version-attribute: .. index:: version (field attribute) **@version**: (optional) :ref:`NX_CHAR ` Program version number .. _/NXentry/program_name@configuration-attribute: .. index:: configuration (field attribute) **@configuration**: (optional) :ref:`NX_CHAR ` configuration of the program .. _/NXentry/revision-field: .. index:: revision (field) **revision**: (optional) :ref:`NX_CHAR ` Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ... .. _/NXentry/revision@comment-attribute: .. index:: comment (field attribute) **@comment**: (optional) :ref:`NX_CHAR ` .. _/NXentry/pre_sample_flightpath-field: .. index:: pre_sample_flightpath (field) **pre_sample_flightpath**: (optional) :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. .. _/NXentry/experiment_location-field: .. index:: experiment_location (field) **experiment_location**: (optional) :ref:`NX_CHAR ` City and country where the experiment took place .. _/NXentry/experiment_start_date-field: .. index:: experiment_start_date (field) **experiment_start_date**: (optional) :ref:`NX_DATE_TIME ` Start time of experimental run that includes the current measurement, for example a beam time. .. _/NXentry/experiment_end_date-field: .. index:: experiment_end_date (field) **experiment_end_date**: (optional) :ref:`NX_DATE_TIME ` End time of experimental run that includes the current measurement, for example a beam time. .. _/NXentry/experiment_institution-field: .. index:: experiment_institution (field) **experiment_institution**: (optional) :ref:`NX_CHAR ` Name of the institution hosting the facility .. _/NXentry/experiment_facility-field: .. index:: experiment_facility (field) **experiment_facility**: (optional) :ref:`NX_CHAR ` Name of the experimental facility .. _/NXentry/experiment_laboratory-field: .. index:: experiment_laboratory (field) **experiment_laboratory**: (optional) :ref:`NX_CHAR ` Name of the laboratory or beamline .. _/NXentry/DATA-group: **DATA**: (optional) :ref:`NXdata` The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissable to omit the NXdata group only when defining the default plot is not practical or possible from the available data. For example, neutron event data may not have anything that makes a useful plot without extensive processing. Certain application definitions override this decision and require an :ref:`NXdata` group in the :ref:`NXentry` group. The ``minOccurs=0`` attribute in the application definition will indicate the :ref:`NXdata` group is optional, otherwise, it is required. .. [#] NIAC2016: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16 .. _/NXentry/experiment_documentation-group: **experiment_documentation**: (optional) :ref:`NXnote` Description of the full experiment (document in pdf, latex, ...) .. _/NXentry/notes-group: **notes**: (optional) :ref:`NXnote` Notes describing entry .. _/NXentry/thumbnail-group: **thumbnail**: (optional) :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. .. _/NXentry/thumbnail@type-attribute: .. index:: type (group attribute) **@type**: (optional) :ref:`NX_CHAR ` The mime type should be an ``image/*`` Obligatory value: ``image/*`` .. _/NXentry/USER-group: **USER**: (optional) :ref:`NXuser` .. _/NXentry/SAMPLE-group: **SAMPLE**: (optional) :ref:`NXsample` .. _/NXentry/INSTRUMENT-group: **INSTRUMENT**: (optional) :ref:`NXinstrument` .. _/NXentry/COLLECTION-group: **COLLECTION**: (optional) :ref:`NXcollection` .. _/NXentry/MONITOR-group: **MONITOR**: (optional) :ref:`NXmonitor` .. _/NXentry/PARAMETERS-group: **PARAMETERS**: (optional) :ref:`NXparameters` .. _/NXentry/PROCESS-group: **PROCESS**: (optional) :ref:`NXprocess` .. _/NXentry/SUBENTRY-group: **SUBENTRY**: (optional) :ref:`NXsubentry` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXentry/COLLECTION-group ` * :ref:`/NXentry/collection_description-field ` * :ref:`/NXentry/collection_identifier-field ` * :ref:`/NXentry/collection_time-field ` * :ref:`/NXentry/DATA-group ` * :ref:`/NXentry/definition-field ` * :ref:`/NXentry/definition@URL-attribute ` * :ref:`/NXentry/definition@version-attribute ` * :ref:`/NXentry/definition_local-field ` * :ref:`/NXentry/definition_local@URL-attribute ` * :ref:`/NXentry/definition_local@version-attribute ` * :ref:`/NXentry/duration-field ` * :ref:`/NXentry/end_time-field ` * :ref:`/NXentry/entry_identifier-field ` * :ref:`/NXentry/entry_identifier_uuid-field ` * :ref:`/NXentry/entry_identifier_uuid@version-attribute ` * :ref:`/NXentry/experiment_description-field ` * :ref:`/NXentry/experiment_documentation-group ` * :ref:`/NXentry/experiment_end_date-field ` * :ref:`/NXentry/experiment_facility-field ` * :ref:`/NXentry/experiment_identifier-field ` * :ref:`/NXentry/experiment_institution-field ` * :ref:`/NXentry/experiment_laboratory-field ` * :ref:`/NXentry/experiment_location-field ` * :ref:`/NXentry/experiment_start_date-field ` * :ref:`/NXentry/features-field ` * :ref:`/NXentry/INSTRUMENT-group ` * :ref:`/NXentry/MONITOR-group ` * :ref:`/NXentry/notes-group ` * :ref:`/NXentry/PARAMETERS-group ` * :ref:`/NXentry/pre_sample_flightpath-field ` * :ref:`/NXentry/PROCESS-group ` * :ref:`/NXentry/program_name-field ` * :ref:`/NXentry/program_name@configuration-attribute ` * :ref:`/NXentry/program_name@version-attribute ` * :ref:`/NXentry/revision-field ` * :ref:`/NXentry/revision@comment-attribute ` * :ref:`/NXentry/run_cycle-field ` * :ref:`/NXentry/SAMPLE-group ` * :ref:`/NXentry/start_time-field ` * :ref:`/NXentry/SUBENTRY-group ` * :ref:`/NXentry/thumbnail-group ` * :ref:`/NXentry/thumbnail@type-attribute ` * :ref:`/NXentry/title-field ` * :ref:`/NXentry/USER-group ` * :ref:`/NXentry@default-attribute ` * :ref:`/NXentry@IDF_Version-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXentry.nxdl.xml