StandardChoice#

class StandardChoice(pars=None, location=None, **kwargs)[source]#

Bases: SimpleChoice

Default contraceptive choice module. Contraceptive choice is based on age, education, wealth, parity, and prior use.

Attributes

auto_state_list

List of "automatic" states with boolean type (ss.BoolState) that were added via define_states()

average_dur_use

dt

Get the current module timestep

now

Shortcut to self.t.now()

state_dict

Return a flat dictionary (objdict) of all states

state_list

Return a flat list of all states (ss.Arr objects)

ti

Get the current module timestep

timevec

Shortcut to self.t.timevec

Methods

get_prob_use(uids, event=None)[source]#

Return an array of probabilities that each woman will use contraception.