bbp::sonata::ReportReader< KeyType >::Population Class Reference

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

Member Function Documentation

get()

template<typename KeyType >

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

Parameters

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.

getDataUnits()

template<typename KeyType >

std::string bbp::sonata::ReportReader< KeyType >::Population::getDataUnits

(

)

const

Return the unit of data.

getNodeIdElementIdMapping()

template<typename KeyType >

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:

• For Soma report reader, the return value will be the Node ID to which the report value belongs to.
• For Element/full compartment readers, the return value will be an array with 2 elements, the first element is the Node ID and the second element is the compartment ID of the given Node.

Parameters

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

getNodeIds()

template<typename KeyType >

std::vector<NodeID> bbp::sonata::ReportReader< KeyType >::Population::getNodeIds

(

)

const

Return all the node ids.

getSorted()

template<typename KeyType >

bool bbp::sonata::ReportReader< KeyType >::Population::getSorted

(

)

const

Return true if the data is sorted.

getTimes()

template<typename KeyType >

std::tuple<double, double, double> bbp::sonata::ReportReader< KeyType >::Population::getTimes

(

)

const

Return (tstart, tstop, tstep) of the population

getTimeUnits()

template<typename KeyType >

std::string bbp::sonata::ReportReader< KeyType >::Population::getTimeUnits

(

)

const

Return the unit of time