Skip to content

defaults

defaults

Default parameter values for each modality.

This module provides default acquisition parameters when values cannot be extracted from DICOM or BIDS sources.

References

OSIPI White Papers for recommended parameter ranges Alsop DC et al. (2015). Recommended implementation of ASL. MRM.

get_default_params

get_default_params(modality)

Get default parameters for a modality.

PARAMETER DESCRIPTION
modality

Perfusion imaging modality.

TYPE: Modality

RETURNS DESCRIPTION
dict[str, Any]

Dictionary of default parameter values.

Examples:

>>> from osipy.common.types import Modality
>>> defaults = get_default_params(Modality.ASL)
>>> print(defaults["post_labeling_delay"])
1800.0

get_default_value

get_default_value(modality, param_name)

Get a single default parameter value.

PARAMETER DESCRIPTION
modality

Perfusion imaging modality.

TYPE: Modality

param_name

Parameter name.

TYPE: str

RETURNS DESCRIPTION
Any

Default value, or None if not defined.

Examples:

>>> from osipy.common.types import Modality
>>> pld = get_default_value(Modality.ASL, "post_labeling_delay")
>>> print(pld)
1800.0