:py:mod:`rhino_health.lib.metrics.froc`
=======================================

.. py:module:: rhino_health.lib.metrics.froc


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.froc.FRoc
   rhino_health.lib.metrics.froc.FRocWithCI




.. py:class:: FRoc(**data: Any)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.BaseMetric`

   
   Performs a Free-response Receiver Operating Characteristic calculation
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: y_true_variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariable

      

   .. py:attribute:: y_pred_variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariable

      

   .. py:attribute:: specimen_variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariable

      

   .. py:attribute:: seed
      :type: Optional[int]

      


.. py:class:: FRocWithCI(**data: Any)


   Bases: :py:obj:`FRoc`

   
   Performs a Free-response Receiver Operating Characteristic calculation with Bootstrapping using Confidence Intervals
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: confidence_interval
      :type: int

      

   .. py:attribute:: bootstrap_iterations
      :type: Optional[int]