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

.. index::
    ! NXapm_paraprobe_ranger_config (application definition)
    ! apm_paraprobe_ranger_config (application definition)
    see: apm_paraprobe_ranger_config (application definition); NXapm_paraprobe_ranger_config

.. _NXapm_paraprobe_ranger_config:

=============================
NXapm_paraprobe_ranger_config
=============================

**Status**:

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

**Description**:

  .. collapse:: Application definition for a configuration file of the paraprobe-ranger tool. ...

      Application definition for a configuration file 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_nuclides**: The number of isotopes to consider as building blocks for searching molecular ions.

  **n_composition**: The number of compositions to consider for molecular ion search tasks.

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

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

**Structure**:

  .. _/NXapm_paraprobe_ranger_config/ENTRY-group:

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


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

    .. index:: definition (field)

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


      Obligatory value: ``NXapm_paraprobe_ranger_config``

    .. _/NXapm_paraprobe_ranger_config/ENTRY/rangeID-group:

    **range**\ :bolditalic:`ID`: (required) :ref:`NXapm_paraprobe_tool_parameters` :ref:`⤆ </NXapm_paraprobe_tool_config/ENTRY/TASKCONFIG-group>`



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

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


* :ref:`/NXapm_paraprobe_ranger_config/ENTRY-group </NXapm_paraprobe_ranger_config/ENTRY-group>`
* :ref:`/NXapm_paraprobe_ranger_config/ENTRY/definition-field </NXapm_paraprobe_ranger_config/ENTRY/definition-field>`
* :ref:`/NXapm_paraprobe_ranger_config/ENTRY/rangeID-group </NXapm_paraprobe_ranger_config/ENTRY/rangeID-group>`

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