neuron_morphology.features.statistics.coordinates

Module Contents

Functions

get_compartment_coordinates(morphology, node_types: Optional[List[int]] = None) Return the coordinates of the midpoint of each compartment
get_bifurcation_coordinates(morphology, node_types: Optional[List[int]] = None) Return the coordinates of each bifurcation in the morphology
get_tip_coordinates(morphology, node_types: Optional[List[int]] = None) Return the coordinates of each tip in the morphology
get_node_coordinates(morphology, node_types: Optional[List[int]] = None) Return the coordinates of each node in the morphology
get_coordinates(morphology: Morphology, coordinate_type: COORD_TYPE = COORD_TYPE.NODE, node_types: Optional[List[int]] = None)
class neuron_morphology.features.statistics.coordinates.COORD_TYPE

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

NODE = 0
COMPARTMENT = 1
BIFURCATION = 2
TIP = 3
get_coordinates(self, morphology, node_types: Optional[List[int]] = None)
class neuron_morphology.features.statistics.coordinates.NodeSpec

Bases: neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization

name = node
marks
kwargs
class neuron_morphology.features.statistics.coordinates.BifurcationSpec

Bases: neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization

name = bifurcation
marks
kwargs
class neuron_morphology.features.statistics.coordinates.CompartmentSpec

Bases: neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization

name = compartment
marks
kwargs
class neuron_morphology.features.statistics.coordinates.TipSpec

Bases: neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization

name = tip
marks
kwargs
neuron_morphology.features.statistics.coordinates.COORD_TYPE_SPECIALIZATIONS
neuron_morphology.features.statistics.coordinates.get_compartment_coordinates(morphology, node_types: Optional[List[int]] = None)

Return the coordinates of the midpoint of each compartment in the morphology

Parameters:
morphology: Morphology object
node_types: list (AXON, BASAL_DENDRITE, APICAL_DENDRITE)
Returns:
list: list of coordinates [x, y, z]
neuron_morphology.features.statistics.coordinates.get_bifurcation_coordinates(morphology, node_types: Optional[List[int]] = None)

Return the coordinates of each bifurcation in the morphology

Parameters:
morphology: Morphology object
node_types: list (AXON, BASAL_DENDRITE, APICAL_DENDRITE)
Returns:
list: list of coordinates [x, y, z]
neuron_morphology.features.statistics.coordinates.get_tip_coordinates(morphology, node_types: Optional[List[int]] = None)

Return the coordinates of each tip in the morphology

Parameters:
morphology: Morphology object
node_types: list (AXON, BASAL_DENDRITE, APICAL_DENDRITE)
Returns:
list: list of coordinates [x, y, z]
neuron_morphology.features.statistics.coordinates.get_node_coordinates(morphology, node_types: Optional[List[int]] = None)

Return the coordinates of each node in the morphology

Parameters:
morphology: Morphology object
node_types: list (AXON, BASAL_DENDRITE, APICAL_DENDRITE)
Returns:
list: list of coordinates [x, y, z]
neuron_morphology.features.statistics.coordinates.get_coordinates(morphology: Morphology, coordinate_type: COORD_TYPE = COORD_TYPE.NODE, node_types: Optional[List[int]] = None)