emodpy_tbhiv.interventions.resist_diag module#

emodpy_tbhiv.interventions.resist_diag.ResistanceDiagnostic(camp, trigger_treatment_list, sensitivity=1.0, specificity=1.0, pos_event='TBMDRTestPositive', neg_event='TBMDRTestNegative', def_event='TBMDRTestDefault', treatment_fraction=1, treatment_fraction_negative_test=1, start_day=1, duration=-1, property_restrictions_list=[], nodeIDs=[], cost=0, black_period=0, black_trigger='Blackout', event_name='TB Diagnosis MDR')[source]#

Create and return triggered campaign event that issues an ResistanceDiagnostic intervention.

Parameters:

  • camp – The emod_api.campaign module 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.

  • sensitivity – Sensitivity. Defaults to 1.0.

  • specificity – Specificity. Defaults to 1.0.

  • pos_event – Signal (or trigger) which is broadcast if the test is positive. Defaults to ‘TBMDRTestPositive’.

  • neg_event – Signal (or trigger) which is broadcast if the test is negative. Defaults to ‘TBMDRTestNegative’.

  • def_event – Signal (or trigger) which is broadcast if the test is default. Defaults to ‘TBMDRTestDefault’.

  • treatment_fraction – Fraction of population testing positive you get the positive result effect. Defaults to 1.

  • treatment_fraction_negative_test – … Defaults to 1.

  • 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.

  • cost – Per unit ‘price’ of each intervention.

  • black_period – Undocumented.

  • black_trigger – Undocumented.

  • event_name – Undocumented.

Returns:

New campaign event that can be added to the campaign.

emodpy_tbhiv.interventions.resist_diag.new_intervention_as_file(camp, filename='resist_diag.json')[source]#