Ctrl+K
On this page

BaseTreatment#

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

Bases: Intervention

Base treatment class.

Parameters:

  • product (str/Product) – the treatment product to use

  • accept_prob (float/arr) – acceptance rate of treatment - interpreted as the % of women eligble for treatment who accept

  • eligibility (inds/callable) – indices OR callable that returns inds

  • label (str) – the name of treatment strategy

  • kwargs (dict) – passed to Intervention()

Methods

check_eligibility(sim)[source]#

Check people’s eligibility for treatment

get_accept_inds(sim)[source]#

Get indices of people who will acccept treatment; these people are then added to a queue or scheduled for receiving treatment

get_candidates(sim)[source]#

Get candidates for treatment on this timestep. Implemented by derived classes.

apply(sim)[source]#

Perform treatment by getting candidates, checking their eligibility, and then treating them.