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

.. index::
    ! NXapm_paraprobe_ranger_results (application definition)
    ! apm_paraprobe_ranger_results (application definition)
    see: apm_paraprobe_ranger_results (application definition); NXapm_paraprobe_ranger_results

.. _NXapm_paraprobe_ranger_results:

==============================
NXapm_paraprobe_ranger_results
==============================

**Status**:

  *application definition* (contribution), extends :ref:`NXapm_paraprobe_tool_results`

**Description**:

  .. collapse:: Application definition for results files of the paraprobe-ranger tool. ...

      Application definition for results files of the paraprobe-ranger tool.

      The tool paraprobe-ranger evaluates how mass-to-charge-state-ratio
      values map on (molecular) ion types.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays.

  **n_ions**: The total number of ions in the reconstructed volume.

**Groups cited**:
  :ref:`NXapm_paraprobe_tool_process`, :ref:`NXentry`

.. index:: NXentry (base class); used in application definition, NXapm_paraprobe_tool_process (base class); used in application definition

**Structure**:

  .. _/NXapm_paraprobe_ranger_results/ENTRY-group:

  :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ </NXapm_paraprobe_tool_results/ENTRY-group>`


    .. _/NXapm_paraprobe_ranger_results/ENTRY/definition-field:

    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXapm_paraprobe_tool_results/ENTRY/definition-field>`


      Obligatory value: ``NXapm_paraprobe_ranger_results``

    .. _/NXapm_paraprobe_ranger_results/ENTRY/iontypesID-group:

    **iontypes**\ :bolditalic:`ID`: (required) :ref:`NXapm_paraprobe_tool_process` :ref:`⤆ </NXapm_paraprobe_tool_results/ENTRY/TASKPROCESSED-group>`

      .. collapse:: The tool loads ranging definitions from the configuration file and ...

          The tool loads ranging definitions from the configuration file and
          evaluates for each ion to which iontype it matches.
          If an ion matches on no type, the ion is assume of the default
          *unknown_type*. In this case, the value *iontypes* is 0.
          In other cases the value is larger than 0.

      .. _/NXapm_paraprobe_ranger_results/ENTRY/iontypesID/iontypes-field:

      .. index:: iontypes (field)

      **iontypes**: (required) :ref:`NX_UINT <NX_UINT>` (Rank: 1, Dimensions: [n_ions]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

        .. collapse:: The iontype (identifier) for each ion that was best matching, ...

            The iontype (identifier) for each ion that was best matching,
            stored in the order of the evaporation sequence ID.


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

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


* :ref:`/NXapm_paraprobe_ranger_results/ENTRY-group </NXapm_paraprobe_ranger_results/ENTRY-group>`
* :ref:`/NXapm_paraprobe_ranger_results/ENTRY/definition-field </NXapm_paraprobe_ranger_results/ENTRY/definition-field>`
* :ref:`/NXapm_paraprobe_ranger_results/ENTRY/iontypesID-group </NXapm_paraprobe_ranger_results/ENTRY/iontypesID-group>`
* :ref:`/NXapm_paraprobe_ranger_results/ENTRY/iontypesID/iontypes-field </NXapm_paraprobe_ranger_results/ENTRY/iontypesID/iontypes-field>`

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