PoseCNN: A Convolutional Neural Network for 6D Object Pose Estimation in Cluttered Scenes

Created by Yu Xiang at RSE-Lab at University of Washington and NVIDIA Research.

Introduction

We introduce PoseCNN, a new Convolutional Neural Network for 6D object pose estimation. PoseCNN estimates the 3D translation of an object by localizing its center in the image and predicting its distance from the camera. The 3D rotation of the object is estimated by regressing to a quaternion representation. arXiv, Project

License

PoseCNN is released under the MIT License (refer to the LICENSE file for details).

Citation

If you find PoseCNN useful in your research, please consider citing:

@inproceedings{xiang2018posecnn,
    Author = {Xiang, Yu and Schmidt, Tanner and Narayanan, Venkatraman and Fox, Dieter},
    Title = {PoseCNN: A Convolutional Neural Network for 6D Object Pose Estimation in Cluttered Scenes},
    Journal   = {Robotics: Science and Systems (RSS)},
    Year = {2018}
}

Installation

Install TensorFlow version r1.8 from source, binaries won't work because of ABI incompatibilities.
1. You need exactly r1.8, gcc 4.8.(tested with 4.8.5, 6.3. will not work) and bazel 0.10.0 even though bazel 0.9.0 is recommended here, see following issue. Bazel 0.17.0 also does not work and probably other Bazel versions don't work either so really use 0.10.0
2. Make a virtualenv with and add these packages, otherwise tf can not be build by source: pip install mock keras Cython easydict transforms3d(the last two are needed for later to actually run the demo)
Download the VGG16 weights from here (528M). Put the weight file vgg16.npy to $ROOT/data/imagenet_models.
Get dependencies: sudo apt-get install libsuitesparse-dev openexr libopenexr-dev metis libmetis-dev
Compile lib/kinect_fusion to be able to compile lib/synthesize.
1. Add nanoflann to the include dirs in cmake and sohpus to the include and link dirs
2. Comment /usr/local/cuda/include/crt/common_functions.h line 64: see this issue
3. If Pangolin is already installed, reinstall Pangolin, since it will be pointing at the old eigen which has the cuda bug mentioned here: https://devtalk.nvidia.com/default/topic/1026622/cuda-programming-and-performance/nvcc-can-t-compile-code-that-uses-eigen/
Compile lib/synthesize with cmake. This package contains a few useful tools such as generating synthetic images for training and ICP.

Install dependencies with exactly these commits. I tried other commits and they all broke/did not build:
- Python version 2.7, 3.X won't work
- Pangolin commit 1ec721d59ff6b799b9c24b8817f3b7ad2c929b83 worked for me, original author used c2a6ef524401945b493f14f8b5b8aa76cc7d71a9
- Eigen 3. * . * (tested with 3.3.0 and 3.2.92)
- boost 1.67.0
- Sophus commit ceb6380a1584b300e687feeeea8799353d48859f
- nanoflann commit ad7547f4e6beb1cdb3e360912fd2e352ef959465
- nlopt Important install from this github repo, not using the instructions here commit 74e647b667f7c4500cdb4f37653e59c29deb9ee2
We use Boost.Python library to link tensorflow with the c++ code. Make sure you have it in your Boost. The tested Boost version is 1.66.0.
1. Change hard coded pathes in lib/synthesize/CMakeLists.txt of boost and add sophus paths manually or via find_script. Uncomment line #add_definitions(-D_GLIBCXX_USE_CXX11_ABI=0) to fix potential compatibility issues with tf.
2. Uncomment ${CUDA_TOOLKIT_ROOT_DIR}/samples/common/inc from include dirs because of this issue: stevenlovegrove/Pangolin#268
3. Surpress these warnings so you see errors better.
```
   add_definitions(-Wno-unused-result)
   add_definitions(-Wno-unused-but-set-variable)
   add_definitions(-Wno-unused-variable)
   add_definitions(-Wno-reorder)
   add_definitions(-Wno-deprecated-declarations)
```
1. Make GlBuffer(const GlBuffer&) {} public in file /usr/local/include/pangolin/gl/gl.h by commenting line 209. Same goes for line 116
2. Adapt boost_python and boost_numpy in Cmake line 98/99 to your library name when using boost and python 3.5 it is boost_python27 and boost_numpy27 or symlink these to boots_python and boost_numpy.
3. Create folder data and models under data/LOV and add or symlink the data and models into there
Uncomment line 64 in /usr/local/cuda/include/crt/common_functions.h
Download the sun2012 dataset. Unzip the contents of it into the folder PoseCNN/data/Sun2012/data.
Download ObjectNet3D from ftp://cs.stanford.edu/cs/cvgl/ObjectNet3D/ObjectNet3D_images.zip. Unzip the contents of it into the folder PoseCNN/data/ObjectNet3D/data. For why the link is written out see here and bug github about that bug ;)

Notes on ABI Compatibility

Either all packages used need to be built with gcc 4.8.5 or if some use gcc 5 or above all above packages need following line added to the compilation: -D_GLIBCXX_USE_CXX11_ABI=0
ABI Compatibility issues will manifest themselves through the message "some_lib.so": undefined symbol: "some obfuscated coed snippet". The easiest to get this whole project to compile is to compile every package with the same gcc version. But take care, because per default opencv will be compiled with gcc 5.4 and will get included in various binaries. Check and make sure you link against your custom built binaries using ldd your_binary.so. To give you the above error already at compile time instead of runtime add following to the compile command: -Wl,-z,defs.

Building

Warning nothing can be built in parallel, don't do make -jX just use make

Build kinect_fusion

```Shell
cd $ROOT/lib/kinect_fusion
mkdir build
cd build
cmake ..
make
```

Build synthesize

```Shell
cd $ROOT/lib/synthesize
mkdir build
cd build
cmake ..
make
```

Compile the new layers under $ROOT/lib we introduce in PoseCNN. Shell cd $ROOT/lib sh make.sh
run python setup python setup.py build_ext --inplace
Add pythonpaths

Add the path of the built libary libsynthesizer.so to python path
```Shell
export PYTHONPATH=$PYTHONPATH:$ROOT/lib:$ROOT/lib/synthesize/build
```

Required environment

Ubuntu 16.04
Tensorflow >= 1.2.0
CUDA >= 8.0

Running the demo

Download our trained model on the YCB-Video dataset from here, and save it to $ROOT/data/demo_models.
run the following script
```
./experiments/scripts/demo.sh $GPU_ID
```

Running on the YCB-Video dataset

Download the YCB-Video dataset from here.
Create a symlink for the YCB-Video dataset (the name LOV is due to legacy, Learning Objects from Videos)
```
cd $ROOT/data/LOV
ln -s $ycb_data data
ln -s $ycb_models models
```

Training and testing on the YCB-Video dataset

cd $ROOT

# training
./experiments/scripts/lov_color_2d_train.sh $GPU_ID

# testing
./experiments/scripts/lov_color_2d_test.sh $GPU_ID

Kaju-Bubanja / PoseCNN