Brion  2.0.0
The Blue Brain C++ I/O library
brain::Synapse Class Reference

A proxy object returned by the Synapses container to access data for a particular synapse. More...

#include <synapse.h>

+ Collaboration diagram for brain::Synapse:

Public Member Functions

SynapseGID getGID () const
 
Presynaptic topological and geometrical attributes
uint32_t getPresynapticGID () const
 
uint32_t getPresynapticSectionID () const
 
uint32_t getPresynapticSegmentID () const
 
float getPresynapticDistance () const
 
Vector3f getPresynapticSurfacePosition () const
 
Vector3f getPresynapticCenterPosition () const
 
uint32_t getPostsynapticGID () const
 
uint32_t getPostsynapticSectionID () const
 
uint32_t getPostsynapticSegmentID () const
 
float getPostsynapticDistance () const
 
Vector3f getPostsynapticSurfacePosition () const
 
Vector3f getPostsynapticCenterPosition () const
 
Synaptic model attributes
float getDelay () const
 
float getConductance () const
 
float getUtilization () const
 
float getDepression () const
 
float getFacilitation () const
 
float getDecay () const
 
int getEfficacy () const
 

Friends

class Synapses
 

Detailed Description

A proxy object returned by the Synapses container to access data for a particular synapse.

The lifetime of this object is stricly bound to the synapses container it comes from.

Definition at line 35 of file brain/synapse.h.

Member Function Documentation

float brain::Synapse::getConductance ( ) const
Returns
the conductance in nanosiemens.
float brain::Synapse::getDecay ( ) const
Returns
the decay time constant in milliseconds.
float brain::Synapse::getDelay ( ) const
Returns
the axonal delay in milliseconds.
float brain::Synapse::getDepression ( ) const
Returns
the depression time constant in milliseconds.
int brain::Synapse::getEfficacy ( ) const
Returns
the absolute synaptic efficacy in millivolts.
float brain::Synapse::getFacilitation ( ) const
Returns
the facilitation time constant in milliseconds.
SynapseGID brain::Synapse::getGID ( ) const
Returns
the synapse GID containing GID of the post-synaptic cell and the index in the afferent contacts array.
Exceptions
std::runtime_errorif index information not found in the synapse source of the circuit.
Vector3f brain::Synapse::getPostsynapticCenterPosition ( ) const
Returns
the postsynaptic touch position in the center of the segment.
float brain::Synapse::getPostsynapticDistance ( ) const
Returns
the distance from the beginning of the postsynaptic segment to the synapse in micrometers.
uint32_t brain::Synapse::getPostsynapticGID ( ) const
Returns
the GID of the postsynaptic neuron.
uint32_t brain::Synapse::getPostsynapticSectionID ( ) const
Returns
the section ID on the postsynaptic neuron.
uint32_t brain::Synapse::getPostsynapticSegmentID ( ) const
Returns
the segment ID on the postsynaptic neuron.
Vector3f brain::Synapse::getPostsynapticSurfacePosition ( ) const
Returns
the postsynaptic touch position on the surface of the segment.
Vector3f brain::Synapse::getPresynapticCenterPosition ( ) const
Returns
the presynaptic touch position in the center of the segment.
float brain::Synapse::getPresynapticDistance ( ) const
Returns
the distance from the beginning of the presynaptic segment to the synapse in micrometers.
uint32_t brain::Synapse::getPresynapticGID ( ) const
Returns
the GID of the presynaptic neuron.
uint32_t brain::Synapse::getPresynapticSectionID ( ) const
Returns
the section ID on the presynaptic neuron.
uint32_t brain::Synapse::getPresynapticSegmentID ( ) const
Returns
the segment ID on the presynaptic neuron.
Vector3f brain::Synapse::getPresynapticSurfacePosition ( ) const
Returns
the presynaptic touch position on the surface of the segment.
float brain::Synapse::getUtilization ( ) const
Returns
the neuro-transmitter release probability.

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