2.3.3.3.54. NXmatch_filter

Status:

base class (contribution), extends NXparameters

Description:

Base class of a filter to select members of a set based on their identifier.

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:

method: (optional) NX_CHAR

Definition of the logic what the filter yields: ...

Definition of the logic what the filter yields:

  • Whitelist specifies which entries with said value to include. Entries with all other values will be excluded.

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

Any of these values: whitelist | blacklist

match: (optional) NX_NUMBER (Rank: 1, Dimensions: [n_values]) {units=NX_UNITLESS}

Array of values to filter according to method. If the match e.g. specifies ...

Array of values to filter according to method. If the match e.g. specifies [1, 5, 6] and method is set to whitelist, only entries with values matching 1, 5 or 6 will be processed. All other entries will be excluded.

Hypertext Anchors

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

NXDL Source:

https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXmatch_filter.nxdl.xml