Blue Brain BioExplorer
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
sonataexplorer::neuroscience::neuron::AbstractCircuitLoader Class Reference

#include <AbstractCircuitLoader.h>

Inheritance diagram for sonataexplorer::neuroscience::neuron::AbstractCircuitLoader:
Inheritance graph
[legend]
Collaboration diagram for sonataexplorer::neuroscience::neuron::AbstractCircuitLoader:
Collaboration graph
[legend]

Public Member Functions

 AbstractCircuitLoader (core::Scene &scene, const core::ApplicationParameters &applicationParameters, core::PropertyMap &&loaderParams)
 
core::PropertyMap getProperties () const final
 
strings getSupportedStorage () const
 
bool isSupported (const std::string &filename, const std::string &extension) const
 
core::ModelDescriptorPtr importFromBlob (core::Blob &&blob, const core::LoaderProgress &callback, const core::PropertyMap &properties) const
 
core::ModelDescriptorPtr importCircuit (const std::string &circuitConfig, const core::PropertyMap &properties, const core::LoaderProgress &callback) const
 Imports morphology from a circuit for the given target name. More...
 
size_ts _populateLayerIds (const core::PropertyMap &props, const brion::BlueConfig &blueConfig, const brain::GIDSet &gids) const
 _populateLayerIds populates the neuron layer IDs. This is currently only supported for the MVD2 format. More...
 
- Public Member Functions inherited from core::Loader
 Loader (Scene &scene)
 
virtual ~Loader ()=default
 
virtual std::string getName () const =0
 
virtual ModelDescriptorPtr importFromStorage (const std::string &storage, const LoaderProgress &callback, const PropertyMap &properties) const =0
 

Static Public Member Functions

static void setSimulationTransferFunction (core::TransferFunction &tf, const float finalOpacity=1.f)
 

Protected Attributes

const core::ApplicationParameters & _applicationParameters
 
core::PropertyMap _defaults
 
core::PropertyMap _fixedDefaults
 
- Protected Attributes inherited from core::Loader
Scene & _scene
 

Detailed Description

Load circuit from BlueConfig or CircuitConfig file, including simulation.

Definition at line 48 of file AbstractCircuitLoader.h.

Constructor & Destructor Documentation

◆ AbstractCircuitLoader()

sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::AbstractCircuitLoader ( core::Scene &  scene,
const core::ApplicationParameters &  applicationParameters,
core::PropertyMap &&  loaderParams 
)

Definition at line 68 of file AbstractCircuitLoader.cpp.

Member Function Documentation

◆ _populateLayerIds()

size_ts sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::_populateLayerIds ( const core::PropertyMap &  props,
const brion::BlueConfig &  blueConfig,
const brain::GIDSet &  gids 
) const

_populateLayerIds populates the neuron layer IDs. This is currently only supported for the MVD2 format.

Parameters
blueConfigConfiguration of the circuit
gidsGIDs of the neurons

Definition at line 506 of file AbstractCircuitLoader.cpp.

◆ getProperties()

PropertyMap sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::getProperties ( ) const
finalvirtual
Returns
The loader properties

Reimplemented from core::Loader.

Definition at line 903 of file AbstractCircuitLoader.cpp.

◆ getSupportedStorage()

std::vector< std::string > sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::getSupportedStorage ( ) const
virtual
Returns
The loaders supported file extensions

Implements core::Loader.

Definition at line 76 of file AbstractCircuitLoader.cpp.

◆ importCircuit()

ModelDescriptorPtr sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::importCircuit ( const std::string &  circuitConfig,
const core::PropertyMap &  properties,
const core::LoaderProgress &  callback 
) const

Imports morphology from a circuit for the given target name.

Parameters
circuitConfigURI of the Circuit Config file
Returns
ModelDescriptor if the circuit is successfully loaded, nullptr if the circuit contains no cells.

Definition at line 322 of file AbstractCircuitLoader.cpp.

◆ importFromBlob()

ModelDescriptorPtr sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::importFromBlob ( core::Blob &&  blob,
const core::LoaderProgress &  callback,
const core::PropertyMap &  properties 
) const
virtual

Import the data from the blob and return the created model.

Parameters
blobthe blob containing the data to import
callbackCallback for loader progress
propertiesProperties used for loading
Returns
the model that has been created by the loader

Implements core::Loader.

Definition at line 897 of file AbstractCircuitLoader.cpp.

◆ isSupported()

bool sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::isSupported ( const std::string &  filename,
const std::string &  extension 
) const
virtual

Query the loader if it can load the given file

Implements core::Loader.

Definition at line 81 of file AbstractCircuitLoader.cpp.

◆ setSimulationTransferFunction()

void sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::setSimulationTransferFunction ( core::TransferFunction &  tf,
const float  finalOpacity = 1.f 
)
static

Definition at line 640 of file AbstractCircuitLoader.cpp.

Member Data Documentation

◆ _applicationParameters

const core::ApplicationParameters& sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::_applicationParameters
protected

Definition at line 84 of file AbstractCircuitLoader.h.

◆ _defaults

core::PropertyMap sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::_defaults
protected

Definition at line 85 of file AbstractCircuitLoader.h.

◆ _fixedDefaults

core::PropertyMap sonataexplorer::neuroscience::neuron::AbstractCircuitLoader::_fixedDefaults
protected

Definition at line 86 of file AbstractCircuitLoader.h.

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