sonataexplorer::neuroscience::neuron::MEGHandler Class Reference

The MEGHandler class handles electro-magnetic fields data structures. More...

#include <MEGHandler.h>

Inheritance diagram for sonataexplorer::neuroscience::neuron::MEGHandler:

Collaboration diagram for sonataexplorer::neuroscience::neuron::MEGHandler:

Public Member Functions
	MEGHandler (const std::string &circuitConfiguration, const std::string &reportName, const bool synchronous)
	Constructs a MEGHandler object from a circuit configuration and a report name. More...
	MEGHandler (const MEGHandler &rhs)
	Construct a new MEGHandler object. More...
	~MEGHandler ()
	Destroy the Fields Handler object. More...
core::ModelMetadata	buildModel (core::Model &model, const double voxelSize, const double density)
	Builds a Model object based on simulation parameters. More...
void *	getFrameData (const uint32_t) final
	Get the Frame Data object. More...
bool	isReady () const final
	Current state of the handler. More...
core::AbstractSimulationHandlerPtr	clone () const final
	Clone the AbstractSimulationHandler. More...
const core::Vector3ui &	getDimensions () const
	Get the Dimensions of the octree. More...
const core::Vector3f &	getSpacing () const
	Get the voxel spacing information. More...
const core::Vector3f &	getOffset () const
	Get the offset of the octree. More...
bool	isSynchronized () const
	Returns whether the object is operating in synchronous mode. More...
Public Member Functions inherited from core::AbstractSimulationHandler
virtual	~AbstractSimulationHandler ()
AbstractSimulationHandler &	operator= (const AbstractSimulationHandler &rhs)
virtual PLATFORM_API void	bind (const MaterialPtr &)
virtual PLATFORM_API void	unbind (const MaterialPtr &)
uint32_t	getCurrentFrame () const
uint64_t	getFrameSize () const
	getFrameSize return the size of the current simulation frame More...
void	setFrameSize (const uint64_t frameSize)
	setFrameSize Sets the size of the current simulation frame More...
uint32_t	getNbFrames () const
	getNbFrames returns the number of frame for the current simulation More...
void	setNbFrames (const uint32_t nbFrames)
	setNbFrames sets the number of frame for the current simulation More...
double	getDt () const
const std::string &	getUnit () const
virtual void	waitReady () const

Additional Inherited Members
Protected Member Functions inherited from core::AbstractSimulationHandler
uint32_t	_getBoundedFrame (const uint32_t frame) const
Protected Attributes inherited from core::AbstractSimulationHandler
uint32_t	_currentFrame {std::numeric_limits<uint32_t>::max()}
uint32_t	_nbFrames {0}
uint64_t	_frameSize {0}
double	_dt {0}
std::string	_unit
floats	_frameData

Detailed Description

The MEGHandler class handles electro-magnetic fields data structures.

Definition at line 43 of file MEGHandler.h.

Constructor & Destructor Documentation

MEGHandler() [1/2]

sonataexplorer::neuroscience::neuron::MEGHandler::MEGHandler	(	const std::string &	circuitConfiguration,
		const std::string &	reportName,
		const bool	synchronous
	)

Constructs a MEGHandler object from a circuit configuration and a report name.

Parameters

circuitConfiguration	A string representing the circuit configuration.
reportName	A string representing the voltage report name.
synchronous	A boolean indicating whether synchronous mode is enabled or not.

Definition at line 57 of file MEGHandler.cpp.

MEGHandler() [2/2]

sonataexplorer::neuroscience::neuron::MEGHandler::MEGHandler

(

const MEGHandler &

rhs

)

Construct a new MEGHandler object.

Parameters

rhs	A copy of the MEGHandler object

Definition at line 96 of file MEGHandler.cpp.

~MEGHandler()

sonataexplorer::neuroscience::neuron::MEGHandler::~MEGHandler

(

)

Destroy the Fields Handler object.

Definition at line 101 of file MEGHandler.cpp.

Member Function Documentation

buildModel()

ModelMetadata sonataexplorer::neuroscience::neuron::MEGHandler::buildModel	(	core::Model &	model,
		const double	voxelSize,
		const double	density
	)

Builds a Model object based on simulation parameters.

Parameters

model	A reference to a Model object.
voxelSize	The size of a single voxel in the MEG data.
density	The density of the MEG data.

Returns

A ModelMetadata object representing the simulation parameters.

Exceptions

An	exception if density is greater than 1 or less than or equal to 0.

Definition at line 103 of file MEGHandler.cpp.

clone()

AbstractSimulationHandlerPtr sonataexplorer::neuroscience::neuron::MEGHandler::clone ( ) const

finalvirtual

Clone the AbstractSimulationHandler.

Returns

AbstractSimulationHandlerPtr Clone of the AbstractSimulationHandler

Implements core::AbstractSimulationHandler.

Definition at line 254 of file MEGHandler.cpp.

getDimensions()

const core::Vector3ui& sonataexplorer::neuroscience::neuron::MEGHandler::getDimensions ( ) const

inline

Get the Dimensions of the octree.

Returns

const Vector3ui& Dimensions of the octree

Definition at line 111 of file MEGHandler.h.

getFrameData()

void * sonataexplorer::neuroscience::neuron::MEGHandler::getFrameData ( const uint32_t  frame )

finalvirtual

Get the Frame Data object.

Returns

void* A buffer of the data for the current frame

Reimplemented from core::AbstractSimulationHandler.

Definition at line 194 of file MEGHandler.cpp.

getOffset()

const core::Vector3f& sonataexplorer::neuroscience::neuron::MEGHandler::getOffset ( ) const

inline

Get the offset of the octree.

Returns

const Vector3f& Offset of the octree

Definition at line 125 of file MEGHandler.h.

getSpacing()

const core::Vector3f& sonataexplorer::neuroscience::neuron::MEGHandler::getSpacing ( ) const

inline

Get the voxel spacing information.

Returns

const Vector3f& The voxel spacing information

Definition at line 118 of file MEGHandler.h.

isReady()

bool sonataexplorer::neuroscience::neuron::MEGHandler::isReady ( ) const

inlinefinalvirtual

Current state of the handler.

Returns

true The data is loaded in memory and available

false The data is not yet available

Reimplemented from core::AbstractSimulationHandler.

Definition at line 96 of file MEGHandler.h.

isSynchronized()

bool sonataexplorer::neuroscience::neuron::MEGHandler::isSynchronized ( ) const

inline

Returns whether the object is operating in synchronous mode.

Returns

true if the object is operating in synchronous mode, false otherwise.

Definition at line 133 of file MEGHandler.h.

---

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

• bioexplorer/backend/plugins/Sonata/plugin/neuroscience/neuron/MEGHandler.h
• bioexplorer/backend/plugins/Sonata/plugin/neuroscience/neuron/MEGHandler.cpp