Skip to content

config

config

Registry-driven config models for DCE selection points.

Each DCE selection point — pharmacokinetic model, T1 mapping method, signal-to-concentration model, and population AIF — declares its tunable knobs as a :class:~osipy.common.config.MethodConfig. These compose into discriminated unions for the CLI config (so selecting a method surfaces exactly that method's parameters and rejects cross-method keys), and the matching *_REGISTRY maps build the live component from a validated config instance via :func:~osipy.common.config.construct_from_config.

Mirrors :mod:osipy.dsc.deconvolution.config. Adding @register_model (or @register_t1_method / @register_concentration_model / @register_aif) plus an entry here automatically surfaces the new option (and its knobs) as a CLI toggle that both validates input and builds the component — an option can never be "collected but silently ignored".

References

.. [1] OSIPI CAPLEX, https://osipi.github.io/OSIPI_CAPLEX/ .. [2] Dickie BR et al. MRM 2024;91(5):1761-1773. doi:10.1002/mrm.29840

ToftsConfig

Bases: MethodConfig

Standard Tofts model (OSIPI: M.IC1.004).

ExtendedToftsConfig

Bases: MethodConfig

Extended Tofts model with plasma term (OSIPI: M.IC1.005).

PatlakConfig

Bases: MethodConfig

Patlak model (OSIPI: M.IC1.006).

TwoCXMConfig

Bases: MethodConfig

Two-compartment exchange model (OSIPI: M.IC1.009).

TwoCUMConfig

Bases: MethodConfig

Two-compartment uptake model (2CUM).

VFAConfig

Bases: MethodConfig

Variable Flip Angle T1 mapping (OSIPI: P.NR2.002).

LookLockerConfig

Bases: MethodConfig

Look-Locker inversion-recovery T1 mapping (OSIPI: P.NR2.004).

SPGRConcentrationConfig

Bases: MethodConfig

Spoiled gradient-echo signal-to-concentration model (OSIPI: P.SC1.001).

LinearConcentrationConfig

Bases: MethodConfig

Linear signal-to-concentration approximation (small enhancement).