flip_api.domain.interfaces.private
==================================

.. py:module:: flip_api.domain.interfaces.private


Classes
-------

.. autoapisummary::

   flip_api.domain.interfaces.private.ICohortResponseAge
   flip_api.domain.interfaces.private.ICohortResponseGender
   flip_api.domain.interfaces.private.ICohortResponseClientVisit
   flip_api.domain.interfaces.private.IResultsStats
   flip_api.domain.interfaces.private.ICohortResultsAge
   flip_api.domain.interfaces.private.ICohortResultsGender
   flip_api.domain.interfaces.private.ICohortResultsClientVisit
   flip_api.domain.interfaces.private.IIncomingResultsStats
   flip_api.domain.interfaces.private.ICohortResultDataResponse
   flip_api.domain.interfaces.private.IDbData
   flip_api.domain.interfaces.private.IUpdateRetrieveImageStatus
   flip_api.domain.interfaces.private.ITrainingMetrics


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

.. py:class:: ICohortResponseAge

   Bases: :py:obj:`TypedDict`


   Age statistics for the cohort response.


   .. py:attribute:: mean
      :type:  float


.. py:class:: ICohortResponseGender

   Bases: :py:obj:`TypedDict`


   Gender statistics for the cohort response.


   .. py:attribute:: male
      :type:  int


   .. py:attribute:: female
      :type:  int


   .. py:attribute:: missing_data
      :type:  int


.. py:class:: ICohortResponseClientVisit

   Bases: :py:obj:`TypedDict`


   Client visit statistics for the cohort response.


   .. py:attribute:: inpatient
      :type:  int


   .. py:attribute:: emergency
      :type:  int


   .. py:attribute:: missing_data
      :type:  int


.. py:class:: IResultsStats

   Bases: :py:obj:`TypedDict`


   Statistics for the results.


   .. py:attribute:: total_count
      :type:  int


   .. py:attribute:: age
      :type:  ICohortResponseAge


   .. py:attribute:: gender
      :type:  ICohortResponseGender


   .. py:attribute:: client_visit
      :type:  ICohortResponseClientVisit


.. py:class:: ICohortResultsAge

   Bases: :py:obj:`TypedDict`


   Age statistics for the cohort response.


   .. py:attribute:: mean
      :type:  float


.. py:class:: ICohortResultsGender

   Bases: :py:obj:`TypedDict`


   Gender statistics for the cohort response.


   .. py:attribute:: male
      :type:  int


   .. py:attribute:: female
      :type:  int


   .. py:attribute:: missing_data
      :type:  int


.. py:class:: ICohortResultsClientVisit

   Bases: :py:obj:`TypedDict`


   Client visit statistics for the cohort response.


   .. py:attribute:: inpatient
      :type:  int


   .. py:attribute:: emergency
      :type:  int


   .. py:attribute:: missing_data
      :type:  int


.. py:class:: IIncomingResultsStats

   Bases: :py:obj:`TypedDict`


   Statistics for incoming results.


   .. py:attribute:: total_count
      :type:  int


   .. py:attribute:: age
      :type:  ICohortResultsAge


   .. py:attribute:: gender
      :type:  ICohortResultsGender


   .. py:attribute:: client_visit
      :type:  ICohortResultsClientVisit


.. py:class:: ICohortResultDataResponse

   Bases: :py:obj:`TypedDict`


   Cohort result data response.


   .. py:attribute:: trust_name
      :type:  list[str]


   .. py:attribute:: trust_id
      :type:  list[str]


   .. py:attribute:: data
      :type:  list[str]


.. py:class:: IDbData

   Bases: :py:obj:`TypedDict`


   Database data.


   .. py:attribute:: trust_name
      :type:  list[str]


   .. py:attribute:: trust_id
      :type:  list[str]


   .. py:attribute:: data
      :type:  list[IResultsStats]


.. py:class:: IUpdateRetrieveImageStatus

   Bases: :py:obj:`TypedDict`


   Update retrieve image status.


   .. py:attribute:: trust_id
      :type:  str


   .. py:attribute:: xnat_project_id
      :type:  str


.. py:class:: ITrainingMetrics

   Bases: :py:obj:`TypedDict`


   Training metrics.


   .. py:attribute:: trust
      :type:  str


   .. py:attribute:: global_round
      :type:  int


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: result
      :type:  float