validator

validator

Parameter validation for perfusion imaging.

This module validates that required parameters are present and within acceptable ranges for each modality.

ValidationResult dataclass

ValidationResult(
    is_valid=True,
    missing_required=list(),
    missing_recommended=list(),
    out_of_range=dict(),
    warnings=list(),
)

Result of parameter validation.

ATTRIBUTE	DESCRIPTION
is_valid	Whether all required parameters are present and valid. TYPE: bool
missing_required	List of missing required parameters. TYPE: list[str]
missing_recommended	List of missing recommended parameters. TYPE: list[str]
out_of_range	Parameters with values outside expected ranges. Maps param name to (value, (min, max)). TYPE: dict[str, tuple[Any, tuple[float, float]]]
warnings	Warning messages about the validation. TYPE: list[str]

__str__

__str__()

Format validation result as string.

ParameterValidator

ParameterValidator(modality)

Validates acquisition parameters for perfusion analysis.

This class checks that required parameters are present and within acceptable ranges for the specified modality.

Examples:

>>> from osipy.common.types import Modality
>>> validator = ParameterValidator(Modality.ASL)
>>> params = {"labeling_type": "PCASL", "post_labeling_delay": 1800.0}
>>> result = validator.validate(params)
>>> print(result.is_valid)
True

Initialize validator for a modality.

PARAMETER	DESCRIPTION
modality	Perfusion imaging modality. TYPE: Modality

validate

validate(params, check_ranges=True, check_recommended=True)

Validate parameters against modality requirements.

PARAMETER	DESCRIPTION
params	Dictionary of parameter names and values. TYPE: dict[str, Any]
check_ranges	Whether to check value ranges. TYPE: bool DEFAULT: True
check_recommended	Whether to check for recommended parameters. TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
ValidationResult	Validation result with details.