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
------------
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/

   Tracker.track

Measures
------------
Motion
^^^^^^^^^^^^
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/
   :recursive:

   measures.MotionMeasures

Shape
^^^^^^^^^^^^
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/
   :recursive:

   measures.ShapeMeasures

Intensity
^^^^^^^^^^^^
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/
   :recursive:

   measures.calculate_intensity_metrics

Timing
^^^^^^^^^^^^
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/
   :recursive:

   measures.get_duration
   measures.get_initial_detection_time

Plotting
^^^^^^^^^^^^
.. currentmodule:: ocetrac
.. autosummary::
   :toctree: ./_generated/
   :recursive:

   measures.plot_displacement