:mod:`neuron_morphology.feature_extractor.feature_specialization`
=================================================================

.. py:module:: neuron_morphology.feature_extractor.feature_specialization


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

Classes
~~~~~~~

.. autoapisummary::

   neuron_morphology.feature_extractor.feature_specialization.FeatureSpecialization
   neuron_morphology.feature_extractor.feature_specialization.AxonSpec
   neuron_morphology.feature_extractor.feature_specialization.ApicalDendriteSpec
   neuron_morphology.feature_extractor.feature_specialization.BasalDendriteSpec
   neuron_morphology.feature_extractor.feature_specialization.DendriteSpec
   neuron_morphology.feature_extractor.feature_specialization.AllNeuriteSpec
   neuron_morphology.feature_extractor.feature_specialization.AxonCompareSpec
   neuron_morphology.feature_extractor.feature_specialization.ApicalDendriteCompareSpec
   neuron_morphology.feature_extractor.feature_specialization.BasalDendriteCompareSpec
   neuron_morphology.feature_extractor.feature_specialization.DendriteCompareSpec
   neuron_morphology.feature_extractor.feature_specialization.AllNeuriteCompareSpec



.. data:: Fs
   

   

.. py:class:: FeatureSpecialization

   .. attribute:: name
      :annotation: :str

      

   .. attribute:: marks
      :annotation: :Set[Type[Mark]]

      

   .. attribute:: kwargs
      :annotation: :Dict[str, Any]

      

   .. classmethod:: factory(cls: Type[Fs], name: str, marks: Set[Type[Mark]], kwargs: Dict[str, Any], display_name: Optional[str] = None)

      A utility for quickly generating feature specializations


      :Parameters:

          **name** : The name of the generated class. If display_name is not
              provided, this will also be used as the name attribute of the 
              generated class

          **marks** : the marks which this specialization implies.
              ..

          **kwargs** : the keyword argument values defining this specialization
              ..

          **display_name** : if provided, the name attribute of the generated
              specialization.

      :Returns:

          A generated FeatureSpecialization subclass
              ..













      ..
          !! processed by numpydoc !!



.. data:: SpecializationOption
   

   

.. data:: SpecializationSet
   

   

.. data:: SpecializationSets
   

   

.. py:class:: AxonSpec

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

   .. attribute:: name
      :annotation: = axon

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: ApicalDendriteSpec

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

   .. attribute:: name
      :annotation: = apical_dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: BasalDendriteSpec

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

   .. attribute:: name
      :annotation: = basal_dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: DendriteSpec

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

   .. attribute:: name
      :annotation: = dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: AllNeuriteSpec

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

   .. attribute:: name
      :annotation: = all_neurites

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. data:: NEURITE_SPECIALIZATIONS
   

   

.. py:class:: AxonCompareSpec

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

   .. attribute:: name
      :annotation: = axon

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: ApicalDendriteCompareSpec

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

   .. attribute:: name
      :annotation: = apical_dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: BasalDendriteCompareSpec

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

   .. attribute:: name
      :annotation: = basal_dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: DendriteCompareSpec

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

   .. attribute:: name
      :annotation: = dendrite

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. py:class:: AllNeuriteCompareSpec

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

   .. attribute:: name
      :annotation: = all_neurites

      

   .. attribute:: marks
      

      

   .. attribute:: kwargs
      

      


.. data:: NEURITE_COMPARISON_SPECIALIZATIONS