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

.. py:module:: ecoscope.analysis.geofence


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

.. py:class:: Region(geometry, unique_id = None, region_name = None)


   Bases: :py:obj:`collections.UserDict`

   A MutableMapping is a generic container for associating
   key/value pairs.

   This class provides concrete generic implementations of all
   methods except for __getitem__, __setitem__, __delitem__,
   __iter__, and __len__.


.. py:class:: GeoFence(geometry, unique_id = None, fence_name = None, warn_level = None)


   Bases: :py:obj:`collections.UserDict`

   Represents Virtual Fence Boundary


.. py:class:: GeoCrossingProfile


   .. py:property:: geofence_df


   .. py:property:: region_df


   .. py:attribute:: geofences
      :type: List[GeoFence]

      

   .. py:attribute:: regions
      :type: List[Region]

      


.. py:class:: GeoFenceCrossing


   .. py:method:: analyse(geocrossing_profile, trajectory)
      :classmethod:

      Analyze the trajectory of each subject in relation to set of virtual fences and regions to determine where/when
      the polylines were crossed and what the containment of the individual was before and
      after any geofence crossings.

      :param geocrossing_profile: Object that contains the geonfences and regions
      :type geocrossing_profile: GeoCrossingProfile
      :param trajectory: Geodataframe stores goemetry, speed_kmhr, heading etc. for each subject.
      :type trajectory: ecoscope.base.Trajectory

      :rtype: ecoscope.base.EcoDataFrame