CPPF is a pure sim-to-real method that achieves 9D pose estimation in the wild. Our model is trained solely on ShapeNet synthetic models (without any real-world background pasting), and could be directly applied to real-world scenarios (i.e., NOCS REAL275, SUN RGB-D, etc.). CPPF achieves the goal by using only local
- [2024.07] Check our new object pose estimation benchmark PACE on ECCV 2024.
- [2024.04] Check our CPPF++ (TPAMI) for even better results in the wild!
- [2022.03] Our another Detection-by-Voting method Canonical Voting, which achieves SoTA on ScanNet, SceneNN, SUN RGB-D is accepted to CVPR 2022.
- [2022.05.05] Fix a problem in scale target computing.
- Overview
- Installation
- Train on ShapeNet Objects
- Pretrained Models
- Test on NOCS REAL275
- Test on SUN RGB-D
- Train on Your Own Object Collections
- Citation
This is the official code implementation of CPPF, including both training and testing. Inference on custom datasets is also supported.
You can run the following command to setup an environment, tested on Ubuntu 18.04:
Create Conda Env
conda create -n cppf python=3.8
Install Pytorch
conda install pytorch torchvision cudatoolkit=10.2 -c pytorch-lts
Install Other Dependencies
pip install tqdm opencv-python scipy matplotlib open3d==0.12.0 hydra-core pyrender cupy-cuda102 PyOpenGL-accelerate OpenEXR
CXX=g++-7 CC=gcc-7 pip install MinkowskiEngine==0.5.4 -v
Miscellaneous
Notice that we use pyrender with OSMesa support, you may need to install OSMesa after running pip install pyrender, more details can be found here.
MinkowskiEngine append its package path into sys.path (a.k.a., PYTHONPATH), which includes a module named utils. In order not to get messed with our own utils package, you should import MinkowskiEngine after importing utils.
Data Preparation
Download ShapeNet v2 dataset and modify the shapenet_root key in config/config.yaml to point to the location of the dataset.
Train on NOCS REAL275 objects
To train on synthetic ShapeNet objects that appear in NOCS REAL275, run:
python train.py category=bottle,bowl,camera,can,laptop,mug -m
For laptops, an auxiliary segmentation is needed to ensure a unique pose. Please refer to Auxiliary Segmentation for Laptops/
Train on SUN RGB-D objects
To train on synthetic ShapeNet objects that appear in SUN RGB-D, run:
python train.py category=bathtub,bed,bookshelf,chair,sofa,table -m
Auxiliary Segmentation for Laptops
For Laptops, geometry alone cannot determine the pose unambiguously, we rely on an auxiliary segmentation network that segments out the lid and the keyboard base.
To train the segmenter network, first download our Blender physically rendered laptop images from Google Drive and place it under data/laptop. Then run the following command:
python train_laptop_aux.py
Pretrained models for various ShapeNet categories can be downloaded from Google Drive.
Data Preparation
First download the detection priors from Google Drive, which is used for evaluation with instance segmentation or bounding box masks. Put the directory under data/nocs_seg.
Then download RGB-D images from NOCS REAL275 dataset and put it under data/nocs.
Place (pre-)trained models under checkpoints.
Evaluate with Instance Segmentation Mask
First save inference outputs:
python nocs/inference.py --adaptive_voting
Then evaluate mAP:
python nocs/eval.py | tee nocs/map.txt
Evaluate with Bounding Box Mask
First save inference outputs with bounding box mask enabled:
python nocs/inference.py --bbox_mask --adaptive_voting
Then evaluate mAP:
python nocs/eval.py | tee nocs/map_bbox.txt
Zero-Shot Instance Segmentation and Pose Estimation
For this task, due to the memory limitation, we use the regression-based network. You can go through the process by running the jupyter notebook nocs/zero_shot.ipynb.
Data Preparation
We follow the same data preparation process as in VoteNet. You need to first download SUNRGBD v2 data (SUNRGBD.zip, SUNRGBDMeta2DBB_v2.mat, SUNRGBDMeta3DBB_v2.mat) and the toolkits (SUNRGBDtoolbox.zip). Move all the downloaded files under data/OFFICIAL_SUNRGBD. Unzip the zip files.
Download the prepared extra data for SUN RGB-D from Google Drive, and move it under data/sunrgbd_extra. Unzip the zip files.
Evaluate with Instance Segmentation Mask
First save inference outputs:
python sunrgbd/inference.py
Then evaluate mAP:
python sunrgbd/eval.py | tee sunrgbd/map.txt
Configuration Explained
To train on custom objects, it is necessary to understand some parameters in configuration files.
- up_sym: Whether the objects look like a cylinder from up to bottom (e.g., bottles). This is to ensure the voting target is unambiguous.
- right_sym: Whether the objects look like a cylinder from left to right (e.g., rolls). This is to ensure the voting target is unambiguous.
- regress_right: Whether to predict the right axis. Some symmetric objects only have a up axis well defined (e.g., bowls, bottles), while some do not (e.g., laptops, mugs).
- z_right: Whether the objects are placed such that the right axis is [0, 0, 1] (default: [1, 0, 0]).
Voting Statistics Generation
Next, we need to know the scale_range (used for data augmentation, control possible object scales along the diagonal), vote_range (the range for center voting targets scale_mean (the average 3D scale, used for scale voting). To generate them, you may refer to gen_stats.py.
Write Configuration Files and Train
After you prepare the necessary configurations and voting statistics, you can write your own configuration file similar to that in config/category, and then run train.py.
@inproceedings{you2022cppf,
title={CPPF: Towards Robust Category-Level 9D Pose Estimation in the Wild},
author={You, Yang and Shi, Ruoxi and Wang, Weiming and Lu, Cewu},
booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
year={2022}
}