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

A singleton class to operate over morphologies. More...

#include <Simplifier.h>

+ Collaboration diagram for nsol::Simplifier:

Public Types

enum  TSimplificationMethod { DELETE_ALL = 0, DIST_NODES, DIST_NODES_RADIUS, ANGLE_MIN }
 Methods of simplification.
 

Public Member Functions

NeuronMorphologyPtr simplify (NeuronMorphologyPtr morpho_, TSimplificationMethod simplMethod_=DELETE_ALL, float tolerance_=0.1, bool clone_=false)
 Method to simplify the morphology given by the simplification function selected, the simplification can be made over the original given morphology or over a clone of this morphology. More...
 
MorphologyPtr simplify (MorphologyPtr morpho_, TSimplificationMethod simplMethod_=DELETE_ALL, float tolerance_=0.1)
 
NeuronMorphologyPtr adaptSoma (NeuronMorphologyPtr morpho_, bool clone_=false)
 Method to correct the neuronal morphology to avoid errors in the generation of the neuronal soma mesh. More...
 
NeuronMorphologyPtr adaptBifurcations (NeuronMorphologyPtr morpho_, float tolerance_=0.9f, bool clone_=false)
 Method to correct the neuronal morphology to fix the intersecting bifurcations. More...
 
NeuronMorphologyPtr cutout (NeuronMorphologyPtr morpho_, bool clone_=false)
 Method to cutout the neuronal morphology based in the nodes importances. More...
 
MorphologyPtr repairSections (MorphologyPtr morpho_)
 Method to repair morphological traces, deleting sections composed only by two nodes and whose distance between nodes is less than the radius of the segment that they represent. More...
 
 Simplifier (Simplifier const &)=delete
 
void operator= (Simplifier const &)=delete
 

Static Public Member Functions

static SimplifierInstance ()
 Returns the instance of the singelton class. More...
 

Detailed Description

A singleton class to operate over morphologies.

Provides functionality to the simplification, the adaptation and the cutout of neuronal morphologies

Definition at line 41 of file Simplifier.h.

Member Function Documentation

NeuronMorphologyPtr nsol::Simplifier::adaptBifurcations ( NeuronMorphologyPtr  morpho_,
float  tolerance_ = 0.9f,
bool  clone_ = false 
)

Method to correct the neuronal morphology to fix the intersecting bifurcations.

Parameters
morpho_neuronal morphology to correct
tolerance_used to determine the maximum opening angle of a bifurcation
clone_if true the morphology is clone before the correction if false the correction is made over the orignal morphology
NeuronMorphologyPtr nsol::Simplifier::adaptSoma ( NeuronMorphologyPtr  morpho_,
bool  clone_ = false 
)

Method to correct the neuronal morphology to avoid errors in the generation of the neuronal soma mesh.

Parameters
morpho_neuronal morphology to correct
clone_if true the morphology is clone before the correction if false the correction is made over the orignal morphology
NeuronMorphologyPtr nsol::Simplifier::cutout ( NeuronMorphologyPtr  morpho_,
bool  clone_ = false 
)

Method to cutout the neuronal morphology based in the nodes importances.

Parameters
morpho_neuronal morphology to cutout
clone_if true the morphology is clone before the cutout if false the cutout is made over the orignal morphology
static Simplifier* nsol::Simplifier::Instance ( )
static

Returns the instance of the singelton class.

Returns
the Simplifier instance
MorphologyPtr nsol::Simplifier::repairSections ( MorphologyPtr  morpho_)

Method to repair morphological traces, deleting sections composed only by two nodes and whose distance between nodes is less than the radius of the segment that they represent.

Parameters
morpho_neuronal morphology to unify sections
NeuronMorphologyPtr nsol::Simplifier::simplify ( NeuronMorphologyPtr  morpho_,
TSimplificationMethod  simplMethod_ = DELETE_ALL,
float  tolerance_ = 0.1,
bool  clone_ = false 
)

Method to simplify the morphology given by the simplification function selected, the simplification can be made over the original given morphology or over a clone of this morphology.

Parameters
morpho_neuronal morphology to simplify
simplMethod_to select the function used to simplify
tolerance_used for different simplification function
clone_if true the morphology is clone before the simplification if false the simplification is made over the orignal morphology

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