Skip to content

Commit

Permalink
doc: re-jig structure a little
Browse files Browse the repository at this point in the history
  • Loading branch information
rjw57 committed Mar 21, 2017
1 parent 342f912 commit 182ed57
Showing 1 changed file with 22 additions and 23 deletions.
45 changes: 22 additions & 23 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,13 @@
libfreenect2 Python bindings
============================

.. toctree::
:maxdepth: 1
:caption: Contents:
freenect2
=========

The :py:mod:`freenect2` module provides a Python interface to the `libfreenect2
<https://github.com/OpenKinect/libfreenect2>`_ library. The libfreenect2 library
provides a library allowing depth and RGB data to be extracted from a Kinect for
Windows v2 (K4W2) device.

The library is intended to provide an easy to use Pythonic interface to
libfreenect2. As an example of library usage, here is a simple infrared (IR)
camera which can be used to capture an image from the Kinect's build in IR
camera:

.. literalinclude:: ../examples/ir_camera.py
:language: python

The library also supports extracting real-world 3D co-ordinates from the depth
maps and saving `libpcl <http://pointclouds.org/>`_-compatible PCD files:

.. literalinclude:: ../examples/dump_pcd.py
:language: python

Installation
============
------------

libfreenect2 must be installed prior to building this module. See the
`installation instructions
Expand All @@ -44,14 +26,31 @@ actions:
$ pip install --user freenect2
pkg-config errors
-----------------
'''''''''''''''''

The libfreenect2 library uses pkg-config to record where it is installed on the
system. If you install libfreenect2 manually as outlined above you will need to
set the `PKG_CONFIG_PATH` environment variable.

Simple usage
------------

The library is intended to provide an easy to use Pythonic interface to
libfreenect2. As an example of library usage, here is a simple infrared (IR)
camera which can be used to capture an image from the Kinect's build in IR
camera:

.. literalinclude:: ../examples/ir_camera.py
:language: python

The library also supports extracting real-world 3D co-ordinates from the depth
maps and saving `libpcl <http://pointclouds.org/>`_-compatible PCD files:

.. literalinclude:: ../examples/dump_pcd.py
:language: python

Reference
=========
---------

.. automodule:: freenect2
:members:

0 comments on commit 182ed57

Please sign in to comment.