3.3.45. NXsubentry

Status:

base class, extends NXobject, version 1.0

Description:

NXsubentry is a base class virtually identical to NXentry and is used as the (overlay) location for application definitions. Use a separate NXsubentry for each application definition.

To use NXsubentry with a hypothetical application definition called NXmyappdef:

• Create a group with attribute NX_class="NXsubentry"
• Within that group, create a field called definition="NXmyappdef".
• There are two optional attributes of definition: version and URL

The intended use is to define application definitions for a multi-technique NXentry. Previously, an application definition replaced NXentry with its own definition. With the increasing popularity of instruments combining multiple techniques for data collection (such as SAXS/WAXS instruments), it was recognized the application definitions must be entered in the NeXus data file tree as children of NXentry.

Symbols:

No symbol table

Groups cited:

NXcharacterization, NXcollection, NXdata, NXinstrument, NXmonitor, NXnote, NXparameters, NXprocess, NXsample, NXuser

Structure:

@IDF_Version: NX_CHAR

ISIS Muon IDF_Version

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.

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

Official NeXus NXDL schema to which this file conforms

@version: NX_CHAR

NXDL version number

@URL: NX_CHAR

URL of NXDL file

definition_local: NX_CHAR

Local NXDL schema extended from the file specified in the definition field. This contains any locally-defined, additional fields in the file.

@version: NX_CHAR

NXDL version number

@URL: NX_CHAR

URL of NXDL file

start_time: NX_DATE_TIME

Starting time of measurement

end_time: NX_DATE_TIME

Ending time of measurement

duration: NX_INT {units=NX_TIME}

Duration of measurement

collection_time: NX_FLOAT {units=NX_TIME}

Time transpired actually collecting data i.e. taking out time when collection was suspended due to e.g. temperature out of range

run_cycle: NX_CHAR

Such as “2007-3”. Some user facilities organize their beam time into run cycles.

program_name: NX_CHAR

Name of program used to generate this file

@version: NX_CHAR

Program version number

@configuration: NX_CHAR

configuration of the program

revision: NX_CHAR

Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ...

@comment: NX_CHAR

pre_sample_flightpath: NX_FLOAT {units=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.

experiment_documentation: NXnote

Description of the full experiment (document in pdf, latex, ...)

notes: NXnote

Notes describing entry

thumbnail: 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.

@mime_type: NX_CHAR

The value should be an image/*

Obligatory value: image/*

(characterization): NXcharacterization

(user): NXuser

(sample): NXsample

(instrument): NXinstrument

(collection): NXcollection

(monitor): NXmonitor

(data): NXdata

(parameters): NXparameters

(process): NXprocess

Source:

Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXsubentry.nxdl.xml