:mod:`neuron_morphology.snap_polygons._schemas`
===============================================

.. py:module:: neuron_morphology.snap_polygons._schemas

.. autoapi-nested-parse::

   CLI schemas for the inputs to and outputs from snap_polygons.

   ..
       !! processed by numpydoc !!



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

Classes
~~~~~~~

.. autoapisummary::

   neuron_morphology.snap_polygons._schemas.SimpleGeometry
   neuron_morphology.snap_polygons._schemas.Image
   neuron_morphology.snap_polygons._schemas.InputParameters
   neuron_morphology.snap_polygons._schemas.OutputImage
   neuron_morphology.snap_polygons._schemas.OutputParameters



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

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

   A named planar geometry
















   ..
       !! processed by numpydoc !!

   .. attribute:: name
      

      

   .. attribute:: path
      

      


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

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

   A specification for a diagnostic overlay image
















   ..
       !! processed by numpydoc !!

   .. attribute:: input_path
      

      

   .. attribute:: output_path
      

      

   .. attribute:: downsample
      

      

   .. attribute:: overlay_types
      

      


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

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

   Top-level schema for inputs to snap_polygons
















   ..
       !! processed by numpydoc !!

   .. attribute:: layer_polygons
      

      

   .. attribute:: pia_surface
      

      

   .. attribute:: wm_surface
      

      

   .. attribute:: working_scale
      

      

   .. attribute:: images
      

      

   .. attribute:: layer_order
      

      

   .. attribute:: surface_distance_threshold
      

      

   .. attribute:: multipolygon_error_threshold
      

      


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

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

   Metadata describing an output diagnoctic overlay image.
















   ..
       !! processed by numpydoc !!

   .. attribute:: input_path
      

      

   .. attribute:: output_path
      

      

   .. attribute:: downsample
      

      

   .. attribute:: overlay_type
      

      


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

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

   Top-level schema for snap_polygons outputs.
















   ..
       !! processed by numpydoc !!

   .. attribute:: inputs
      

      

   .. attribute:: polygons
      

      

   .. attribute:: surfaces
      

      

   .. attribute:: images