clinicaio.types#

BIDS enums and validated string types.

Attributes#

`Suffix`	An image file's suffix part. BIDS specification
`SubjectId`	BIDS specification
`SessionId`	BIDS specification

Common base class for all non-exit exceptions.

`Label`	BIDS specification
`DataType`	BIDS specification
`FileExtension`	The file extensions that can be encountered for BIDS image files and their companion files.

type clinicaio.types.Suffix = Annotated[str, Strict(), StringConstraints(pattern='^[a-zA-Z0-9]+$')]#

An image file’s suffix part. BIDS specification

In a usual image file path sub-<label>/ses-<label>/<data_type>/sub-<label>_ses-<label>[_<entities>][_<SUFFIX>].<extension>

Suffixes must be ASCII alphanumeric strings.

type clinicaio.types.SubjectId = Annotated[str, Strict(), StringConstraints(pattern='^sub-[a-zA-Z0-9]+$')]#

A string of the form "sub-<label>" where label is an ASCII alphanumeric string

type clinicaio.types.SessionId = Annotated[str, Strict(), StringConstraints(pattern='^ses-[a-zA-Z0-9]+$')]#

A string of the form "ses-<label>" where label is an ASCII alphanumeric string