Brion  1.8.0
The Blue Brain C++ I/O library
brain::Circuit Class Reference

Read access to a circuit database. More...

#include <circuit.h>

+ Inheritance diagram for brain::Circuit:
+ Collaboration diagram for brain::Circuit:

Public Types

enum  Coordinates { COORDINATES_GLOBAL, COORDINATES_LOCAL }
 Coordinate system to use for circuit morphologies.
 

Public Member Functions

 Circuit (const URI &source)
 Opens a circuit for read access. More...
 
 Circuit (const brion::BlueConfig &blueConfig)
 Opens a circuit for read access. More...
 
GIDSet getGIDs (const std::string &target) const
 
GIDSet getGIDs () const
 
URIs getMorphologyURIs (const GIDSet &gids) const
 
neuron::Morphologies loadMorphologies (const GIDSet &gids, Coordinates coords) const
 
Vector3fs getPositions (const GIDSet &gids) const
 
size_ts getMorphologyTypes (const GIDSet &gids) const
 
Strings getMorphologyNames () const
 
size_ts getElectrophysiologyTypes (const GIDSet &gids) const
 
Strings getElectrophysiologyNames () const
 
Matrix4fs getTransforms (const GIDSet &gids) const
 
Quaternionfs getRotations (const GIDSet &gids) const
 
size_t getNumNeurons () const
 

Detailed Description

Read access to a circuit database.

This class provides convenience functions to access information about the cells inside the circuit and their morphologies.

Definition at line 39 of file brain/circuit.h.

Constructor & Destructor Documentation

brain::Circuit::Circuit ( const URI &  source)
explicit

Opens a circuit for read access.

Parameters
sourcethe URI to the CircuitConfig or BlueConfig file.
brain::Circuit::Circuit ( const brion::BlueConfig blueConfig)
explicit

Opens a circuit for read access.

Parameters
blueConfigThe object representing the BlueConfig.

Member Function Documentation

Strings brain::Circuit::getElectrophysiologyNames ( ) const
Returns
The electrophysiology type names of the circuit, indexed by getElectrophysiologyTypes().
size_ts brain::Circuit::getElectrophysiologyTypes ( const GIDSet &  gids) const
Returns
The electrophysiology type indices of the given cells.
GIDSet brain::Circuit::getGIDs ( const std::string &  target) const
Returns
The set of GIDs for the given target name. If empty it will return all the GIDs held by the circuit. If the target cannot be found, a runtime exception is raised.
GIDSet brain::Circuit::getGIDs ( ) const
Returns
All GIDs held by the circuit
Strings brain::Circuit::getMorphologyNames ( ) const
Returns
The morphology type names of the circuit, indexed by getMorphologyTypes().
size_ts brain::Circuit::getMorphologyTypes ( const GIDSet &  gids) const
Returns
The morphology type indices of the given cells.
URIs brain::Circuit::getMorphologyURIs ( const GIDSet &  gids) const
Returns
The set of URIs to access the morphologies of the given cells
size_t brain::Circuit::getNumNeurons ( ) const
Returns
The number of neurons in the circuit.
Vector3fs brain::Circuit::getPositions ( const GIDSet &  gids) const
Returns
The positions of the given cells.
Quaternionfs brain::Circuit::getRotations ( const GIDSet &  gids) const
Returns
The local to world rotation of the given cells.
Matrix4fs brain::Circuit::getTransforms ( const GIDSet &  gids) const
Returns
The local to world transformations of the given cells.
neuron::Morphologies brain::Circuit::loadMorphologies ( const GIDSet &  gids,
Coordinates  coords 
) const
Returns
The list of morpholgies for the GID set. If local coordinates are requested, morpholgies that are repeated in the circuit will shared the same Morphology object in the list. If global coordinates are requested, all Morphology objects are unique.

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