API Reference

The API reference is automatically generated from the function docstrings in the ocetrac package. Refer to the examples in the sidebar for reference on how to use the functions.

Tracking

Tracker.track()

Label and track image features.

Measures

Motion

measures.MotionMeasures([use_decorators])

Calculates motion characteristics of labeled geospatial objects.

Shape

measures.ShapeMeasures([lat_resolution, ...])

Calculates shape characteristics of labeled geospatial objects.

Intensity

measures.calculate_intensity_metrics(anomalies)

Calculate intensity metrics from anomaly data.

Timing

`measures.get_duration`(one_obj)	Gets the duration of the time coordinate in an xarray object.
`measures.get_initial_detection_time`(one_obj)	Gets the initial detection time from an xarray object.

Plotting

measures.plot_displacement(coordinate_list, ...)

Plots the displacement of centroids over time on an intensity map.