tlo.methods.schisto module ========================== .. automodule:: tlo.methods.schisto .. autoclass:: Schisto Bases: :class:`tlo.core.Module`, :class:`tlo.methods.hsi_generic_first_appts.GenericFirstAppointmentsMixin` **PARAMETERS:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - delay_till_hsi_a_repeated - REAL - Time till seeking healthcare again after not being sent to schisto test: start * - delay_till_hsi_b_repeated - REAL - Time till seeking healthcare again after not being sent to schisto test: end * - rr_WASH - REAL - proportional reduction in population susceptible to schistosoma infection with improved WASH * - calibration_scenario - REAL - Scenario used to reset parameters to run calibration sims * - urine_filtration_sensitivity_lowWB - REAL - Sensitivity of UF in detecting low WB * - urine_filtration_sensitivity_moderateWB - REAL - Sensitivity of UF in detecting moderate WB * - urine_filtration_sensitivity_heavyWB - REAL - Sensitivity of UF in detecting heavy WB * - kato_katz_sensitivity_moderateWB - REAL - Sensitivity of KK in detecting moderate WB * - kato_katz_sensitivity_heavyWB - REAL - Sensitivity of KK in detecting heavy WB * - scaleup_WASH - STRING - Whether to scale-up WASH during simulation, pause fixes values at 2024 levels with no further improvement, continue allows historical trends to continue, scaleup switches everyone to having access to WASH * - scaleup_WASH_start_year - INT - Start date to scale-up WASH, years after sim start date * - mda_coverage - REAL - Coverage of future MDA activities, consistent across alltarget groups * - mda_target_group - STRING - Target group for future MDA activities, one of [PSAC_SAC, SAC, ALL] * - mda_frequency_months - REAL - Number of months between MDA activities * - scaling_factor_baseline_risk - REAL - scaling factor controls how the background risk of infection is adjusted based on the deviation of current prevalence from baseline prevalence * - baseline_risk - REAL - number of worms applied as a baseline risk across districts to prevent fadeout, number is scaled by scaling_factor_baseline_risk * - background_gamma - REAL - controls how fast the cushion shrinks as national prevalence falls; larger values (e.g. 2.5–3.0) make it disappear sooner * - background_rel - REAL - a small proportional cushion (1% at baseline) applied to the human reservoir; keeps early declines smooth without creating an artificial floor * - daly_weight_mild_schistosomiasis - REAL - daly weight assigned to mild schistosomiasis, both species * - daly_weight_moderate_s_mansoni - REAL - daly weight assigned to moderate S. mansoni * - daly_weight_heavy_s_mansoni - REAL - daly weight assigned to heavy S. mansoni * - daly_weight_moderate_s_haematobium - REAL - daly weight assigned to moderate S. haematobium * - daly_weight_heavy_s_haematobium - REAL - daly weight assigned to heavy S. haematobium * - MDA_coverage_historical - DATA_FRAME - Probability of getting PZQ in the MDA for PSAC, SAC and Adults in historic rounds **PROPERTIES:** .. list-table:: :widths: 25 25 50 :header-rows: 1 * - Item - Type - Description * - ss_MDA_treatment_counter - INT - Counter for number of MDA treatments received in logging interval **Class attributes:** CAUSES_OF_DEATH : {} CAUSES_OF_DISABILITY : {'Schistosomiasis': } INIT_DEPENDENCIES : {'Demography', 'SymptomManager'} METADATA : {, , , } OPTIONAL_INIT_DEPENDENCIES : {'HealthSystem', 'HealthBurden'} __annotations__ : {} module_prefix : ss **Functions (defined or overridden in class Schisto):** .. automethod:: __init__ .. automethod:: read_parameters .. automethod:: pre_initialise_population .. automethod:: initialise_population .. automethod:: initialise_simulation .. automethod:: on_birth .. automethod:: report_daly_values .. automethod:: do_effect_of_treatment .. automethod:: _load_parameters_from_workbook .. automethod:: _create_mda_strategy .. automethod:: _register_symptoms .. automethod:: _get_disability_weight .. automethod:: _get_item_code_for_praziquantel .. automethod:: calculate_praziquantel_dosage .. automethod:: _get_consumables_for_dx .. automethod:: _schedule_mda_events .. automethod:: get_infection_status .. automethod:: update_infection_symptoms .. automethod:: do_at_generic_first_appt .. automethod:: select_test .. automethod:: reduce_susceptibility .. autoclass:: SchistoInfectionWormBurdenEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoInfectionWormBurdenEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: SchistoMatureJuvenileWormsEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoMatureJuvenileWormsEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: SchistoWormDeathEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoWormDeathEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: SchistoMDAEvent Bases: :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoMDAEvent):** .. automethod:: __init__ .. automethod:: apply .. automethod:: _select_recipients .. autoclass:: SchistoWashScaleUp Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoWashScaleUp):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_Schisto_TestingFollowingSymptoms Bases: :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_Schisto_TestingFollowingSymptoms):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_Schisto_TreatmentFollowingDiagnosis Bases: :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_Schisto_TreatmentFollowingDiagnosis):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: HSI_Schisto_MDA Bases: :class:`tlo.methods.hsi_event.HSI_Event`, :class:`tlo.events.IndividualScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class HSI_Schisto_MDA):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: SchistoPersonDaysLoggingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoPersonDaysLoggingEvent):** .. automethod:: __init__ .. automethod:: apply .. autoclass:: SchistoLoggingEvent Bases: :class:`tlo.events.RegularEvent`, :class:`tlo.events.Event`, :class:`tlo.events.PopulationScopeEventMixin` **Class attributes:** __annotations__ : {} **Functions (defined or overridden in class SchistoLoggingEvent):** .. automethod:: __init__ .. automethod:: apply