:mod:`neuron_morphology.features.statistics.coordinates`
========================================================

.. py:module:: neuron_morphology.features.statistics.coordinates


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   neuron_morphology.features.statistics.coordinates.COORD_TYPE
   neuron_morphology.features.statistics.coordinates.NodeSpec
   neuron_morphology.features.statistics.coordinates.BifurcationSpec
   neuron_morphology.features.statistics.coordinates.CompartmentSpec
   neuron_morphology.features.statistics.coordinates.TipSpec



Functions
~~~~~~~~~

.. autoapisummary::

   neuron_morphology.features.statistics.coordinates.get_compartment_coordinates
   neuron_morphology.features.statistics.coordinates.get_bifurcation_coordinates
   neuron_morphology.features.statistics.coordinates.get_tip_coordinates
   neuron_morphology.features.statistics.coordinates.get_node_coordinates
   neuron_morphology.features.statistics.coordinates.get_coordinates


.. py:class:: COORD_TYPE

   Bases: :class:`enum.Enum`

   Generic enumeration.

   Derive from this class to define new enumerations.















   ..
       !! processed by numpydoc !!

   .. attribute:: NODE
      :annotation: = 0

      

   .. attribute:: COMPARTMENT
      :annotation: = 1

      

   .. attribute:: BIFURCATION
      :annotation: = 2

      

   .. attribute:: TIP
      :annotation: = 3

      

   .. method:: get_coordinates(self, morphology, node_types: Optional[List[int]] = None)



.. py:class:: NodeSpec

   Bases: :class:`neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization`

   .. attribute:: name
      :annotation: = node

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: BifurcationSpec

   Bases: :class:`neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization`

   .. attribute:: name
      :annotation: = bifurcation

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: CompartmentSpec

   Bases: :class:`neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization`

   .. attribute:: name
      :annotation: = compartment

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: TipSpec

   Bases: :class:`neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization`

   .. attribute:: name
      :annotation: = tip

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. data:: COORD_TYPE_SPECIALIZATIONS
   

   

.. function:: 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]
           ..













   ..
       !! processed by numpydoc !!


.. function:: 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]
           ..













   ..
       !! processed by numpydoc !!


.. function:: 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]
           ..













   ..
       !! processed by numpydoc !!


.. function:: 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]
           ..













   ..
       !! processed by numpydoc !!


.. function:: get_coordinates(morphology: Morphology, coordinate_type: COORD_TYPE = COORD_TYPE.NODE, node_types: Optional[List[int]] = None)