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

.. index::
    ! NXapm_input_ranging (base class)
    ! apm_input_ranging (base class)
    see: apm_input_ranging (base class); NXapm_input_ranging

.. _NXapm_input_ranging:

===================
NXapm_input_ranging
===================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Metadata to ranging definitions made for a dataset in atom probe microscopy.

  Ranging is the process of labeling time-of-flight data with so-called iontypes
  which ideally specify the most likely ion/molecular ion evaporated within a
  given mass-to-charge-state-ratio value interval.

  The paraprobe-toolbox uses the convention that the so-called UNKNOWNTYPE
  iontype (or unranged ions) represents the default iontype.
  The ID of this special iontype is always reserved as 0. Each ion
  is assigned to the UNKNOWNTYPE by default. Iontypes are assigned
  by checking if the mass-to-charge-state-ratio values of an ion matches
  to any of the defined mass-to-charge-state-ratio intervals.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXapm_input_ranging/filename-field:

  .. index:: filename (field)

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

    Path and name of the NeXus/HDF5 file which stores ranging definitions.

    .. _/NXapm_input_ranging/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_ranging/group_name_iontypes-field:

  .. index:: group_name_iontypes (field)

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

    Name of the group (prefix to the individual ranging definitions) inside
    the file referred to by filename which points to the specific ranging
    definition to use.
    An HDF5 file can store multiple ranging definitions. Using an ID is
    the mechanism to distinguish which specific ranging (version) will
    be processed. Reconstruction and ranging IDs can differ.
    They specify different IDs.


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

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


* :ref:`/NXapm_input_ranging/filename-field </NXapm_input_ranging/filename-field>`
* :ref:`/NXapm_input_ranging/filename@version-attribute </NXapm_input_ranging/filename@version-attribute>`
* :ref:`/NXapm_input_ranging/group_name_iontypes-field </NXapm_input_ranging/group_name_iontypes-field>`

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