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

.. index::
    ! NXprocess (base class)
    ! process (base class)
    see: process (base class); NXprocess

.. _NXprocess:

=========
NXprocess
=========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: The :ref:`NXprocess` class describes an operation used to ...

      The :ref:`NXprocess` class describes an operation used to
      process data as part of an analysis workflow, providing
      information such as the software used, the date of the
      operation, the input parameters, and the resulting data.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXnote`, :ref:`NXparameters`

.. index:: NXnote (base class); used in base class, NXparameters (base class); used in base class, NXdata (base class); used in base class

**Structure**:

  .. _/NXprocess/program-field:

  .. index:: program (field)

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

    Name of the program used

  .. _/NXprocess/sequence_index-field:

  .. index:: sequence_index (field)

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

    .. collapse:: Sequence index of processing, for determining the order of ...

        Sequence index of processing, for determining the order of
        multiple **NXprocess** steps. Starts with 1.

  .. _/NXprocess/version-field:

  .. index:: version (field)

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

    Version of the program used

  .. _/NXprocess/date-field:

  .. index:: date (field)

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

    Date and time of processing.

  .. _/NXprocess/NOTE-group:

  :bolditalic:`NOTE`: (optional) :ref:`NXnote` :ref:`⤆ </NXobject/NOTE-group>`

    .. collapse:: The note will contain information about how the data was ...

        The note will contain information about how the data was
        processed or anything about the data provenance. The
        contents of the note can be anything that the processing
        code can understand, or simple text.

        The name will be numbered to allow for ordering of steps.

  .. _/NXprocess/PARAMETERS-group:

  :bolditalic:`PARAMETERS`: (optional) :ref:`NXparameters` :ref:`⤆ </NXobject/PARAMETERS-group>`

    Parameters used in performing the data analysis.

  .. _/NXprocess/DATA-group:

  :bolditalic:`DATA`: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    The data resulting from the operation.


Hypertext Anchors
-----------------

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


* :ref:`/NXprocess/DATA-group </NXprocess/DATA-group>`
* :ref:`/NXprocess/date-field </NXprocess/date-field>`
* :ref:`/NXprocess/NOTE-group </NXprocess/NOTE-group>`
* :ref:`/NXprocess/PARAMETERS-group </NXprocess/PARAMETERS-group>`
* :ref:`/NXprocess/program-field </NXprocess/program-field>`
* :ref:`/NXprocess/sequence_index-field </NXprocess/sequence_index-field>`
* :ref:`/NXprocess/version-field </NXprocess/version-field>`

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