4.3.1.34. NXnote

Status:

base class, extends NXobject

Description:

Any additional freeform information not covered by the other base classes.

This class can be used to store additional information in a NeXus file e.g. pictures, movies, audio, additional text logs

Symbols:

No symbol table

Groups cited:

none

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading to a 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 https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.

author: (optional) NX_CHAR

Author or creator of note

date: (optional) NX_DATE_TIME

Date note created/added

type: (optional) NX_CHAR

Mime content type of note data field e.g. image/jpeg, text/plain, text/html

file_name: (optional) NX_CHAR

Name of original file name if note was read from an external source

description: (optional) NX_CHAR

Title of an image or other details of the note

sequence_index: (optional) NX_POSINT

Sequence index of note, for placing a sequence of multiple NXnote groups in an order. Starts with 1.

data: (optional) NX_BINARY

Binary note data - if text, line terminator is [CR][LF].

Hypertext Anchors

List of hypertext anchors for all groups, fields, attributes, and links defined in this class.

NXDL Source:

https://github.com/nexusformat/definitions/blob/main/base_classes/NXnote.nxdl.xml