.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXtomoproc.nxdl.xml

.. index::
    ! NXtomoproc (application definition)
    ! tomoproc (application definition)
    see: tomoproc (application definition); NXtomoproc

.. _NXtomoproc:

==========
NXtomoproc
==========

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

  This is an application definition for the final result of a tomography experiment: a 3D construction of some volume of physical properties.

**Symbols**:

  These symbols will be used below to coordinate datasets with the same shape.

  **nx**: number of voxels in X direction

  **ny**: number of voxels in Y direction

  **nz**: number of voxels in Z direction

**Groups cited**:
  :ref:`NXdata`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXparameters`, :ref:`NXprocess`, :ref:`NXsample`, :ref:`NXsource`

.. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXsample (base class); used in application definition, NXprocess (base class); used in application definition, NXparameters (base class); used in application definition, NXdata (base class); used in application definition

**Structure**:

  **entry**: (required) :ref:`NXentry`


    .. index:: title (field)

    **title**: (required) :ref:`NX_CHAR <NX_CHAR>`


    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>`

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXtomoproc``

    **(instrument)**: (required) :ref:`NXinstrument`


      **(source)**: (required) :ref:`NXsource`


        .. index:: type (field)

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


        .. index:: name (field)

        **name**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: probe (field)

        **probe**: (required) :ref:`NX_CHAR <NX_CHAR>`


          Any of these values: ``neutron`` | ``x-ray`` | ``electron``

    **(sample)**: (required) :ref:`NXsample`


      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>`

        Descriptive name of sample

    **reconstruction**: (required) :ref:`NXprocess`


      .. index:: program (field)

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

        Name of the program used for reconstruction

      .. index:: version (field)

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

        Version of the program used

      .. index:: date (field)

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

        Date and time of reconstruction processing.

      **parameters**: (required) :ref:`NXparameters`


        .. index:: raw_file (field)

        **raw_file**: (required) :ref:`NX_CHAR <NX_CHAR>`

          Original raw data file this data was derived from

    **data**: (required) :ref:`NXdata`


      .. index:: data (field)

      **data[nx, nx, nz]**: (required) :ref:`NX_INT <NX_INT>`

        This is the reconstructed volume. This can be different
        things. Please indicate in the unit attribute what physical
        quantity this really is.

        .. index:: transform (field attribute)

        **@transform**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: offset (field attribute)

        **@offset**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: scaling (field attribute)

        **@scaling**: (required) :ref:`NX_CHAR <NX_CHAR>`


      .. index:: x (field)

      **x[nx]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`}

        This is an array holding the values to use for the x-axis of
        data. The units must be appropriate for the measurement.

      .. index:: y (field)

      **y[ny]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`}

        This is an array holding the values to use for the y-axis of
        data. The units must be appropriate for the measurement.

      .. index:: z (field)

      **z[nz]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`}

        This is an array holding the values to use for the z-axis of
        data. The units must be appropriate for the measurement.

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/applications/NXtomoproc.nxdl.xml