chump.objects.mobject

class mobject:

Data objects extract and store spatial and temporal information of diverse formats, and convert them into a uniform data abstraction represented as Pandas dataframes with highly efficient indexing/slicing capability. Three top data classes, mobject, chump.objects.mobject2d, and chump.objects.mobject3d, are available to represent data with various degrees of dimensionality.

The mobject class serves as the root superclass for all other derived subclasses. Below are some properties that can be set for all the objects in chump.

time_unit: str

time unit for the object. default is "days". If not set, it will use the global setting.

start_date: str | datetime.datetime

starting date for time related data. The time will be parsed into timestamps using the starting date and time unit. If not set, it will use the global setting.

epsg: int

set the coordinate reference system for the object using EPSG. e.g. epsg = 4326. If not set, it will use the global setting.

crs: str

set the coordinate reference system using strings. See details in https://geopandas.org/en/stable/docs/user_guide/projections.html.

plotarg

plotting argument for the object

legend

plotting argument for the object

timecol: str

set the time column. Default is 'time'.

Example:

>>> timecol = 'date'

t_scale: float

set a scaling factor, default is 1.0. final time values = original time values * t_scale + t_offset

Example:

>>> t_scale = 86400 # convert days to seconds

t_offset: float

set a time offset, default is 0.0. final time values = original time values * t_scale + t_offset

Example:

>>> t_offset = -365 # move time ahead by one year