Public Types | Public Attributes
bbp::sonata::SimulationConfig::Report Struct Reference

#include <config.h>

Public Types

enum  Sections {
  invalid = -1, soma, axon, dend,
  apic, all
}
 
enum  Type {
  invalid = -1, compartment, lfp, summation,
  synapse
}
 
enum  Scaling { invalid = -1, none, area }
 
enum  Compartments { invalid = -1, center, all }
 

Public Attributes

std::string cells
 Node sets on which to report.
 
Sections sections
 Sections on which to report. Default value: "soma".
 
Type type
 Report type.
 
Scaling scaling
 
Compartments compartments
 
std::string variableName
 
std::string unit
 Descriptive text of the unit recorded. Not validated for correctness.
 
double dt {}
 Interval between reporting steps in milliseconds.
 
double startTime {}
 Time to step reporting in milliseconds.
 
double endTime {}
 Time to stop reporting in milliseconds.
 
std::string fileName
 Report filename. Default is "<report name>.h5".
 
bool enabled = true
 Allows for suppressing a report so that is not created. Default is true.
 

Detailed Description

List of report parameters collected during the simulation

Member Data Documentation

◆ compartments

Compartments bbp::sonata::SimulationConfig::Report::compartments

For compartment type, select compartments to report. Default value: "center"(for sections: soma), "all"(for other sections)

◆ scaling

Scaling bbp::sonata::SimulationConfig::Report::scaling

For summation type, specify the handling of density values. Default value: "area"

◆ variableName

std::string bbp::sonata::SimulationConfig::Report::variableName

The simulation variable to access. The variables available are model dependent. For summation type, it supports multiple variables by comma separated strings. E.g. “ina”, "AdEx.V_M, v", "i_membrane, IClamp".