ReportEventCounter

The event counter report (ReportEventCounter.json) is a JSON-formatted file that keeps track of how many of each event types occurs during a time step. The report produced is similar to the InsetChart.json channel report, where there is one channel for each event defined in the configuration file (config.json). This report only counts events; a similar report, software-report-event-recorder, will provide information about the person at the time of the event.

Configuration

The following parameters need to be configured to generate the report:

Parameter	Data type	Min	Max	Default	Description
Filename_Suffix	string	NA	NA	(empty string)	Augments the filename of the report. If multiple reports are being generated, this allows you to distinguish among the multiple reports.
Start_Day	float	0	3.40282e+38	0	The day of the simulation to start collecting data.
End_Day	float	0	3.40282e+38	3.40282e+38	The day of the simulation to stop collecting data.
Node_IDs_Of_Interest	array of integers	0	2.14748e+09	[]	Data will be collected for the nodes in this list. Empty list implies all nodes.
Min_Age_Years	float	0	9.3228e+35	0	Minimum age in years of people to collect data on.
Max_Age_Years	float	0	9.3228e+35	9.3228e+35	Maximum age in years of people to collect data on.
Must_Have_IP_Key_Value	string	NA	NA	(empty string)	A Key:Value pair that the individual must have in order to be included. Empty string means to not include IPs in the selection criteria.
Must_Have_Intervention	string	NA	NA	(empty string)	The name of the intervention that the person must have in order to be included. Empty string means to not include interventions in the selection criteria.
Event_Trigger_List	list of strings	NA	NA	NA	The list of event triggers for the events included in the report. There will be a channel in the report for each event.

{
    "Reports": [{
        "class": "ReportEventCounter",
        "Filename_Suffix": "Node1",
        "Start_Day": 365,
        "End_Day": 465,
        "Node_IDs_Of_Interest": [ 1 ],
        "Min_Age_Years": 5,
        "Max_Age_Years": 10,
        "Must_Have_IP_Key_Value": "Risk:HIGH",
        "Must_Have_Intervention": "SimpleVaccine",
        "Event_Trigger_List": ["NewInfectionEvent", "NewClinicalCase"]
    }],
    "Use_Defaults": 1
}

Header

The header section contains the following parameters:

Parameter	Data type	Description
Channels	integer	The number of entries in the 'Channels' map (e.g. the number of events that the report is counting).
DTK_Version	string	The version of EMOD that was used.
DateTime	string	The date and time the report was created.
Report_Type	string	The type of report created (it should always be InsetChart/Channel Report).
Report_Version	string	The version of the report format.
Simulation_Timestep	integer	The number of days in one time step of the simulation.
Timesteps	integer	The number of time steps recorded in the file. Each channel should have this number of entries.

Channels

The channels section contains the following parameters:

Parameter	Data type	Description
<Event Names>	string	The name of the event.
Data	array	An array of event counts where each entry is the number of events that occurred during the timestep.
Units	string	Empty string, but it is the 'event count'.

Example

The following is an example of ReportEventCounter.json.

{
    "Header": {
        "Channels": 4,
        "DTK_Version": "4148 Malaria-Ongoing (bb265ad) May 16 2019 09:39:35",
        "DateTime": "Tue Mar 12 15:16:08 2019",
        "Report_Type": "InsetChart",
        "Report_Version": "3.2",
        "Simulation_Timestep": 1,
        "Start_Time": 0,
        "Timesteps": 3
    },
    "Channels": {
        "Births": {"Data": [0, 1, 1], "Units": ""},
        "EveryUpdate": {"Data": [1000, 1001, 1002], "Units": ""},
        "NewInfectionEvent": {"Data": [110, 0, 2], "Units": ""},
        "NonDiseaseDeaths": {"Data": [0, 0, 0], "Units": ""}
    }
}