SpineEntry Class Reference

#include <SpineEntry.h>

Collaboration diagram for SpineEntry:

[legend]

List of all members.

Public Member Functions
	SpineEntry (Id shaft, Id head, unsigned int parent)
	SpineEntry ()
unsigned int	parent () const
	Returns index of parent entry located on NeuroMesh.
void	setParent (unsigned int parent)
	Assigns index of parent entry located on NeuroMesh.
unsigned int	fid () const
	Returns index of self. Only a single voxel.
Id	shaftId () const
Id	headId () const
	Returns Id of shaft electrical compartment.
void	matchCubeMeshEntriesToHead (const ChemCompt *compt, unsigned int myIndex, double granularity, vector< VoxelJunction > &ret) const
	Returns Id of head electrical compartment.
void	matchCubeMeshEntriesToPSD (const ChemCompt *compt, unsigned int myIndex, double granularity, vector< VoxelJunction > &ret) const
unsigned int	matchNeuroMeshEntriesToShaft (const ChemCompt *compt, unsigned int myIndex, double &area, double &length) const
double	volume () const
	Return volume of spine. Ignores shaft volume. Virtual func.
void	mid (double &x, double &y, double &z) const
	Return coords of centre of spine head.
void	apex (double &x, double &y, double &z) const
	Return coords of middle of PSD.
void	matchCubeMeshEntries (const ChemCompt *other, unsigned int myIndex, double granularity, vector< VoxelJunction > &ret)
double	rootArea () const
double	headArea () const
double	diffusionLength () const
void	setVolume (double volume)
void	positionShaftBase (double x, double y, double z)
vector< double >	psdCoords () const

---

Detailed Description

Helper class for the SpineMesh. Defines a single spine.

---

Constructor & Destructor Documentation

SpineEntry::SpineEntry	(	Id	shaft,
		Id	head,
		unsigned int	parent
	)

This builds the node using info from the compartment.

Helper class for the SpineMesh. Defines the geometry of the spine and provides the innter function for mapping to CubeMeshes.

References CylBase::setDia(), CylBase::setIsCylinder(), CylBase::setLength(), CylBase::setNumDivs(), CylBase::setX(), CylBase::setY(), and CylBase::setZ().

Here is the call graph for this function:

SpineEntry::SpineEntry

(

)

Empty constructor for vectors

References CylBase::setDia(), CylBase::setIsCylinder(), CylBase::setLength(), CylBase::setNumDivs(), CylBase::setX(), CylBase::setY(), and CylBase::setZ().

Here is the call graph for this function:

---

Member Function Documentation

void SpineEntry::apex	(	double &	x,
		double &	y,
		double &	z
	)			const

Return coords of middle of PSD.

double SpineEntry::diffusionLength

(

)

const

References CylBase::getLength().

Here is the call graph for this function:

unsigned int SpineEntry::fid

(

)

const

Returns index of self. Only a single voxel.

double SpineEntry::headArea

(

)

const

Id SpineEntry::headId

(

)

const

Returns Id of shaft electrical compartment.

void SpineEntry::matchCubeMeshEntries	(	const ChemCompt *	other,
		unsigned int	myIndex,
		double	granularity,
		vector< VoxelJunction > &	ret
	)

void SpineEntry::matchCubeMeshEntriesToHead	(	const ChemCompt *	compt,
		unsigned int	myIndex,
		double	granularity,
		vector< VoxelJunction > &	ret
	)			const

Returns Id of head electrical compartment.

Generate list of matching CubeMesh entries to the single Head entry.

void SpineEntry::matchCubeMeshEntriesToPSD	(	const ChemCompt *	compt,
		unsigned int	myIndex,
		double	granularity,
		vector< VoxelJunction > &	ret
	)			const

Generate list of matching CubeMeshEntries to the single PSD.

unsigned int SpineEntry::matchNeuroMeshEntriesToShaft	(	const ChemCompt *	compt,
		unsigned int	myIndex,
		double &	area,
		double &	length
	)			const

Find the matching matching NeuroMesh entry index to the root of the shaft of this spine. Also compute the area and diffusion length of the shaft.

Find the matching NeuroMesh entry index to the root of the shaft of this spine. Also compute the area and diffusion length of the shaft.

void SpineEntry::mid	(	double &	x,
		double &	y,
		double &	z
	)			const

Return coords of centre of spine head.

References CylBase::getX(), CylBase::getY(), and CylBase::getZ().

Referenced by SpineMesh::nearest(), and psdCoords().

Here is the call graph for this function:

unsigned int SpineEntry::parent

(

)

const

Returns index of parent entry located on NeuroMesh.

void SpineEntry::positionShaftBase	(	double	x,
		double	y,
		double	z
	)

moves Spine entry so that shaft base is now positioned at xyz.

References CylBase::getX(), CylBase::getY(), CylBase::getZ(), CylBase::setX(), CylBase::setY(), and CylBase::setZ().

Here is the call graph for this function:

vector< double > SpineEntry::psdCoords

(

)

const

psdCoords is used to build the PsdMesh. The function returns 8 coords to define the psd: centre xyz direction xyz dia, diffusion distance to middle of spine Head.

References CylBase::getDia(), CylBase::getX(), CylBase::getY(), CylBase::getZ(), and mid().

Referenced by NeuroMesh::transmitSpineInfo().

Here is the call graph for this function:

double SpineEntry::rootArea

(

)

const

References CylBase::getDia(), and PI.

Here is the call graph for this function:

void SpineEntry::setParent

(

unsigned int

parent

)

Assigns index of parent entry located on NeuroMesh.

void SpineEntry::setVolume

(

double

volume

)

Resizes SpineEntry. Takes original shaft base and scales up from there. Retains original shaft dimensions, only the head is scaled.

References CylBase::getDia(), CylBase::getLength(), CylBase::getX(), CylBase::getY(), CylBase::getZ(), CylBase::setDia(), CylBase::setLength(), CylBase::setX(), CylBase::setY(), CylBase::setZ(), and CylBase::volume().

Here is the call graph for this function:

Id SpineEntry::shaftId

(

)

const

double SpineEntry::volume

(

)

const

Return volume of spine. Ignores shaft volume. Virtual func.

References CylBase::volume().

Here is the call graph for this function:

---

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

• mesh/SpineEntry.h
• mesh/SpineEntry.cpp