dzhoshkun / wherepy Goto Github PK

• wherepy-collector-cli --num-measurements 20 --output-file point.yml

For development it'd be convenient to have a --dry-run (-d) option that will display dummy data.

As per the discussion in dzhoshkun/ndicapi#14:

• test both WherePy CLI apps with:
  • Python 2
  • Python 3

Then re-open PlusToolkit/ndicapi#13. After that:

• make the relevant changes in WherePy
• document Python 3 support
• document Python 3 support on the hands-on session repo as well

The version should be used in #2 for keeping track of which version created a session log.
versioneer can help manage the version dynamically, compatible with most if not all installation types.

• NdiTracker or wherepy.track.ndi.Tracker class, sub-class of Tracker
• add ndicapi dependency (at least document it)

On first launch WherePy should:

• create a wherepy.home* = '$HOME/.wherepy/' folder
• create a wherepy.sessions_default() = os.path.join(wherepy.home(), 'sessions') folder

See esp. :

• #20 (comment)
• #20 (comment)

Simple tracking quality indicator similar to a wi-fi indicator

States:

• no device => red cross
• no data => dot only
• weak signal => one "bar"
• okay signal => two "bars"
• strong signal => three "bars"

https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI

Something along these lines:

Signal: |>>>>>>>>  |    85 %
Error:  |<<        | 1.35 mm

Edge cases:

• infinite tracking error

Signal: |        |    0 %
Error:  |<<<<<<<<|  infinity

print(u"\u221E")

• no device connected

Signal: |NO CONNECTION|   0 %
Error:  |NO CONNECTION|

• #1 (comment)

• when connecting
• while collecting poses: 8 poses collected
• when terminating: saved to file ...
• consider making it real-time live as in the indicator application

The info message is sometimes truncated:

 (py2)  ~/tmp/  wherepy-collector-cli -p 100 -o test
|  Device  |       Signal      |   Error   |                Info                |
---------------------------------------------------------------------------------
  OFFLINE    [          ]  0 %       NA       Could not connect (Could not detec 

The lines I used to enable logging in https://github.com/dzhoshkun/wherepy/blob/master/wherepy/app/_collector.py#L6:

root = logging.getLogger()
root.setLevel(logging.DEBUG)

From https://stackoverflow.com/a/14058475/3956024

And I added the logging for each capture here: https://github.com/dzhoshkun/wherepy/blob/master/wherepy/app/_collector.py#L38

I'd PR, but you'll handle it more conveniently.

Candidates are:

• tkinter
• PyQt (requires Qt, maybe an overkill?)
• web-based ?
  • pythrust (requires Python 3)
  • electron (requires compilation...)

To fix an ugly look like this:

1:
  1:
    coordinates: [91.4, 84.2, -269.16]
    error: 0.058800000000000005
    quality: 0.9803999999999999
    quaternion: [0.2569, -0.8323, -0.46440000000000003, -0.15940000000000001]
    timestamp: 1519136567.998299

1. document installation via GitHub repo
2. tests (?) => #14
3. setup.py
   1. dependencies: pyndicapi
4. setup.cfg (only Python 2 ) => using python_requires instead
5. wherepy-collector-gui [--session-folder /path/to/session/folder] command
6. wherepy-collector-cli [--session-folder /path/to/session/folder] command (?)
7. create a wherepy.home*( = '$HOME/.wherepy/' folder #10
8. create a wherepy.sessions_default() = os.path.join(wherepy.home(), 'sessions') folder #10
9. default session folder: os.path.join(wherepy.sessions_default, '2018-02-17-09-17-14-serial-no') #11
10. wherepy.io package #2
11. wherepy.trackpackage #3
12. wherepy.gui package #1
13. wherepy.app package with Collector class
    1. Collector(graphical=True) (?)

• PyYAML dependency
  • README
  • setup.py
• Each launch should create a session file 000000-2018-02-17-08-49-13.yml within root sessions folder => will be addressed part of the application
• SessionLog class:
  • SessionLog(filepath):
  • append(tool_pose):
    1. tool_pose => YAML representation
    2. save the pose:

wherepy:
  version: git-described
0:
  port1:
    quaternion: "q0 q1 q2 q3"
    coordinates: "x y z"
    error: e
    quality: qu
    timestamp: t0
1:
  port1:
    quaternion: "q0 q1 q2 q3"
    coordinates: "x y z"
    error: e
    quality: qu
    timestamp: t1
[...]
N:
  port1:
    quaternion: "q0 q1 q2 q3"
    coordinates: "x y z"
    error: e
    quality: qu
    timestamp: tN

See for instance this sample dataset

• display phantom
• next to each acquisition point, put a button to acquire N measurements:
  • point A
  • point B
  • point C
  • point D

• depends on #10
• os.path.join(wherepy.sessions_default, '2018-02-17-09-17-14-serial-no')

• Travis CI
• license
• pylint => no such separate badge
  • depends on #13

During the hands-on session yesterday the system was sometimes capturing quaternions as 'M', 'I', 'S', 'S', an artefact of parsing the transform, which actually is nothing other than the word MISSING.

Probably the best strategy is to parse the returned transform into a float, and catch the ValueError.

Always getting an invalid port handle selected error when trying to use the newer NDI control units.

After #24 maybe the following format would play more nicely on a wider range of computers (due to terminal line width):

|   Device   |       Signal      |   Error   |       Information        |
-------------------------------------------------------------------------
      [✓]      [====>     ] 54 %    1.54 mm       info message here.     

The following higher-level classes for representing a tracker connection and tool poses should be implemented:

• abstract Tracker class:
  • connect() raising IOError (auto-connect() on __init__)
  • disconnect() raising IOError
  • connected()
  • tool_pose = capture(tool_id) raising
    • IOError if not connected()
    • ValueError if tool_id invalid
• ToolPose class:
  • id() => not None
  • quaternion() => of len() 4
  • coordinates() => of len() 3
  • quality, error = quality() => between 0.00 - 1.00 (100%), error is what is returned by tracking system
  • timestamp() => python -c "import time; print('{:.10f}'.format(time.time()))"
    • default is now()

This is related to #2

• tests folder
• Travis CI stage for testing

pylint complains about too-many-locals in the display_status function.
This is possibly an indication that this function is doing too much and needs to be simplified.