2.3.3.3.159. NXspatial_filter

Status:

base class (contribution), extends NXobject

Description:

Base class for a spatial filter for objects within a region-of-interest (ROI). ...

Base class for a spatial filter for objects within a region-of-interest (ROI).

Objects can be points or objects composed from other geometric primitives.

Symbols:

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

n_hexahedra: Number of hexahedra.

n_cylinders: Number of cylinders.

n_ellipsoids: Number of ellipsoids.

n_polyhedra: Number of polyhedra.

Groups cited:

NXcg_cylinder, NXcg_ellipsoid, NXcg_hexahedron, NXcg_polyhedron, NXcs_filter_boolean_mask

Structure:

windowing_method: (optional) NX_CHAR

Qualitative statement which describes the logical operations ...

Qualitative statement which describes the logical operations that define which objects will be included and which excluded:

  • entire_dataset, no filter is applied, all objects are included.

  • union_of_primitives, a filter with (possibly non-axis-aligned) geometric primitives. Objects in or on the surface of the primitives are included. All other objects are excluded.

  • bitmask, a boolean array whose bits encode with 1 which objects are included. Bits set to zero encode which objects are excluded. Users of python can use the bitfield operations of the numpy package to work with bitfields.

Any of these values: entire_dataset | union_of_primitives | bitmask

CG_HEXAHEDRON: (optional) NXcg_hexahedron

CG_CYLINDER: (optional) NXcg_cylinder

CG_ELLIPSOID: (optional) NXcg_ellipsoid

CG_POLYHEDRON: (optional) NXcg_polyhedron

CS_FILTER_BOOLEAN_MASK: (optional) NXcs_filter_boolean_mask

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/NXspatial_filter.nxdl.xml