3.3.1.59. NXcs_filter_boolean_mask¶
Status:
base class, extends NXobject
Description:
Base class for packing and unpacking booleans. ...
Base class for packing and unpacking booleans.
The field mask should be constructed from packing a vector of booleans (a bitfield) into unsigned integers with bytesize bitdepth. Padding to an integer number of such integers is assumed.
Thereby, this base class can be used to inform software about necessary modulo operations to decode the mask to recover e.g. set membership of objects in sets whose membership has been encoded as a vector of booleans.
This is useful e.g. when processing object sets such as point cloud data. If e.g. a spatial filter has been applied to a set of points, we may wish to document memory-space efficiently which points were analyzed. An array of boolean values is one option to achieve this. A value is true if the point is included and false otherwise.
Symbols:
The symbols used in the schema to specify e.g. dimensions of arrays.
n_objs: Number of entries (e.g. number of points or objects).
bitdepth: Number of bits assumed for the container datatype used.
n_total: Length of mask considering the eventual need for padding.
- Groups cited:
none
Structure:
depends_on: (optional) NX_CHAR
Possibility to refer to which set this mask applies. ...
Possibility to refer to which set this mask applies.
If depends_on is not provided, it is assumed that the mask applies to its direct parent.
number_of_objects: (optional) NX_UINT {units=NX_UNITLESS}
Number of objects represented by the mask.
bitdepth: (optional) NX_UINT {units=NX_UNITLESS}
Number of bits assumed matching on a default datatype. ...
Number of bits assumed matching on a default datatype. (e.g. 8 bits for a C-style uint8).
mask: (optional) NX_UINT {units=NX_UNITLESS}
The content of the mask. If padding is used, ...
The content of the mask. If padding is used, padding bits have to be set to 0.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.