README.md

WherePy

Sample application to demonstrate real-time tool tracking.

Getting Started

Requirements

• Python
• ndicapi Python interface
• PyYAML

Installation

pip install git+git://github.com/dzhoshkun/wherepy

Usage

Supported tracking systems

Currently NDI Aurora only.

Tracking quality indicator

Run: wherepy-indicator-cli. This will display a live tracking quality indicator like the following samples:

• Device connected, signal quality 54 %, tracking error 1.54 mm, and an info message:

|  Device  |       Signal      |   Error   |           Info           |
-----------------------------------------------------------------------
    LIVE     [====>     ] 54 %    1.54 mm        info message here

• Device connected, but low-quality signal, no tracking error reported:

|  Device  |       Signal      |   Error   |           Info           |
-----------------------------------------------------------------------
    LIVE     [          ]  0 %       ~

• Device not connected, tracking error not applicable:

|  Device  |       Signal      |   Error   |           Info           |
-----------------------------------------------------------------------
  OFFLINE    [          ]  0 %       NA

Running wherepy-indicator-cli with the --pretty option displays a nicer output, but may not be supported on all platforms.

Tracking data collection

Run wherepy-collector-cli --help to see the tracking data collection options. For instance wherepy-collector-cli -p 5 -o tool-poses.yml to capture the tracking tool's poses at 5 points in time into the file tool-poses.yml.

Licensing and Copyright

Copyright 2018 WherePy contributors. WherePy is released under the Apache License, Version 2.0. Please see the LICENSE file for details.