clinicaio.models.enum
=====================

.. py:module:: clinicaio.models.enum


Classes
-------

.. autoapisummary::

   clinicaio.models.enum.SUVRReferenceRegions
   clinicaio.models.enum.Tracer
   clinicaio.models.enum.AnatMRISuffix
   clinicaio.models.enum.PETSuffix
   clinicaio.models.enum.DWISuffix
   clinicaio.models.enum.FMapSuffix
   clinicaio.models.enum.Modality
   clinicaio.models.enum.Extension


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

.. py:class:: SUVRReferenceRegions

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Possible SUVR reference region for pet images in clinicaDL.


   .. py:attribute:: PONS
      :value: 'pons'



   .. py:attribute:: CEREBELLUMPONS
      :value: 'cerebellumPons'



   .. py:attribute:: PONS2
      :value: 'pons2'



   .. py:attribute:: CEREBELLUMPONS2
      :value: 'cerebellumPons2'



.. py:class:: Tracer

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   Possible tracer for pet images in clinicaDL.


   .. py:attribute:: FFDG
      :value: '18FFDG'



   .. py:attribute:: FAV45
      :value: '18FAV45'



   .. py:attribute:: CPIB
      :value: '11CPIB'



.. py:class:: AnatMRISuffix

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


   .. py:attribute:: FLAIR
      :value: 'FLAIR'



   .. py:attribute:: T1W
      :value: 'T1w'



   .. py:attribute:: T2W
      :value: 'T2w'



.. py:class:: PETSuffix

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


   .. py:attribute:: PET
      :value: 'pet'



.. py:class:: DWISuffix

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


   .. py:attribute:: DWI
      :value: 'dwi'



.. py:class:: FMapSuffix

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


.. py:class:: Modality

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


.. py:class:: Extension

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.


   .. py:attribute:: NIFTI
      :value: '.nii'



   .. py:attribute:: NIFTI_GZ
      :value: '.nii.gz'



   .. py:attribute:: DICOM
      :value: '.dcm'



   .. py:attribute:: PT
      :value: '.pt'