:mod:`neuron_morphology.transforms.upright_angle.compute_angle`
===============================================================

.. py:module:: neuron_morphology.transforms.upright_angle.compute_angle


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


Functions
~~~~~~~~~

.. autoapisummary::

   neuron_morphology.transforms.upright_angle.compute_angle.get_upright_angle
   neuron_morphology.transforms.upright_angle.compute_angle.calculate_transform
   neuron_morphology.transforms.upright_angle.compute_angle.run_upright_angle
   neuron_morphology.transforms.upright_angle.compute_angle.main


.. function:: get_upright_angle(gradient: xr.DataArray, point: Optional[List[float]] = None, n_win: int = 2) -> float

   Calculate the upright angle at a position, e.g. soma, given a vector field


   :Parameters:

       **gradient: xarray of the the vector field**
           ..

       **point: list [x,y,z] coordinates**
           ..

       **n_win: number of grid points to define the interpolation window**
           ..

   :Returns:

       angle
           ..













   ..
       !! processed by numpydoc !!


.. function:: calculate_transform(gradient_field: xr.DataArray, morph: Morphology, node: Optional[List[float]] = None)


.. function:: run_upright_angle(gradient_path: str, swc_path: str, node: Optional[List[float]] = None)


.. function:: main()