Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
berndpfrommer committed Nov 24, 2023
1 parent cadd0f6 commit e505b1e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ package provides a module for fast and convenient loading of events in python.
### EventPacket

The EventPacket message contains a packet (array) of events in binary
format. Several different encoding formats are supported, but use of
the older, deprecated ones is strongly discouraged.
format.

Description of the encodings:

Expand All @@ -36,8 +35,9 @@ Description of the encodings:
[event_camera_codecs](https://github.com/ros-event-camera/event_camera_codecs).


- ``mono`` (deprecated): messages from monochrome cameras such as the DVS and
Prophesee Metavision cameras. Encodes on 64 bit boundaries as follows:
- ``mono``: messages from monochrome cameras using the
[libcaer driver](https://github.com/ros-event-camera/libcaer_driver)
(Davis, dvXplorer etc). Encodes on 64 bit boundaries as follows:

| bits | interpretation |
|-------|----------------------------------------|
Expand All @@ -47,9 +47,9 @@ Description of the encodings:
| 0-32 | dt (32 bits) |

To recover the original sensor time, add the delta ``dt`` to the
message ``time_base`` field.
To recover the best estimate ROS sensor time stamp add ``dt`` to the
header stamp.
message ``time_base`` field. Both ``dt`` and ``time_base`` are
in nanoseconds. To recover the best estimate ROS sensor time
stamp add ``dt`` to the ROS header stamp.

- ``trigger`` (deprecated): external trigger messages from e.g. the
Prophesee Metavision cameras.
Expand All @@ -61,7 +61,7 @@ Description of the encodings:
| 0-32 | dt (32 bits) |

To recover the original sensor time add the delta ``dt`` to the
message ``time_base`` field.
message ``time_base`` field (in nanoseconds).
To recover the best estimate ROS sensor time stamp add ``dt`` to the
header stamp.

Expand Down

0 comments on commit e505b1e

Please sign in to comment.