ecoscope.analysis.geofence#

Module Contents#

class ecoscope.analysis.geofence.Region(geometry, unique_id=None, region_name=None)#

Bases: 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__.

Parameters:

  • geometry (Any)

  • unique_id (str | None)

  • region_name (str | None)

class ecoscope.analysis.geofence.GeoFence(geometry, unique_id=None, fence_name=None, warn_level=None)#

Bases: collections.UserDict

Represents Virtual Fence Boundary

Parameters:

  • geometry (Any)

  • unique_id (str | None)

  • fence_name (str | None)

  • warn_level (str | None)

class ecoscope.analysis.geofence.GeoCrossingProfile#
geofences: List[GeoFence]#
regions: List[Region]#
property geofence_df#
property region_df#
class ecoscope.analysis.geofence.GeoFenceCrossing#
classmethod analyse(geocrossing_profile, trajectory)#

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.

Parameters:

  • geocrossing_profile (GeoCrossingProfile) – Object that contains the geonfences and regions

  • trajectory (ecoscope.Trajectory) – Geodataframe stores goemetry, speed_kmhr, heading etc. for each subject.

Return type:

ecoscope.base.EcoDataFrame