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

.. index::
    ! NXapm_input_reconstruction (base class)
    ! apm_input_reconstruction (base class)
    see: apm_input_reconstruction (base class); NXapm_input_reconstruction

.. _NXapm_input_reconstruction:

==========================
NXapm_input_reconstruction
==========================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Metadata of a dataset (tomographic reconstruction) in atom probe microscopy.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXapm_input_reconstruction/filename-field:

  .. index:: filename (field)

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

    Name of the (NeXus)/HDF5 file which stores reconstructed ion position
    and mass-to-charge-state ratios. Such an HDF5 file can store multiple
    reconstructions. Using the information within the dataset_name fields
    is the mechanism whereby paraprobe decides which reconstruction to
    process. With this design it is possible that the same HDF5
    file can store multiple versions of a reconstruction.

    .. _/NXapm_input_reconstruction/filename@version-attribute:

    .. index:: version (field attribute)

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

      Version identifier of the file (representing an at least SHA256 strong)
      hash. Such hashes serve reproducibility as they can be used for tracking
      provenance metadata in a workflow.

  .. _/NXapm_input_reconstruction/dataset_name_reconstruction-field:

  .. index:: dataset_name_reconstruction (field)

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

    Name of the dataset inside the HDF5 file which refers to the
    specific reconstructed ion positions to use for this analysis.

  .. _/NXapm_input_reconstruction/dataset_name_mass_to_charge-field:

  .. index:: dataset_name_mass_to_charge (field)

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

    Name of the dataset inside the HDF5 file which refers to the
    specific mass-to-charge-state-ratio values to use for this analysis.


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

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


* :ref:`/NXapm_input_reconstruction/dataset_name_mass_to_charge-field </NXapm_input_reconstruction/dataset_name_mass_to_charge-field>`
* :ref:`/NXapm_input_reconstruction/dataset_name_reconstruction-field </NXapm_input_reconstruction/dataset_name_reconstruction-field>`
* :ref:`/NXapm_input_reconstruction/filename-field </NXapm_input_reconstruction/filename-field>`
* :ref:`/NXapm_input_reconstruction/filename@version-attribute </NXapm_input_reconstruction/filename@version-attribute>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXapm_input_reconstruction.nxdl.xml