:mod:`neuron_morphology.feature_extractor.mark`
===============================================

.. py:module:: neuron_morphology.feature_extractor.mark


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

Classes
~~~~~~~

.. autoapisummary::

   neuron_morphology.feature_extractor.mark.Mark
   neuron_morphology.feature_extractor.mark.RequiresLayerAnnotations
   neuron_morphology.feature_extractor.mark.Intrinsic
   neuron_morphology.feature_extractor.mark.Geometric
   neuron_morphology.feature_extractor.mark.AllNeuriteTypes
   neuron_morphology.feature_extractor.mark.RequiresDendrite
   neuron_morphology.feature_extractor.mark.RequiresRelativeSomaDepth
   neuron_morphology.feature_extractor.mark.RequiresSoma
   neuron_morphology.feature_extractor.mark.RequiresApical
   neuron_morphology.feature_extractor.mark.RequiresBasal
   neuron_morphology.feature_extractor.mark.RequiresAxon
   neuron_morphology.feature_extractor.mark.RequiresRoot
   neuron_morphology.feature_extractor.mark.BifurcationFeatures
   neuron_morphology.feature_extractor.mark.CompartmentFeatures
   neuron_morphology.feature_extractor.mark.TipFeatures
   neuron_morphology.feature_extractor.mark.NeuriteTypeComparison
   neuron_morphology.feature_extractor.mark.RequiresRadii
   neuron_morphology.feature_extractor.mark.RequiresReferenceLayerDepths
   neuron_morphology.feature_extractor.mark.RequiresLayeredPointDepths
   neuron_morphology.feature_extractor.mark.RequiresRegularPointSpacing



Functions
~~~~~~~~~

.. autoapisummary::

   neuron_morphology.feature_extractor.mark.check_nodes_have_key


.. data:: Mr
   

   

.. py:class:: Mark

   A tag, intended for use in feature selection.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!


   .. classmethod:: factory(cls: Type[Mr], name: str)



.. py:class:: RequiresLayerAnnotations

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   A tag, intended for use in feature selection.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Checks whether each node in the data's morphology is annotated with
      a cortical layer. Returns False if any are missing.
















      ..
          !! processed by numpydoc !!



.. py:class:: Intrinsic

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates intrinsic features that don't rely on a ccf or scale.
















   ..
       !! processed by numpydoc !!


.. py:class:: Geometric

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates features that change depending on coordinate frame.
















   ..
       !! processed by numpydoc !!


.. py:class:: AllNeuriteTypes

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates features that are calculated for all neurite types.
















   ..
       !! processed by numpydoc !!


.. py:class:: RequiresDendrite

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This feature can only be calculated for neurons with at least one 
   dendrite node
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresRelativeSomaDepth

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This feature can only be calculated for relative soma depth
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresSoma

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates that these features require a soma.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresApical

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates that these features require an apical dendrite.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresBasal

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates that these features require a basal dendrite.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresAxon

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates that these features require an axon.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresRoot

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates that this features require a root. Warns if the root 
   is not unique
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: BifurcationFeatures

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates a feature calculated on bifurcations.
















   ..
       !! processed by numpydoc !!


.. py:class:: CompartmentFeatures

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates a feature calculated on compartments.
















   ..
       !! processed by numpydoc !!


.. py:class:: TipFeatures

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates a feature calculated on tips (leaf nodes).
















   ..
       !! processed by numpydoc !!


.. py:class:: NeuriteTypeComparison

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   Indicates a feature that is a comparison between neurite types.

   Function should be decorated with the appropriate RequiresType marks















   ..
       !! processed by numpydoc !!


.. py:class:: RequiresRadii

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This feature can only be calculated if the radii of nodes are annotated.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresReferenceLayerDepths

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This feature can only be calculated if a referenceset of average depths 
   for cortical layers is provided. See features.layer.reference_layer_depths
   for more information.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresLayeredPointDepths

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This feature can only be calculated if (cortical) points are annotated 
   with a collection of within-layer depths. See 
   features.layer.layered_point_depths for more information.
















   ..
       !! processed by numpydoc !!

   .. classmethod:: validate(cls, data: Data)

      Determine if this feature is calculable from the provided data.


      :Parameters:

          **data** : Data from a single morphological reconstruction
              ..

      :Returns:

          whether marked features can be calculated from these data
              ..













      ..
          !! processed by numpydoc !!



.. py:class:: RequiresRegularPointSpacing

   Bases: :class:`neuron_morphology.feature_extractor.mark.Mark`

   This features can only be (meaningfully) calculated if the points (e.g.
   node positions) on which it is based are resampled to have regular spacing.
















   ..
       !! processed by numpydoc !!


.. function:: check_nodes_have_key(data: Data, key: str) -> bool

   Checks whether each node in a morphology is annotated with some key.
















   ..
       !! processed by numpydoc !!