config

config

Pydantic v2 models for YAML pipeline configuration.

Provides validation models for each modality (DCE, DSC, ASL, IVIM), a top-level PipelineConfig model, load_config() for parsing YAML files, and dump_defaults() for generating commented templates.

DataConfig

Bases: BaseModel

Data loading configuration.

OutputConfig

Bases: BaseModel

Output configuration.

BackendConfig

Bases: BaseModel

GPU/CPU backend configuration.

LoggingConfig

Bases: BaseModel

Logging configuration.

DCEFittingConfig

Bases: BaseModel

DCE model fitting configuration from YAML.

validate_fitter classmethod

validate_fitter(v)

Validate fitter name against registry.

validate_bounds classmethod

validate_bounds(v)

Validate bounds are [lower, upper] pairs.

BayesianIVIMFittingConfig

Bases: BaseModel

Bayesian IVIM fitting configuration from YAML.

IVIMFittingConfig

Bases: BaseModel

IVIM model fitting configuration from YAML.

validate_bounds classmethod

validate_bounds(v)

Validate bounds are [lower, upper] pairs.

DCEAcquisitionYAML

Bases: BaseModel

DCE acquisition parameters from YAML.

ROIConfig

Bases: BaseModel

Region-of-interest configuration for limiting processing.

DCEPipelineYAML

Bases: BaseModel

DCE pipeline settings from YAML.

validate_model classmethod

validate_model(v)

Validate DCE model name against registry.

validate_t1_method classmethod

validate_t1_method(v)

Validate T1 mapping method.

validate_aif_source classmethod

validate_aif_source(v)

Validate AIF source.

DSCPipelineYAML

Bases: BaseModel

DSC pipeline settings from YAML.

validate_deconv classmethod

validate_deconv(v)

Validate deconvolution method against registry.

ASLPipelineYAML

Bases: BaseModel

ASL pipeline settings from YAML.

validate_labeling classmethod

validate_labeling(v)

Validate ASL labeling scheme.

validate_m0 classmethod

validate_m0(v)

Validate M0 calibration method.

validate_order classmethod

validate_order(v)

Validate label/control ordering.

IVIMPipelineYAML

Bases: BaseModel

IVIM pipeline settings from YAML.

validate_fitting classmethod

validate_fitting(v)

Validate IVIM fitting method.

PipelineConfig

Bases: BaseModel

Top-level pipeline configuration from YAML.

validate_modality classmethod

validate_modality(v)

Validate modality name.

get_modality_config

get_modality_config()

Get validated modality-specific pipeline config.

RETURNS	DESCRIPTION
BaseModel	Validated modality-specific pipeline configuration.

load_config

load_config(path)

Load and validate a YAML pipeline configuration file.

PARAMETER	DESCRIPTION
path	Path to the YAML configuration file. TYPE: str or Path

RETURNS	DESCRIPTION
PipelineConfig	Validated pipeline configuration.

RAISES	DESCRIPTION
FileNotFoundError	If the config file does not exist.
ValidationError	If the config fails validation.

dump_defaults

dump_defaults(modality)

Generate a commented YAML template for the given modality.

PARAMETER	DESCRIPTION
modality	Modality name: 'dce', 'dsc', 'asl', or 'ivim'. TYPE: str

RETURNS	DESCRIPTION
str	Commented YAML template string.

RAISES	DESCRIPTION
ValueError	If modality is not recognized.