- emodpy_tbhiv.interventions.active_diagnostic.ActiveDiagnostic(camp, trigger_treatment_list, active_sensitivity=1.0, active_specificity=1.0, pos_event='TBTestPositive', treatment_fraction=1, start_day=1, duration=- 1, property_restrictions_list=, nodeIDs=, black_period=0, black_trigger='Blackout', event_name='TB Diagnosis Active Simple')¶
Create and return triggered campaign event that issues an ActiveDiagnostic intervention. See ActiveDiagnostic
camp – The
emod_api.campaignmodule instance which serves as the campaign accumulator.
trigger_treatment_list – List of 1 or more triggers (or events or signals) which are listened to and trigger the distribution of the intervention. There is no default.
active_sensitivity – Sensitivity. Defaults to 1.0.
active_specificity – Specificity. Defaults to 1.0.
pos_event – Signal (or trigger) which is broadcast if the test is positive. Defaults to ‘TBTestPositive’,
treatment_fraction – Fraction of population testing positive you get the positive result effect.
start_day – The timestep when this campaign event takes effect. Defaults to 1.
duration – How long the campaign event remains in effect. Defaults to forever.
property_restrictions_list – Optiional list of Individual Properties to limit the intervention to.
nodeIDs – Optiona list of node ids to target. Defaults to all.
black_period – Undocumented.
black_trigger – Undocumented.
event_name – Undocumented.
New campaign event that can be added to the campaign.
- emodpy_tbhiv.interventions.active_diagnostic.new_intervention_as_file(camp, start_day=1, filename=None)¶