stilt.transforms.FirstOrderLifetime

class stilt.transforms.FirstOrderLifetime(*, kind: Literal['first_order_lifetime'] = 'first_order_lifetime', lifetime_hours: Annotated[float, Gt(gt=0)], time_column: str = 'time', time_unit: Literal['s', 'sec', 'seconds', 'm', 'min', 'minutes', 'h', 'hr', 'hours', 'd', 'days'] = 'min') → None

Decay each particle’s foot by exp(-age / lifetime).

age is the particle’s transport time from time_column (minutes by default) and lifetime_hours the species e-folding lifetime.

Methods

apply(particles[, context])

Decay each particle's contribution by its age and the lifetime.

Attributes

kind
lifetime_hours
time_column
time_unit