.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXnote.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXnote (base class)
    ! note (base class)
    see: note (base class); NXnote

.. _NXnote:

======
NXnote
======

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

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

      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**:

  .. _/NXnote/author-field:

  .. index:: author (field)

  **author**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Author or creator of note

  .. _/NXnote/date-field:

  .. index:: date (field)

  **date**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` 

    Date note created/added

  .. _/NXnote/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

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

  .. _/NXnote/file_name-field:

  .. index:: file_name (field)

  **file_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

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

  .. _/NXnote/identifierNAME-field:

  .. index:: identifierNAME (field)

  **identifier**\ :bolditalic:`NAME`: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXobject/identifierNAME-field>`

    .. collapse:: Identifier of the resource if that resource that has been serialized. ...

        Identifier of the resource if that resource that has been serialized.

        For example, the identifier to a resource in another database.

  .. _/NXnote/checksum-field:

  .. index:: checksum (field)

  **checksum**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Value of the hash that is obtained when running algorithm ...

        Value of the hash that is obtained when running algorithm
        on the content of the resource referred to by ``identifierNAME``.

  .. _/NXnote/algorithm-field:

  .. index:: algorithm (field)

  **algorithm**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Name of the algorithm whereby the ``checksum`` was computed. ...

        Name of the algorithm whereby the ``checksum`` was computed.

        Examples: md5, sha256

  .. _/NXnote/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Title of an image or other details of the note

  .. _/NXnote/sequence_index-field:

  .. index:: sequence_index (field)

  **sequence_index**: (optional) :ref:`NX_POSINT <NX_POSINT>` 

    .. collapse:: Sequence index of note, for placing a sequence of  ...

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

  .. _/NXnote/data-field:

  .. index:: data (field)

  **data**: (optional) :ref:`NX_BINARY <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.


* :ref:`/NXnote/algorithm-field </NXnote/algorithm-field>`
* :ref:`/NXnote/author-field </NXnote/author-field>`
* :ref:`/NXnote/checksum-field </NXnote/checksum-field>`
* :ref:`/NXnote/data-field </NXnote/data-field>`
* :ref:`/NXnote/date-field </NXnote/date-field>`
* :ref:`/NXnote/description-field </NXnote/description-field>`
* :ref:`/NXnote/file_name-field </NXnote/file_name-field>`
* :ref:`/NXnote/identifierNAME-field </NXnote/identifierNAME-field>`
* :ref:`/NXnote/sequence_index-field </NXnote/sequence_index-field>`
* :ref:`/NXnote/type-field </NXnote/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXnote.nxdl.xml