REGREGISTRATION MODULE
======================

RegRegistration is an ICP-based registration module for a tabletop environment.

Dependencies
------------

 * libpointmatcher
 * Kinect SDK
 * Unity 5

Manual calibration
------------------

Real-world boundaries

 * Check reliable boundaries using Kinect Configuration Verifier
   * Wait for verifications steps to complete
   * Expand "Verify Kinect Depth and Color Streams" tool
   * View colour and infrared streams and locate objects in scene
   * Avoid distances where objects turn white/black (typically too close to the sensor)
   * Minimum recommended distance published by Microsoft (1.37m) is for human
     registration using the Kinect libraries. This recommendation does not apply to
     tabletop registration (models can be closer).

Culling cuboid
   
 * Run ExampleClouds scene
 * Capture the whole IPP scene
   * Set IPP min/max to (-1000,-4000,-1000) - (1000,-1,1000)
   * Press "O" to save scene from sensor
 * Adjust min/max
   * Open whole IPP scene in ParaView
   * Isolate edge clouds
   * Note edge dimensions
   * Update IPP min/max
 * Capture bounded IPP scene
 * Verify bounding values
   * Open IPP capture in ParaView
   * Repeat adjustments until correct

Cluster variables
 
 * Adjust cluster variables
   * Open IPP capture in ParaView
   * Manually isolate representative clusters
   * Note cluster dimensions and point count
   * Note maximum length of any dimension in any cluster
   * Note maximum point count of any cluster
 * Run ExampleClouds scene
 * Capture the IPP scene as clusters
   * Set IPP min/max
   * Set cluster radius to maximum length
   * Set cluster point count to maximum point count
   * Press "U" to save clusterised scene from sensor
 * Verify cluster variables
   * Open cluster captures in ParaView
   * Repeat adjustments until correct

License: AGPL v3 or later
-------------------------

Copyright (C) 2015 PREVIZ team

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
