clinicaio.entities#

Entity classes and functions.

Attributes#

Classes#

Entity

Recognized entities.

Module Contents#

class clinicaio.entities.Entity#

Bases: enum.StrEnum

Recognized entities.

ANATOMY = 'anat'#
SESSION = 'ses'#
SUBJECT = 'sub'#
classmethod convert(arg: EntityArg)#

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.

property display_name#

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

property display_name_plural#

Get the plural of the display name.

clinicaio.entities.EntityArg#
clinicaio.entities.EntityValue#