# opensse

**Repository Path**: mirrors_sudoconf/opensse

## Basic Information

- **Project Name**: opensse
- **Description**: Open Sketch Search Engine
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

OpenSSE: Open Sketch Search Engine
==================================

Hello, everybody! 

I'm very interested in [Mathias Eitz's works](http://cybertron.cg.tu-berlin.de/eitz/projects/sbsr/) on SIGGRAPH 2012, so I developed OpenSSE, Just for fun.

This is a open source sketch search engine for 3D object retrieval based on sketch image as input. In fact, it can retrieve more, such as images, videos, point cloud models and volume models, you just need get their line drawing images than I know you can. 

In order to clearly show how to work, I used single thread and ascii encoding for file storage. 

Zhang Dongdong

Demo - SketchSearchDemo
=======================

This demo deals with mesh models. See more search results, click [demo videos](http://opensse.com).

![Sketch search demo](http://img.blog.csdn.net/20140515204902125 "Sketch search demo")

How to compile
==============

OpenSSE uses [Qt 5.1+](http://qt-project.org/), [OpenCV 2.4.7+](http://opencv.org/) and [boost 1.55.0](http://www.boost.org/), it's a cross-platform library. 

You need config `INCLUDEPATH` and `LIBS` in `../opensse/opensse.pri` file related your path. 

Now compile it, so easy!

How to use
==========

### Use OpenSSE library

You just need include one line in your `.pro` file.
```cpp
include(../../opensse.pri)
```

### Use tools

There are a series of tools for you under `opensse/tools/`. When compiled, those tools are under `build-xxx-Release/bin`.

### Use gui

This is gui demo for you under `opensse/gui`.

How to train data
=================

### Database

Database in [my demo](http://opensse.com) comes from [SHREC 2012](http://www.itl.nist.gov/iad/vug/sharp/contest/2012/SBR/data.html), download [3D target dataset](http://www.itl.nist.gov/iad/vug/sharp/contest/2012/SBR/Watertight_dataset.zip)(~112MB). We use models under directory `Watertight_dataset/Extended`.
```shell
$ mv ~/Download/Watertight_dataset/Extended ~/Database/SHREC12/
```

### Get line drawing views

Using my [another project](https://github.com/zddhub/trianglemesh), you will get 102 views for each model.

### Generate vocabulary

- Step 1: Generate line draing images filelist
```shell
$ ./generate_filelist -d ~/Database/SHREC12/ -f "*.jpg" -o ~/Database/SHREC12/2012_filelist
```
- Step 2: Extract descriptors
```shell
$ ./extract_descriptors -d ~/Database/SHREC12/ -f ~/Database/SHREC12/2012_filelist -o ~/Database/SHREC12/2012_
```
you will gain two files: `2012_features` and `2012_keypoints`.
- Step 3: Generate vocabulary (optional)
```shell
$ ./generate_vocabulary -f ~/Database/SHREC12/2012_features -n 1000 -o ~/Database/SHREC12/vocabulary
```
It will take you some times, but only need run once. or use my vocabulary under `../opensse/data/`.

### Create inverted index file 

- Step 4: Quantize feature
```shell
$ ./quantize -v ~/Database/SHREC12/vocabulary -f ~/Database/SHREC12/2012_features -o ~/Database/SHREC12/2012_samples
```

When dealing with large scale database, we can directly generate samples using extract_quantize tool to reduce disk usage without feature files.
```shell
$ ./extract_and_quantize -d ~/Database/SHREC12/ -f ~/Database/SHREC12/2012_filelist -v ~/Database/SHREC12/2012_filelist -v ~/Database/SHREC12/vocabulary -o ~/Database/SHREC12/2012_samples
```

- Step 5: Create inverted index file
```shell
$ ./create_index -s ~/Database/SHREC12/2012_samples -o ~/Database/SHREC12/2012_index_file
```
Now all data are ready.

Test OpenSSE
============

### Command line
You can test opensse through command line
```shell
$ ./sketch_search -i ~/Database/SHREC12/2012_index_file -v ~/Database/SHREC12/vocabulary -d ~/Database/SHREC12/ -f ~/Database/SHREC12/2012_filelist -n 10 -o output
```
You will get a interactive interface, like:
```shell
>> open sketch search :
>> input absolute path, like "/Users/zdd/zddhub.png"
>> input q exit
>> good luck!
>> /Users/zdd/Database/SHREC12/Extended/D00057view/1.jpg
0.985509 /Users/zdd/Database/SHREC12/Extended/D00057view/1.jpg
0.953196 /Users/zdd/Database/SHREC12/Extended/D00050view/1.jpg
0.938705 /Users/zdd/Database/SHREC12/Extended/D00041view/1.jpg
0.856004 /Users/zdd/Database/SHREC12/Extended/D00050view/2.jpg
0.852683 /Users/zdd/Database/SHREC12/Extended/D00057view/2.jpg
0.849087 /Users/zdd/Database/SHREC12/Extended/D00041view/2.jpg
0.823276 /Users/zdd/Database/SHREC12/Extended/D00041view/0.jpg
0.821133 /Users/zdd/Database/SHREC12/Extended/D00050view/10.jpg
0.811917 /Users/zdd/Database/SHREC12/Extended/D00057view/10.jpg
0.810096 /Users/zdd/Database/SHREC12/Extended/D00050view/0.jpg
>> q
```

### Gui Demo - SketchSearchDemo
You must config `params.json` file using your data path, like:
```json
{
    "searcher":
    {
        "indexfile": "/Users/zdd/Database/SHREC12/2012_index_file",
        "filelist": "/Users/zdd/Database/SHREC12/2012_filelist",
        "vocabulary": "/Users/zdd/Database/SHREC12/vocabulary",
        "rootdir": "/Users/zdd/Database/SHREC12",
        "results_num": "12",
        "views_num": "102"
    }
}
```
You'd better to use the absolute path. And then, set `params.json` in `../opensse/gui/SketchSearchDemo/mainwindow.cpp`:
```cpp
boost::property_tree::read_json("/Users/zdd/Database/SHREC12/params.json", params); 
```

Compiled and You will get [my demo](http://opensse.com). Good luck!

Notice: To make sure line drawing images correspond to 3d models, please copy `../opensse/data/view/` to you execute file path.

Evaluation
==========

You can use dataset and evaluation methodology to evaluate opensse on [SHREC 2012](http://www.itl.nist.gov/iad/vug/sharp/contest/2012/SBR/index.html), [SHREC 2013](http://www.itl.nist.gov/iad/vug/sharp/contest/2013/SBR/index.html), [SHREC 2014](http://www.itl.nist.gov/iad/vug/sharp/contest/2014/SBR/index.html).

You can generate data use `test_search` tool in `tests/test_search`.
```shell
Usage:
test_search -p paramsfile -i searchfilelist -r searchfileroot -o resultdir
```

Thanks
======
- [Mathias Eitz](http://cybertron.cg.tu-berlin.de/eitz/)
- [Szymon Rusinkiewicz](http://www.cs.princeton.edu/~smr/)
- [SHREC 2012 - 2014](http://www.itl.nist.gov/iad/vug/sharp/contest/2014/Generic3D/index.html)
- [Tilke Judd](http://people.csail.mit.edu/tjudd/)

License
=======

Code is under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

Donations
=========

I accept tips through [Alipay](http://img.blog.csdn.net/20140506233949640). Scan below qr code to donate:

![Alipay](http://img.blog.csdn.net/20140506233949640 "Donation").

Contact me
==========

If you have any question or idea, please [email to me](mailto:zddhub@gmail.com).