3.3.1.118. NXobject¶
Status:
base class, extends none
Description:
This is the base object of NeXus. Its NeXus groups and fields are inherited …
This is the base object of NeXus. Its NeXus groups and fields are inherited by every class that extends it.
If nameType=”partial”, the placeholders (e.g., FIELDNAME or GROUPNAME) can be replaced by the name of any object (field or group, respectively) that exists within the same group.
Symbols:
No symbol table
- Groups cited:
Structure:
@default: (optional) NX_CHAR
Declares which child group contains a path leading …
Declares which child group contains a path leading to a NXdata group or a group using a base class extending NXdata.
It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.
@NX_class: (required) NX_CHAR
Type of the NeXus group: the name of its class. …
Type of the NeXus group: the name of its class.
Obligatory value:
NXobject@target: (optional) NX_CHAR
Absolute path of the target of this content group, for example …
Absolute path of the target of this content group, for example
/entry/instrument/detector.When the value differs from the path of this content group, this content group is a content link to the content group at that path and has the same shared content (see Links). The content group at that path is not a content link itself.
COLLECTION: (optional) NXcollection
DATA: (optional) NXdata
LOG: (optional) NXlog
NOTE: (optional) NXnote
PARAMETERS: (optional) NXparameters
GROUPNAME_log: (optional) NXlog
NXlog group containing logged values of GROUPNAME.
FIELDNAME_set: (optional) NX_NUMBER
Target values of FIELDNAME.
FIELDNAME_errors: (optional) NX_NUMBER
Uncertainties of FIELDNAME values.
FIELDNAME_weights: (optional) NX_NUMBER
Weights of FIELDNAME values.
FIELDNAME_mask: (optional) NX_BOOLEAN
Boolean mask of FIELDNAME values. The value is masked if set to 1.
identifierNAME: (optional) NX_CHAR
An identifier for a (persistent) resource. …
An identifier for a (persistent) resource.
An identifier, provided by some authority, that has been assigned to an object described by this
NXobject. To be useful, the identifier must not be reassigned to a different real-world object. It is typical for there to be some mechanism to resolve an identifier, obtaining metadata about the object. Identifiers for which some guarantees exist regarding this resolution process are called persistent identifiers. Persistent identifiers are also known as PIDs.@type: (optional) NX_CHAR
The type of identifier used. …
The type of identifier used.
It is recommended to use the most specific type when describing the identifier.
For example, all IGSNs (see below) are DOIs and all DOIs are Handles; however, an IGSN should have type IGSN (and not DOI or Hdl). Similarly, an ARK, Purl, ORCID and ROR identifiers should have their corresponding types and should not use the more generic URL identifier.
Any of these values or a custom value (if you use a custom value, also set @custom=True):
ARK: Archival Resource Key. An ARK is a Uniform Resource Identifier (URI) designed to support long-term access to a variety of information objects. Syntax: https://NMA/ark:/NAAN/Name[Qualifier]. Brackets indicate optional elements. Example: https://example.org/ark:/12345/abcde
DOI: Digital Object Identifier. A DOI is a unique alphanumeric string used to identify digital content. It consists of a prefix and a suffix, separated by a slash. Syntax: 10.XXXX/XXXXXX Example: 10.1107/S1600576714027575
Hdl: A handle is a unique identifier that consists of a prefix indicating the naming authority and a suffix representing the local name of a resource. A handle is a unique identifier used to facilitate the identification and management of digital objects. It is composed of a prefix that indicates the naming authority and a suffix that specifies the resource’s local name. This refers specifically to an ID in the Handle system operated by the Corporation for National Research Initiatives (CNRI). Syntax: prefix/identifier Example: 123456789/abc123
IGSN: International Generic Sample Number. The IGSN is a unique identifier assigned to a specific sample or specimen in the context of scientific research. Since 2021, IGSNs are issued by DataCite, meaning that there are now DataCite-issued DOIs for all IGSNs, including those historical IGSNs issued beforehand. Therefore, the syntax is the same as for DOIs. Syntax: 10.XXXX/XXXXXX Example: 10.1107/S1600576714027575
ISNI: ISNI is an ISO standard to uniquely identify individuals and organizations involved in creative work, including pseudonyms and other public personas. An ISNI-ID is made up of 16 digits, the last character being a check character. The check character may be either a decimal digit or the character “X”. A URL can be generated from the ISNI ID by combining it with the prefix https://isni.org/isni/, resulting in https://isni.org/isni/{ISNI-ID}. Syntax: 16 base-10 digits stored without any spaces. Example: 0000000121032683
ISSN: International Standard Serial Number An ISSN is an 8-digit unique identifier used to distinguish a serial publication, whether in print or electronic form. The last character (a digit or ‘X’) serves as a check character, making the ISSN uniquely defined by its first seven digits. Syntax: NNNN-NNNC, where N a decimal digit character (i.e., in the set {0,1,2,…,9}), and C is in {0,1,2,…,9,X} Example: 1234-5678 or 1234-567X
ISSN-L: Linking ISSN The linking ISSN, or ISSN-L, is a specific ISSN that groups the different media of the same serial publication. Syntax: NNNN-NNNC, where N a decimal digit character (i.e., in the set {0,1,2,…,9}), and C is in {0,1,2,…,9,X} Example: 1234-5678 or 1234-567X
ORCID: Open Researcher and Contributor identifier. ORCID provides a free and persistent identifier that uniquely distinguishes authors and contributors in scientific research. Syntax: https://orcid.org/XXXX-XXXX-XXXX-XXXX Example: https://orcid.org/0000-0002-1825-0097
PURL: Persistent Uniform Resource Locator. A Persistent Uniform Resource Locator (PURL) is a type of URL designed to provide a stable, long-term reference to a web resource by using a resolver to redirect users to the resource’s current location, even if it moves over time. A PURL has three parts: (1) a protocol, (2) a resolver address, and (3) a name. Syntax: https://purl.org/foo/bar Example: https://purl.org/dc/elements/1.1/title
ROR: Research Organization Registry A ROR ID is a globally unique identifier for research organizations, enabling unambiguous linking of institutions across systems. Syntax: https://ror.org/{ROR-ID} Example: https://ror.org/052gg0110
URL: Uniform Resource Locator Also known as web address, a URL is the address used to access a resource on the internet, specifying its location and the protocol to retrieve it. Syntax: scheme://domain:port/path?query_string#fragment_id Example: https://www.example.com/about
URN: Uniform Resource Name A URN is a unique, persistent identifier for a resource regardless of where it is stored. It is recommended that identifiers with more specific type attribute (such as DOI or ISSN) values should not be stored as a URN, even when this is valid. As an example, the URN doi:10.1107/S1600576714027575 is a valid URN-based representation for the DOI 10.1107/S1600576714027575, but it is recommended to use type=”DOI” in this case. Syntax: urn:<namespace>:<namespace-specific-string>. The leading urn: sequence is case-insensitive. Example: urn:isbn:0000000000000
Attributes of every field:
NeXus attributes that any field directly in this class may have, whether or not …
NeXus attributes that any field directly in this class may have, whether or not the class defines that field.
A NeXus attribute of the NeXus field itself takes precedence over the one with the same name defined here.
@target: (optional) NX_CHAR
Absolute path of the target of this content field, for example …
Absolute path of the target of this content field, for example
/entry/instrument/detector/data.When the value differs from the path of this content field, this content field is a content link to the content field at that path and has the same shared content (see Links). The content field at that path is not a content link itself.
@units: (optional) NX_CHAR
Units of the field values. …
Units of the field values.
See NeXus Data Units. When the NeXus field has a units category, such as
NX_LENGTH, the value of this NeXus attribute must be units of that category.@long_name: (optional) NX_CHAR
Descriptive name of the field (may include whitespace and engineering units). …
Descriptive name of the field (may include whitespace and engineering units).
Often used as the axis label on a plot.
@interpretation: (optional) NX_CHAR
What the last dimensions of the field values are, so that plotting …
What the last dimensions of the field values are, so that plotting software can display them in a natural way.
For example, a 512 x 512 x 512 field with
@interpretationset tospectrumis a 512 x 512 grid of spectra of 512 bins.Any of these values:
scalar: 0-D data
scaler: DEPRECATED, usescalar
spectrum: 1-D data
image: 2-D data
rgb-image: 3-D data
rgba-image: 3-D data
hsl-image: 3-D data
hsla-image: 3-D data
cmyk-image: 3-D data
vertex: 3-D data@calibration_status: (optional) NX_CHAR
Status of the field values. …
Status of the field values.
Any of these values:
Nominal|Measured@stride: (optional) NX_INT
Step between the stored values in each dimension, one value per dimension, …
Step between the stored values in each dimension, one value per dimension, when the values are not stored in C order (see Non C Storage Order). Used together with
data_offset.@data_offset: (optional) NX_INT
Position of the first stored value in each dimension, one value per …
Position of the first stored value in each dimension, one value per dimension, when the values are not stored in C order (see Non C Storage Order). Used together with
stride.@variant: (optional) NX_CHAR
Name of the field in the same group that holds an earlier value of this …
Name of the field in the same group that holds an earlier value of this field, for example
beam_center_x_refinedforbeam_center_x(see Variants).
Hypertext Anchors¶
List of hypertext anchors for all NeXus groups, fields, attributes and links documented in this class.