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

.. index::
    ! NXmatch_filter (base class)
    ! match_filter (base class)
    see: match_filter (base class); NXmatch_filter

.. _NXmatch_filter:

==============
NXmatch_filter
==============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Settings of a filter to select or remove entries based on their value.

**Symbols**:

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

  **n_values**: How many different match values does the filter specify.

**Groups cited**:
  none

**Structure**:

  .. _/NXmatch_filter/method-field:

  .. index:: method (field)

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

    Meaning of the filter:
    Whitelist specifies which entries with said value to include.
    Entries with all other values will be filtered out.

    Blacklist specifies which entries with said value to exclude.
    Entries with all other values will be included.

    Any of these values: ``whitelist`` | ``blacklist``

  .. _/NXmatch_filter/match-field:

  .. index:: match (field)

  **match**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [n_values]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    Array of values to filter according to method. For example if the filter
    specifies [1, 5, 6] and method is whitelist, only entries with values
    matching 1, 5 or 6 will be processed. All other entries will be filtered
    out.


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

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


* :ref:`/NXmatch_filter/match-field </NXmatch_filter/match-field>`
* :ref:`/NXmatch_filter/method-field </NXmatch_filter/method-field>`

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