Commit 0fe2dc26 authored by Stephen Thompson's avatar Stephen Thompson

Issue #1 tidied readme and setup

parent 89fd5775
Pipeline #1097 passed with stages
in 14 minutes and 52 seconds
......@@ -20,7 +20,7 @@ scikit-surgerynditracker
scikit-surgerynditracker is a python project that does interesting things.
scikit-surgerynditracker is a python interface for Northern Digital (NDI) trackers. It should work with Polaris Vicra, Spectra, and Vega optical trackers and Aurora electromagnetic trackers. Tracking data is output as NumPy arrays.
Author: Stephen Thompson
......@@ -30,12 +30,29 @@ scikit-surgerynditracker is part of the `SNAPPY`_ software project, developed at
Installing
----------
You can pip install directly from the repository as follows:
You can pip install from PyPi or directly from the repository as follows:
::
pip install git+https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/scikit-surgerynditracker
Using
-----
::
from sksurgerynditracker.nditracker import NDITracker
SETTINGS = {
"tracker type": "polaris",
"romfiles" : ["../data/8700339.rom"]
}
TRACKER = NDITracker()
TRACKER.connect(SETTINGS)
TRACKER.start_tracking()
print(TRACKER.get_frame()
TRACKER.stop_tracking()
TRACKER.close()
See example.py for a full example
Developing
----------
......
......@@ -14,7 +14,7 @@ setup(
name='scikit-surgerynditracker',
version=versioneer.get_version(),
cmdclass=versioneer.get_cmdclass(),
description='scikit-surgerynditracker',
description='Interface for Northern Digital (NDI) Trackers with data to NumPy arrays'
long_description=long_description,
url='https://weisslab.cs.ucl.ac.uk/WEISS/SoftwareRepositories/scikit-surgerynditracker',
author='Stephen Thompson',
......
......@@ -13,14 +13,13 @@ SETTINGS_VEGA = {
"ip address" : "192.168.2.17",
"port" : 8765,
"romfiles" : [
"../data/8700339_smallblue-150130.rom",
"../data/8700339.rom"]
"../data/8700339.rom",
"../data/something_else.rom"]
}
SETTINGS_POLARIS = {
"tracker type": "polaris",
"romfiles" : [
"../data/8700339_smallblue-150130.rom",
"../data/8700339.rom"]
}
......
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