# API Reference

The Python API lives in the top-level `eventcv` package. Every operation exists both as
a **method** on {class}`~eventcv.EventStream` / {class}`~eventcv.EventFrame` and as an
OpenCV-style **free function** (listed under [Functional API](#functional-opencv-style-api)
below); the free functions are generated from the methods, so the two forms stay in sync.

## Loading & saving

```{eval-rst}
.. currentmodule:: eventcv

.. autofunction:: load
.. autofunction:: from_numpy
.. autofunction:: open
.. autofunction:: save
.. autofunction:: load_frame
.. autofunction:: export_png
.. autofunction:: collate
```

## Core types

```{eval-rst}
.. autoclass:: eventcv.EventStream
   :members:

.. autoclass:: eventcv.EventFrame
   :members:

.. autoclass:: eventcv.EventReader
   :members:

.. autoclass:: eventcv.EventPointSet
   :members:

.. autoclass:: eventcv.Camera
   :members:
```

(functional-opencv-style-api)=
## Functional (OpenCV-style) API

Each function below forwards to the identically named method on a stream or frame — e.g.
`eventcv.voxel(stream, bins=5)` is `stream.voxel(bins=5)`. They are generated by
introspecting the compiled types, so this list always matches the methods above.

```{eval-rst}
.. automodule:: eventcv
   :members:
   :exclude-members: EventStream, EventFrame, EventReader, EventPointSet, Camera,
      Polarity, FrameSink, load, from_numpy, open, save, load_frame, export_png, collate
```