clinicaio.dataset_description.BIDSDatasetDescription

class clinicaio.dataset_description.BIDSDatasetDescription(/, **data: Any)

Bases: pydantic.BaseModel

The information that describes a given BIDS dataset.

BIDS specification

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str = None

bids_version: Annotated[packaging.version.Version, Field(alias='BIDSVersion'), BeforeValidator(Version), PlainSerializer(str, return_type=str)]

dataset_type: BIDSDatasetType = None

Methods

new(→ BIDSDatasetDescription)

Creates a new dataset description object, to describe a BIDS dataset.