Skip to content

Commit

Permalink
docs/usage.rst: missing references to from_kitti() and from_sintel() …
Browse files Browse the repository at this point in the history
…added
  • Loading branch information
CSRavasio committed Nov 30, 2021
1 parent 33db56e commit 5b7b074
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ or using one of three special constructors:
- :meth:`~oflibnumpy.Flow.from_transforms` requires a list of transforms, a desired shape :math:`(H, W)`, and
optionally the flow reference or a mask. The given transforms are converted into a transformation matrix, from which
a flow field is constructed as in :meth:`~oflibnumpy.Flow.from_matrix`.
- :meth:`~oflibnumpy.Flow.from_kitti` loads the flow field (and optionally the valid pixels) from ``uint16`` ``png``
image files, as provided in the `KITTI optical flow dataset`_.
- :meth:`~oflibnumpy.Flow.from_sintel` loads the flow field (and optionally the valid pixels) from ``flo`` files,
as provided in the `Sintel optical flow dataset`_.

.. _KITTI optical flow dataset: http://www.cvlibs.net/datasets/kitti/eval_scene_flow.php?benchmark=flow
.. _Sintel optical flow dataset: http://sintel.is.tue.mpg.de/

Flow objects can be copied with :meth:`~oflibnumpy.Flow.copy`, resized with :meth:`~oflibnumpy.Flow.resize`, padded
with :meth:`~oflibnumpy.Flow.pad`, and sliced using square brackets ``[]`` analogous to numpy slicing, which calls
Expand Down

0 comments on commit 5b7b074

Please sign in to comment.