clinicaio.entities
==================

.. py:module:: clinicaio.entities

.. autoapi-nested-parse::

   Entity classes and functions.



Attributes
----------

.. autoapisummary::

   clinicaio.entities.EntityArg
   clinicaio.entities.EntityValue


Classes
-------

.. autoapisummary::

   clinicaio.entities.Entity


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

.. py:class:: Entity

   Bases: :py:obj:`enum.StrEnum`


   Recognized entities.


   .. py:attribute:: ANATOMY
      :value: 'anat'



   .. py:attribute:: SESSION
      :value: 'ses'



   .. py:attribute:: SUBJECT
      :value: 'sub'



   .. py:method:: convert(arg: EntityArg)
      :classmethod:


      Convert recognized entities to members of this class.

      Args:
          arg:
              The argument to convert.

      Returns:
          An instance of this class if the argument could be converted, else
          the original argument.



   .. py:property:: display_name

      Get the name of this entity for functions and user documentation.



   .. py:property:: display_name_plural

      Get the plural of the display name.



.. py:data:: EntityArg

.. py:data:: EntityValue