dcmri.flux_comp#

dcmri.flux_comp(J, T, t=None, dt=1.0)[source]#

Indicator flux out of a compartment.

See section Compartment for more detail.

Parameters:

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

  • T (float) – mean transit time of the compartment. Any non-negative value is allowed, including \(T=0\) and \(T=\infty\), in which case the compartment is a trap.

  • t (array_like, optional) – the time points of the indicator flux J, in the same units as T. 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, in the same units as T. This parameter is ignored if t is explicity provided. Defaults to 1.0.

Returns:

outflux as a 1D array.

Return type:

numpy.ndarray

See also

res_comp, conc_comp, prop_comp

Example

>>> import dcmri as dc
>>> t = [0,5,15,30,60]
>>> J = [1,2,3,3,2]
>>> dc.flux_comp(J, 5, t)
array([0.        , 1.        , 2.43233236, 2.97173749, 2.16618349])