Commit 98a6ef36 authored by Stephen Thompson's avatar Stephen Thompson

Issue #8 updated documentation, added release notes

parent 384ef90e
......@@ -36,7 +36,11 @@ Installing
Using
-----
Configuration is done using Python libraries. Tracking data is returned in NumPy arrays.
Configuration is done using Python libraries at instantiation. Invalid
configuration should raise exceptions. Tracking data is returned in a set of
lists, containing the port handles, timestamps, framenumbers, the tracking data
and a tracking quality metric. By default tracking data is returned as a 4x4 NumPy array,
though can be returned as a quaternion by changing the configuration.
::
......@@ -45,15 +49,16 @@ Configuration is done using Python libraries. Tracking data is returned in NumPy
"tracker type": "polaris",
"romfiles" : ["../data/8700339.rom"]
}
TRACKER = NDITracker()
TRACKER.connect(SETTINGS)
TRACKER = NDITracker(SETTINGS)
TRACKER.start_tracking()
print(TRACKER.get_frame()
port_handles, timestamps, framenumbers, tracking, quality = TRACKER.get_frame()
for t in tracking:
print (t)
TRACKER.stop_tracking()
TRACKER.close()
See example.py for a full example
See demo.py for a full example
Developing
----------
......
......@@ -7,7 +7,7 @@ Contents
:maxdepth: 1
requirements
pycharm
release_notes
Module Contents <modules>
* :ref:`modindex`
......
.. highlight:: shell
.. _release_notes:
==========================================
Release Notes for scikit-surgerynditracker
==========================================
+------------+--------------------------------------------------------+
| Release | Description |
+============+========================================================+
| 0.0.1 | First release (tested with Vega) |
+------------+--------------------------------------------------------+
| 0.0.2 | Tidied documentation |
+------------+--------------------------------------------------------+
| 0.0.3 | Added time stamp (adds extra column to return array) |
+------------+--------------------------------------------------------+
| 0.0.4 | No code changes. |
+------------+--------------------------------------------------------+
| 0.0.5 | Tested and works with multichannel Aurora trackers |
+------------+--------------------------------------------------------+
| 0.1.0 | Removed configure method, configuration now done at |
| | init. |
| | Changed return type of get_frame(). Not backwards |
| | compatible. Returns matrix for tracking, not |
| | quaternion. Timestamp, port handle, frame number |
| | and tracking quality all returned as separate lists. |
+------------+--------------------------------------------------------+
......@@ -22,22 +22,19 @@ Requirements
| 0001 | Functions are documented | pylint, see |
| | | tests/pylint.rc and tox.ini |
+------------+--------------------------------------------------------+-------------------------------------+
| 0002 | Package has a version number | No test yet, handled by git. |
| 0002 | Package has a version number | handled by versioneer |
+------------+--------------------------------------------------------+-------------------------------------+
| 0003 | Connects and configures, vega, polaris and aurora | |
| 0003 | Connects and configures, vega, polaris and aurora | test_configure |
+------------+--------------------------------------------------------+-------------------------------------+
| 0004 | Configures via a python dictionary | |
| 0004 | Configures via a python dictionary | test_configure |
+------------+--------------------------------------------------------+-------------------------------------+
| 0005 | Provides get frame to get frame of tracking data | |
| 0005 | Provides get frame to get frame of tracking data | test_get_frame |
+------------+--------------------------------------------------------+-------------------------------------+
| 0006 | Get frame returns data as numpy array | |
| 0006 | Get frame returns data as numpy array | test_get_frame |
+------------+--------------------------------------------------------+-------------------------------------+
| 0007 | Supports multiple tracked objects | |
| 0007 | Supports multiple tracked objects | test_get_frame |
+------------+--------------------------------------------------------+-------------------------------------+
| 0008 | Provides a method to stream data to file for later | |
| | use. | |
+------------+--------------------------------------------------------+-------------------------------------+
| 0009 | If no tracking available GetFrame Returns NaN | |
| 0009 | If no tracking available GetFrame Returns NaN | - |
+------------+--------------------------------------------------------+-------------------------------------+
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment