Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 5.7 KB

README.md

File metadata and controls

60 lines (46 loc) · 5.7 KB
Raw

KinectIPD

KinectIPD is a utility to measure a person’s IPD (inter-pupillary distance) and optionally set the IPD on a HoloLens device automatically. This is especially useful in situations where many users are using a HoloLens device such as demos or tradeshows. In testing, KinectIPD was accurate to +- 2 millimeters, which should be adequate for most HoloLens scenarios.

Building:

  • Install the latest version of the Kinect SDK from: https://developer.microsoft.com/en-us/windows/kinect

  • Note: KinectIPD was primarily tested on 64bit systems. Additional work may be required to run on 32bit systems.

  • Download the project from GitHub in a ZIP file, or clone the repo to your developer PC.

  • Start Microsoft Visual Studio 2015 and select File > Open > Project/Solution.

  • In the KinectIPD folder, double click on KinectIPD_Kiosk.sln to open the sample in Visual Studio.

  • Change the build configuration to Release/x64.

  • Press F5 to start the application.

How to use:

Connect a Kinect 2.0 camera to a PC/Laptop and run KinectIPD. After startup, the app will be waiting for a user to be discovered in frame. Once it finds a face, it will instruct the user to move closer/farther away until they are at an acceptable distance. At this point the tool will extract a rectangle around each eye, passing the data to the “PupilDetectDLL” component, where a pupil detection algorithm will be run on it. When the pupils are discovered, the pixel coordinates are translated to 3D space and the distance between the pupils are measured. This will be repeated for each frame until a minimum number of successful samples are discovered (20 by default), and the standard deviation of the measurements falls below a specified value (1mm by default, plus a slowly increasing tolerance over time). When a valid IPD has been measured, based on those criteria, the app will either display the IPD to the screen, and/or write the value to a configured HoloLens device. After a short amount of time (7.5 seconds), the app will reset back to its “attract” state, waiting for a user to enter the camera frame.

Various settings can be changed by switching into “debug mode” by pressing X or Spacebar on the keyboard.

  • AutoExposure: Enabling this option will have the app attempt to adjust the exposure of the image so that the area around the eyes is at a specified brightness.
  • Exposure: The current exposure of the image. This can be manually adjusted when not in Auto Exposure mode. In general, a brighter image will work better for image processing.
    Note: It is recommended to have supplemental lighting (i.e. LED strip lights) on either side of the camera to light the user’s face better.
  • Target Luma: This is the value that AutoExposure will use as a target value.
  • Vertical Offset: Occasionally the Kinect face tracking will report the position of the eyes as higher/lower than they actually are – resulting in poor results when detecting pupils. This adjustment offsets the eye boxes to accommodate the difference.
  • HoloLens Programming Mode: The application can optionally program a HoloLens device with the IPD after successful measurement. There are 3 modes available:
  • Display Only: The application will only display the IPD at the end of the measurement process. The IPD can then be manually submitted to the HoloLens using another tool.
  • Device List: One or more devices can be specified by Name/IP/Username/Password to automatically be programmed at the end of measurement. The IP address can be http://localhost:10080 if connected via USB, the actual network IP of the device if known, or set to auto-discover the network IP (this requires being connected to USB).
  • NFC Tag: A tag can be placed on the HoloLens so that when the device is placed onto an NFC reader, the Name/IP/Username/Password will be read from the tag, and automatically programmed. See below for more info on tags, readers and a mount.

Recording/Playback:

The Kinect streams can be recorded to be played back for debugging/testing.

  • To record a session, press the R button on the keyboard or the “record session” button in the debug view (press X/space to activate the debug view.) It will record for 20 seconds maximum, or until you press the record button again. Start the session before the user is discovered, then have them approach the camera as normal and stand in place for the rest of the session.
  • To play a session, press the E button on the keyboard, or the “play session” button in the debug view (then choose the file to play back).

Caveats:

  • During playback, the exposure can’t be adjusted (since we talk to the driver). Thus you should record multiple sessions of each person at different exposure settings (and auto-exposure turned off).
  • The files are LARGE – (3GB+ for 30 seconds of data).

NFC Reader/Tags and mount:

KinectIPD has been tested with the following NFC components:

Project Dependencies:

KinectIPD makes use of several OSS projects: