ecoscope.base._dataclasses
==========================

.. py:module:: ecoscope.base._dataclasses






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

.. py:class:: RelocsCoordinateFilter

   Filter parameters for filtering get_fixes based on X/Y coordinate ranges or specific coordinate values


   .. py:attribute:: min_x
      :type:  float
      :value: -180.0



   .. py:attribute:: max_x
      :type:  float
      :value: 180.0



   .. py:attribute:: min_y
      :type:  float
      :value: -90.0



   .. py:attribute:: max_y
      :type:  float
      :value: 90.0



   .. py:attribute:: filter_point_coords
      :type:  list[list[float]] | geopandas.GeoSeries | None
      :value: None



   .. py:method:: __post_init__()


.. py:class:: RelocsDateRangeFilter

   Filter parameters for filtering based on a datetime range


   .. py:attribute:: start
      :type:  datetime.datetime


   .. py:attribute:: end
      :type:  datetime.datetime


.. py:class:: RelocsSpeedFilter

   Filter parameters for filtering based on the speed needed to move from one fix to the next


   .. py:attribute:: max_speed_kmhr
      :type:  float


   .. py:attribute:: temporal_order
      :type:  str
      :value: 'ASC'



.. py:class:: RelocsDistFilter

   Filter based on the distance between consecutive fixes. Fixes are filtered to the range [min_dist_km, max_dist_km].


   .. py:attribute:: min_dist_km
      :type:  float
      :value: 0.0



   .. py:attribute:: max_dist_km
      :type:  float


   .. py:attribute:: temporal_order
      :type:  str
      :value: 'ASC'



.. py:class:: TrajSegFilter

   Class filtering a set of trajectory segment segments


   .. py:attribute:: min_length_meters
      :type:  float
      :value: 0.0



   .. py:attribute:: max_length_meters
      :type:  float


   .. py:attribute:: min_time_secs
      :type:  float
      :value: 0.0



   .. py:attribute:: max_time_secs
      :type:  float


   .. py:attribute:: min_speed_kmhr
      :type:  float
      :value: 0.0



   .. py:attribute:: max_speed_kmhr
      :type:  float


.. 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
      :value: None



.. py:class:: ProximityProfile

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


.. py:data:: RelocsFilterType