:mod:`neuron_morphology.feature_extractor._schemas`
===================================================

.. py:module:: neuron_morphology.feature_extractor._schemas


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

Classes
~~~~~~~

.. autoapisummary::

   neuron_morphology.feature_extractor._schemas.ReferenceLayerDepths
   neuron_morphology.feature_extractor._schemas.Reconstruction
   neuron_morphology.feature_extractor._schemas.GlobalParameters
   neuron_morphology.feature_extractor._schemas.InputParameters
   neuron_morphology.feature_extractor._schemas.OutputParameters



Functions
~~~~~~~~~

.. autoapisummary::

   neuron_morphology.feature_extractor._schemas.validate_point_depths_path


.. function:: validate_point_depths_path(path: str)

   Check whether a layered point depths path is usable.
















   ..
       !! processed by numpydoc !!


.. py:class:: ReferenceLayerDepths(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

   Bases: :class:`argschema.schemas.DefaultSchema`

   mm.Schema class with support for making fields default to
   values defined by that field's arguments.
















   ..
       !! processed by numpydoc !!

   .. attribute:: key
      

      

   .. attribute:: names
      

      

   .. attribute:: boundaries
      

      

   .. classmethod:: is_valid(cls, value)



.. py:class:: Reconstruction(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

   Bases: :class:`argschema.schemas.DefaultSchema`

   mm.Schema class with support for making fields default to
   values defined by that field's arguments.
















   ..
       !! processed by numpydoc !!

   .. attribute:: swc_path
      

      

   .. attribute:: identifier
      

      

   .. attribute:: layered_point_depths_path
      

      


.. py:class:: GlobalParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

   Bases: :class:`argschema.schemas.DefaultSchema`

   mm.Schema class with support for making fields default to
   values defined by that field's arguments.
















   ..
       !! processed by numpydoc !!

   .. attribute:: reference_layer_depths
      

      


.. py:class:: InputParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

   Bases: :class:`argschema.schemas.ArgSchema`

   The base marshmallow schema used by ArgSchemaParser to identify
   input_json and output_json files and the log_level
















   ..
       !! processed by numpydoc !!

   .. attribute:: reconstructions
      

      

   .. attribute:: heavy_output_path
      

      

   .. attribute:: feature_set
      

      

   .. attribute:: only_marks
      

      

   .. attribute:: required_marks
      

      

   .. attribute:: output_table_path
      

      

   .. attribute:: num_processes
      

      

   .. attribute:: global_parameters
      

      


.. py:class:: OutputParameters(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

   Bases: :class:`argschema.schemas.DefaultSchema`

   mm.Schema class with support for making fields default to
   values defined by that field's arguments.
















   ..
       !! processed by numpydoc !!

   .. attribute:: inputs
      

      

   .. attribute:: results