campaign_screening#

class campaign_screening(product=None, prob=None, eligibility=None, **kwargs)[source]#

Bases: BaseScreening, CampaignDelivery

Campaign screening - an instance of base screening combined with campaign delivery. See base classes for a description of input arguments.

Examples:

screen1 = ss.campaign_screening(product=my_prod, prob=0.2, years=2030) # Screen 20% of the eligible population in 2020
screen2 = ss.campaign_screening(product=my_prod, prob=0.02, years=[2025,2030]) # Screen 20% of the eligible population in 2025 and again in 2030

Attributes

now

Return the current time, i.e. the time vector at the current timestep.

states

Return a flat list of all states

statesdict

Return a flat dictionary (objdict) of all states

Methods