runner

runner

Pipeline runner module.

This module provides a unified interface for running perfusion analysis pipelines with automatic modality detection.

PipelineResult dataclass

PipelineResult(
    modality, parameter_maps, quality_mask, metadata=dict()
)

Generic pipeline result container.

ATTRIBUTE	DESCRIPTION
modality	Analyzed modality. TYPE: Modality
parameter_maps	Output parameter maps. TYPE: dict[str, ParameterMap]
quality_mask	Quality mask for valid results. TYPE: NDArray[bool_]
metadata	Additional metadata and statistics. TYPE: dict[str, Any]

run_analysis

run_analysis(data, modality, **kwargs)

Run perfusion analysis with specified modality.

This is a unified entry point that dispatches to the appropriate pipeline based on the modality.

PARAMETER	DESCRIPTION
data	Input data appropriate for the modality. TYPE: NDArray
modality	Analysis modality: 'dce', 'dsc', 'asl', or 'ivim'. TYPE: Modality or str
**kwargs	Additional arguments passed to the specific pipeline. See individual pipeline documentation for details. TYPE: Any DEFAULT: {}

RETURNS	DESCRIPTION
PipelineResult	Analysis results.

Examples:

>>> import numpy as np
>>> from osipy.pipeline import run_analysis
>>> from osipy.common.types import Modality
>>>
>>> # Run DCE analysis
>>> result = run_analysis(
...     dce_data,
...     modality=Modality.DCE,
...     time=time_vector,
...     model='extended_tofts',
... )
>>>
>>> # Run IVIM analysis
>>> result = run_analysis(
...     dwi_data,
...     modality='ivim',
...     b_values=b_values,
... )