Public Member Functions | |
std::tuple< double, double, double > | getTimes () const |
std::string | getTimeUnits () const |
std::string | getDataUnits () const |
bool | getSorted () const |
std::vector< NodeID > | getNodeIds () const |
DataFrame< KeyType >::DataType | getNodeIdElementIdMapping (const nonstd::optional< Selection > &node_ids=nonstd::nullopt, const nonstd::optional< size_t > &block_gap_limit=nonstd::nullopt) const |
DataFrame< KeyType > | get (const nonstd::optional< Selection > &node_ids=nonstd::nullopt, const nonstd::optional< double > &tstart=nonstd::nullopt, const nonstd::optional< double > &tstop=nonstd::nullopt, const nonstd::optional< size_t > &tstride=nonstd::nullopt, const nonstd::optional< size_t > &block_gap_limit=nonstd::nullopt) const |
DataFrame<KeyType> bbp::sonata::ReportReader< KeyType >::Population::get | ( | const nonstd::optional< Selection > & | node_ids = nonstd::nullopt , |
const nonstd::optional< double > & | tstart = nonstd::nullopt , |
||
const nonstd::optional< double > & | tstop = nonstd::nullopt , |
||
const nonstd::optional< size_t > & | tstride = nonstd::nullopt , |
||
const nonstd::optional< size_t > & | block_gap_limit = nonstd::nullopt |
||
) | const |
node_ids | limit the report to the given selection. |
tstart | return voltages occurring on or after tstart. tstart=nonstd::nullopt indicates no limit. |
tstop | return voltages occurring on or before tstop. tstop=nonstd::nullopt indicates no limit. |
tstride | indicates every how many timesteps we read data. tstride=nonstd::nullopt indicates that all timesteps are read. |
block_gap_limit | gap limit between each IO block while fetching data from storage. |
std::string bbp::sonata::ReportReader< KeyType >::Population::getDataUnits | ( | ) | const |
Return the unit of data.
DataFrame<KeyType>::DataType bbp::sonata::ReportReader< KeyType >::Population::getNodeIdElementIdMapping | ( | const nonstd::optional< Selection > & | node_ids = nonstd::nullopt , |
const nonstd::optional< size_t > & | block_gap_limit = nonstd::nullopt |
||
) | const |
Return the ElementIds for the passed Node. The return type will depend on the report reader:
node_ids | limit the report to the given selection. If nullptr, all nodes in the report are used |
block_gap_limit | gap limit between each IO block while fetching data from storage |
std::vector<NodeID> bbp::sonata::ReportReader< KeyType >::Population::getNodeIds | ( | ) | const |
Return all the node ids.
bool bbp::sonata::ReportReader< KeyType >::Population::getSorted | ( | ) | const |
Return true if the data is sorted.
std::tuple<double, double, double> bbp::sonata::ReportReader< KeyType >::Population::getTimes | ( | ) | const |
Return (tstart, tstop, tstep) of the population
std::string bbp::sonata::ReportReader< KeyType >::Population::getTimeUnits | ( | ) | const |
Return the unit of time