WaneDimension

class dynode.config.dimension.WaneDimension(waiting_times: list[Annotated[float, Gt(gt=0)]], base_protections: list[Annotated[float, Ge(ge=0.0), Le(le=1.0)]], name='wane')

Bases: Dimension

Dimension to tracking waning after recovery from a disease.

__init__(waiting_times: list[Annotated[float, Gt(gt=0)]], base_protections: list[Annotated[float, Ge(ge=0.0), Le(le=1.0)]], name='wane')

Create a Dimension to track waning status.

Parameters

waiting_timeslist[PositiveFloat]

A list of the waiting times of each bin from first wane bin to last.

base_protectionslist[UnitIntervalFloat]

A list of base protections on [0, 1] for each waning bin, parallel to wait_times.

namestr, optional

name of the dimension, dimensions tracking different waning states must have different names, by default “wane”.

Methods

__init__(waiting_times, base_protections[, name])

Create a Dimension to track waning status.

Attributes

model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
name
bins

_abc_impl = <_abc._abc_data object>

_validate_wane_bins_end_in_inf()

Validate last wane bin can not be waned out of.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].