robokudo.annotators.cas_check
=============================

.. py:module:: robokudo.annotators.cas_check

.. autoapi-nested-parse::

   This module contains methods that allow you to quickly check if a certain condition is met in the CAS.
   Returns SUCCESS if true, FAILURE otherwise.
   Never returns RUNNING. For RUNNING, check CASCondition / cas_condition.py



Classes
-------

.. autoapisummary::

   robokudo.annotators.cas_check.CASCheckFunc
   robokudo.annotators.cas_check.CASCheckAnnotationTypeExists
   robokudo.annotators.cas_check.CASCheckOHExists


Functions
---------

.. autoapisummary::

   robokudo.annotators.cas_check.any_of_type_present


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

.. py:class:: CASCheckFunc(name='CASCheckFunc', func: Callable[[robokudo.cas.CAS], bool] = None, raise_with_str: str = '')

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


   Check if the return value of a given function is TRUE. Return SUCCESS in this case.
   The func gets access to the CAS.


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



   .. py:attribute:: raise_with_str
      :value: ''



   .. py:method:: update()

      Called every time the behavior is ticked.



.. py:function:: any_of_type_present(annotation_type, cas: robokudo.cas.CAS)

.. py:class:: CASCheckAnnotationTypeExists(name='CASCheckAnnotationTypeExists', annotation_type=None, raise_with_str: str = '')

   Bases: :py:obj:`CASCheckFunc`


   Return SUCCESS, if an Annotation of a specific RoboKudo Type exists in the CAS.


.. py:class:: CASCheckOHExists(name='CASCheckOHExists', raise_with_str: str = '')

   Bases: :py:obj:`CASCheckAnnotationTypeExists`


   Return SUCCESS, if ObjectHypotheses are in the CAS.