Brion  1.9.0
The Blue Brain C++ I/O library
brain::Synapses Class Reference

A container providing read-only access to Synapses retrieved by getXXXSynapses() functions from brain::Circuit. More...

#include <synapses.h>

+ Collaboration diagram for brain::Synapses:

Classes

struct  BaseImpl
 

Public Types

using const_iterator = SynapsesIterator
 

Public Member Functions

 ~Synapses ()
 Frees all memory on destruction of last copy. More...
 
 Synapses (const SynapsesStream &stream)
 Conversion constructor for direct access from getXXXSynapses(). More...
 
size_t size () const
 
bool empty () const
 
const_iterator begin () const
 
const_iterator end () const
 
Synapse operator[] (size_t index) const
 return the Synapse at the index-th position. More...
 
const size_t * indices () const
 
Copy semantics by data sharing.
 Synapses (const Synapses &)
 
Synapsesoperator= (const Synapses &)
 
Move semantics.
 Synapses (Synapses &&rhs)
 
Synapsesoperator= (Synapses &&rhs)
 
Presynaptic topological and geometrical attributes
const uint32_t * preGIDs () const
 
const uint32_t * preSectionIDs () const
 
const uint32_t * preSegmentIDs () const
 
const float * preDistances () const
 
const float * preSurfaceXPositions () const
 
const float * preSurfaceYPositions () const
 
const float * preSurfaceZPositions () const
 
const float * preCenterXPositions () const
 
const float * preCenterYPositions () const
 
const float * preCenterZPositions () const
 
const uint32_t * postGIDs () const
 
const uint32_t * postSectionIDs () const
 
const uint32_t * postSegmentIDs () const
 
const float * postDistances () const
 
const float * postSurfaceXPositions () const
 
const float * postSurfaceYPositions () const
 
const float * postSurfaceZPositions () const
 
const float * postCenterXPositions () const
 
const float * postCenterYPositions () const
 
const float * postCenterZPositions () const
 
Synaptic model attributes
const float * delays () const
 
const float * conductances () const
 
const float * utilizations () const
 
const float * depressions () const
 
const float * facilitations () const
 
const float * decays () const
 
const int * efficacies () const
 

Protected Attributes

std::shared_ptr< const BaseImpl_impl
 

Friends

struct detail::SynapsesStream
 

Detailed Description

A container providing read-only access to Synapses retrieved by getXXXSynapses() functions from brain::Circuit.

It provides per-object and per-array access on the various synapses attributes. Data which was not prefetched will be loaded on-demand.

This container can be iterated as well as random accessed using the operator [].

This class is thread-safe, moveable and copyable.

Definition at line 42 of file synapses.h.

Constructor & Destructor Documentation

brain::Synapses::~Synapses ( )

Frees all memory on destruction of last copy.

brain::Synapses::Synapses ( const SynapsesStream stream)

Conversion constructor for direct access from getXXXSynapses().

Member Function Documentation

const_iterator brain::Synapses::begin ( ) const
Returns
an iterator to the first synapse of this container.
const float* brain::Synapses::conductances ( ) const
Returns
the conductances in nanosiemens.
const float* brain::Synapses::decays ( ) const
Returns
the decay time constants in milliseconds.
const float* brain::Synapses::delays ( ) const
Returns
the axonal delays in milliseconds.
const float* brain::Synapses::depressions ( ) const
Returns
the depression time constants in milliseconds.
const int* brain::Synapses::efficacies ( ) const
Returns
the absolute synaptic efficacies in millivolts.
bool brain::Synapses::empty ( ) const
Returns
size() == 0.
const_iterator brain::Synapses::end ( ) const
Returns
an iterator to the past-the-end synapse of this container.
const float* brain::Synapses::facilitations ( ) const
Returns
the facilitation time constants in milliseconds.
const size_t* brain::Synapses::indices ( ) const
Returns
the synapse GIDs containing GIDs of the post-synaptic cells and the indices in the afferent contacts array.
Exceptions
std::runtime_errorif index information not found in the synapse source of the circuit.
Synapse brain::Synapses::operator[] ( size_t  index) const

return the Synapse at the index-th position.

const float* brain::Synapses::postCenterXPositions ( ) const
Returns
the postsynaptic touch position x-coordinates in the center of the segments.
const float* brain::Synapses::postCenterYPositions ( ) const
Returns
the postsynaptic touch position y-coordinates in the center of the segments.
const float* brain::Synapses::postCenterZPositions ( ) const
Returns
the postsynaptic touch position z-coordinates in the center of the segments.
const float* brain::Synapses::postDistances ( ) const
Returns
the distances in micrometer to the postsynaptic neurons.
const uint32_t* brain::Synapses::postGIDs ( ) const
Returns
the GIDs of the postsynaptic neurons.
const uint32_t* brain::Synapses::postSectionIDs ( ) const
Returns
the section IDs on the postsynaptic neurons.
const uint32_t* brain::Synapses::postSegmentIDs ( ) const
Returns
the segment IDs on the postsynaptic neurons.
const float* brain::Synapses::postSurfaceXPositions ( ) const
Returns
the postsynaptic touch position x-coordinates on the surfaces of the segments. May be null in old circuits.
const float* brain::Synapses::postSurfaceYPositions ( ) const
Returns
the postsynaptic touch position x-coordinates on the surfaces of the segments. May be null in old circuits.
const float* brain::Synapses::postSurfaceZPositions ( ) const
Returns
the postsynaptic touch position x-coordinates on the surfaces of the segments. May be null in old circuits.
const float* brain::Synapses::preCenterXPositions ( ) const
Returns
the presynaptic touch position x-coordinates in the center of the segments.
const float* brain::Synapses::preCenterYPositions ( ) const
Returns
the presynaptic touch position y-coordinates in the center of the segments.
const float* brain::Synapses::preCenterZPositions ( ) const
Returns
the presynaptic touch position z-coordinates in the center of the segments.
const float* brain::Synapses::preDistances ( ) const
Returns
the distances in micrometer to the presynaptic neurons.
const uint32_t* brain::Synapses::preGIDs ( ) const
Returns
the GIDs of the presynaptic neurons.
const uint32_t* brain::Synapses::preSectionIDs ( ) const
Returns
the section IDs on the presynaptic neurons.
const uint32_t* brain::Synapses::preSegmentIDs ( ) const
Returns
the segment IDs on the presynaptic neurons.
const float* brain::Synapses::preSurfaceXPositions ( ) const
Returns
the presynaptic touch position x-coordinates on the surfaces of the segments. May be null in old circuits.
const float* brain::Synapses::preSurfaceYPositions ( ) const
Returns
the presynaptic touch position y-coordinates on the surfaces of the segments. May be null in old circuits.
const float* brain::Synapses::preSurfaceZPositions ( ) const
Returns
the presynaptic touch position z-coordinates on the surfaces of the segments. May be null in old circuits.
size_t brain::Synapses::size ( ) const
Returns
number of synapses available in this container.
const float* brain::Synapses::utilizations ( ) const
Returns
the neuro-transmitter release probabilities.

The documentation for this class was generated from the following file: