nsol  0.4.1
Nsol - Neuroscience Objects Library
nsol::NeuronMorphology Class Reference

A class to represent morphology of neurons. More...

#include <NeuronMorphology.h>

+ Inheritance diagram for nsol::NeuronMorphology:
+ Collaboration diagram for nsol::NeuronMorphology:

Public Member Functions

 NeuronMorphology (void)
 Default Neuron class constructor. More...
 
 NeuronMorphology (SomaPtr soma)
 
SomaPtr soma (SomaPtr soma)
 Method to set the neuronal soma. More...
 
NeuritePtr addNeurite (NeuritePtr neurite)
 Method to add a new neurite to the neuron. More...
 
Dendritesdendrites (void) const
 Method to get all the dendrites in a container. More...
 
DendritesbasalDendrites (void) const
 Method to get all the basal dendrites in a container. More...
 
DendritesapicalDendrites (void) const
 Method to get all the apical dendrites in a container. More...
 
DendritePtr apicalDendrite (void) const
 Method to get the first apical dendrite. More...
 
Axons * axons () const
 Method to get all the axons in a container. More...
 
virtual Neuritesneurites (void)
 
const Neuritesneurites (void) const
 
virtual Neurons & parentNeurons (void)
 
const Neurons & parentNeurons (void) const
 
SomaPtr soma (void)
 
virtual NeuronMorphologyStatsstats (void)
 
void addParentNeuron (NeuronPtr neuron)
 
virtual NeuronMorphologyPtr asNeuronMorphology (void)
 
virtual NeuronMorphologyPtr clone (void) const
 
bool operator== (NeuronMorphology &other)
 
bool operator!= (NeuronMorphology &other)
 
- Public Member Functions inherited from nsol::Morphology
Sectionssections (void)
 
- Public Member Functions inherited from nsol::Object
virtual ColumnPtr asColumn (void)
 
virtual MiniColumnPtr asMiniColumn (void)
 
virtual NeuronPtr asNeuron (void)
 
virtual SectionPtr asSection (void)
 
virtual NodePtr asNode (void)
 
virtual ObjectWithPropertiesproperties (void)
 
virtual ObjectPtr create (void)
 

Protected Attributes

SomaPtr _soma
 
Neurites _neurites
 
Neurons _parentNeurons
 
- Protected Attributes inherited from nsol::Morphology
Sections _sections
 Morphology sections.
 

Detailed Description

A class to represent morphology of neurons.

TODO: extend long description

Definition at line 50 of file NeuronMorphology.h.

Constructor & Destructor Documentation

nsol::NeuronMorphology::NeuronMorphology ( void  )

Default Neuron class constructor.

TODO: construct protected objects

Member Function Documentation

NeuritePtr nsol::NeuronMorphology::addNeurite ( NeuritePtr  neurite)

Method to add a new neurite to the neuron.

Parameters
neuritepointer to the neurite to be added.
Returns
pointer to the added neurite.

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::readMorphology(), and nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::readMorphology().

+ Here is the caller graph for this function:

DendritePtr nsol::NeuronMorphology::apicalDendrite ( void  ) const

Method to get the first apical dendrite.

Returns
pointer to the apical dendrite.
Dendrites* nsol::NeuronMorphology::apicalDendrites ( void  ) const

Method to get all the apical dendrites in a container.

Memory for the container is allocated.

Returns
pointer to the container of Dendrites
Axons* nsol::NeuronMorphology::axons ( ) const

Method to get all the axons in a container.

Memory for the container is allocated.

Returns
pointer to the container of Axons.
Dendrites* nsol::NeuronMorphology::basalDendrites ( void  ) const

Method to get all the basal dendrites in a container.

Memory for the container is allocated.

Returns
pointer to the container of Dendrites
Dendrites* nsol::NeuronMorphology::dendrites ( void  ) const

Method to get all the dendrites in a container.

Memory for the container is allocated.

Returns
pointer to the container of Dendrites
SomaPtr nsol::NeuronMorphology::soma ( SomaPtr  soma)

Method to set the neuronal soma.

Parameters
somapointer to the soma to be setted.
Returns
pointer to the setted soma

Referenced by nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::_ReadSoma(), nsol::SwcReaderTemplated< SWC_READER_TEMPLATE_CLASSES >::readMorphology(), and nsol::AscReaderTemplated< ASC_READER_TEMPLATE_CLASSES >::readMorphology().

+ Here is the caller graph for this function:


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