:py:mod:`ecoscope.analysis.proximity`
=====================================

.. py:module:: ecoscope.analysis.proximity


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

.. py:class:: SpatialFeature


   A spatial geometry with an associated name and unique ID. Becomes a useful construct in several movdata calculations

   .. py:attribute:: name
      :type: str
      :value: ''

      

   .. py:attribute:: unique_id
      :type: Any

      

   .. py:attribute:: geometry
      :type: Any

      


.. py:class:: ProximityProfile


   .. py:attribute:: spatial_features
      :type: List[SpatialFeature]

      


.. py:class:: Proximity


   .. py:method:: calculate_proximity(proximity_profile, trajectory)
      :classmethod:

      A function to analyze the trajectory of a subject in relation to a set of spatial features and regions to
      determine where/when the subject was proximal to the spatial feature.

      :param proximity_profile: proximity setting for performing calculation
      :type proximity_profile: ProximityProfile
      :param trajectory: Geodataframe stores goemetry, speed_kmhr, heading etc. for each subject.
      :type trajectory: ecoscope.base.Trajectory

      :rtype: pd.DataFrame