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

.. index::
    ! NXspatial_filter (base class)
    ! spatial_filter (base class)
    see: spatial_filter (base class); NXspatial_filter

.. _NXspatial_filter:

================
NXspatial_filter
================

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Spatial filter to filter entries within a region-of-interest based on their position.

**Symbols**:

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

  **n_ellipsoids**: Number of ellipsoids.

  **n_hexahedra**: Number of hexahedra.

  **n_cylinders**: Number of cylinders.

**Groups cited**:
  :ref:`NXcg_cylinder_set`, :ref:`NXcg_ellipsoid_set`, :ref:`NXcg_hexahedron_set`, :ref:`NXcs_filter_boolean_mask`

.. index:: NXcg_ellipsoid_set (base class); used in base class, NXcg_cylinder_set (base class); used in base class, NXcg_hexahedron_set (base class); used in base class, NXcs_filter_boolean_mask (base class); used in base class

**Structure**:

  .. _/NXspatial_filter/windowing_method-field:

  .. index:: windowing_method (field)

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

    Qualitative statement which specifies which spatial filtering with respective
    geometric primitives or bitmask is used. These settings are possible:

    * entire_dataset, no filter is applied, the entire dataset is used.  
    * union_of_primitives, a filter with (rotated) geometric primitives.  
      All ions in or on the surface of the primitives are considered  
      while all other ions are ignored.  
    * bitmasked_points, a boolean array whose bits encode with 1  
      which ions should be included. Those ions whose bit is set to 0  
      will be excluded. Users of python can use the bitfield operations  
      of the numpy package to define such bitfields.

    Conditions:
    In the case that windowing_method is entire_dataset all entries are processed.
    In the case that windowing_method is union_of_primitives,
    it is possible to specify none or all types of primitives
    (ellipsoids, cylinder, hexahedra). If no primitives are specified
    the filter falls back to entire_dataset.
    In the case that windowing_method is bitmask, the bitmask has to be defined;
    otherwise the filter falls back to entire dataset.

    Any of these values: ``entire_dataset`` | ``union_of_primitives`` | ``bitmask``

  .. _/NXspatial_filter/CG_ELLIPSOID_SET-group:

  **CG_ELLIPSOID_SET**: (optional) :ref:`NXcg_ellipsoid_set`


  .. _/NXspatial_filter/CG_CYLINDER_SET-group:

  **CG_CYLINDER_SET**: (optional) :ref:`NXcg_cylinder_set`


  .. _/NXspatial_filter/CG_HEXAHEDRON_SET-group:

  **CG_HEXAHEDRON_SET**: (optional) :ref:`NXcg_hexahedron_set`


  .. _/NXspatial_filter/CS_FILTER_BOOLEAN_MASK-group:

  **CS_FILTER_BOOLEAN_MASK**: (optional) :ref:`NXcs_filter_boolean_mask`



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

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


* :ref:`/NXspatial_filter/CG_CYLINDER_SET-group </NXspatial_filter/CG_CYLINDER_SET-group>`
* :ref:`/NXspatial_filter/CG_ELLIPSOID_SET-group </NXspatial_filter/CG_ELLIPSOID_SET-group>`
* :ref:`/NXspatial_filter/CG_HEXAHEDRON_SET-group </NXspatial_filter/CG_HEXAHEDRON_SET-group>`
* :ref:`/NXspatial_filter/CS_FILTER_BOOLEAN_MASK-group </NXspatial_filter/CS_FILTER_BOOLEAN_MASK-group>`
* :ref:`/NXspatial_filter/windowing_method-field </NXspatial_filter/windowing_method-field>`

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