dcmri.flux

dcmri.flux(J: ndarray, *params, t=None, dt=1.0, model='comp', **kwargs) → ndarray

Flux out of an arbitrary pharmacokinetic system.

This is a wrapper function offering a standard interface to calculate the flux out of a specific system, with the system architecture specified in the dictionary. It offers a convenient way to build more complex models with variable configurations, such as dcmri.flux_aorta.

Parameters:

• J (array_like) – the indicator flux entering the trap.

• params (tuple) – model parameters.

• t (array_like, optional) – the time points of the indicator flux J. If t=None, the time points are assumed to be uniformly spaced with spacing dt. Defaults to None.

• dt (float, optional) – spacing between time points for uniformly spaced time points. This parameter is ignored if t is explicity provided. Defaults to 1.0.

• model (str, optional) – Model to use, options are ‘trap’, ‘pass’, ‘comp’, ‘plug’, ‘chain’, ‘step’, ‘free’, ‘ncomp’, ‘nscomp’, ‘pfcomp’, ‘mmcomp’, ‘2cxm’. Defaults to ‘comp’.

• kwargs (dict) – any optional parameters required by the model.

Raises:

ValueError – If a system is specified that is nto yet implemented.

Returns:

Total outflux out of the system.

Return type:

np.ndarray