robokudo.annotators.filter
==========================

.. py:module:: robokudo.annotators.filter

.. autoapi-nested-parse::

   Filter annotator for RoboKudo.

   This module provides an annotator for filtering annotations based on custom conditions.
   It supports:

   * Dynamic filtering through callable functions
   * Custom filter arguments
   * In-place annotation list modification
   * Flexible condition evaluation

   The module is used for:

   * Annotation filtering
   * Data preprocessing
   * Result refinement
   * Conditional processing



Classes
-------

.. autoapisummary::

   robokudo.annotators.filter.FilterAnnotator


Module Contents
---------------

.. py:class:: FilterAnnotator(name='FilterAnnotator', descriptor=Descriptor())

   Bases: :py:obj:`robokudo.annotators.core.BaseAnnotator`


   Annotator for applying filter conditions to annotations.

   This annotator applies a provided filter function to the current set of
   annotations, modifying the annotation list in-place based on the filter results.

   :ivar descriptor: Configuration descriptor containing filter parameters
   :type descriptor: FilterAnnotator.Descriptor


   .. py:class:: Descriptor

      Bases: :py:obj:`robokudo.annotators.core.BaseAnnotator.Descriptor`


      Configuration descriptor for filter annotator.

      :ivar parameters: Filter parameters
      :type parameters: FilterAnnotator.Descriptor.Parameters


      .. py:class:: Parameters

         Parameter container for filter configuration.

         :ivar func: Filter function to apply
         :type func: callable
         :ivar func_args: Positional arguments for filter function
         :type func_args: tuple
         :ivar func_kwargs: Keyword arguments for filter function
         :type func_kwargs: dict


         .. py:attribute:: func
            :value: None



         .. py:attribute:: func_args
            :value: None



         .. py:attribute:: func_kwargs
            :value: None




      .. py:attribute:: parameters



   .. py:method:: update()

      Apply the filter function to current annotations.

      The filter function is applied to each annotation with the configured
      arguments. Only annotations that pass the filter are kept.

      :return: SUCCESS status
      :rtype: py_trees.Status