The tvseg software is a library and GUI tool image segmentation.
C++ Cuda QMake Matlab C Shell Objective-C

README.md

TVSEG

variational image segmentation

Introduction

The tvseg software is a library and GUI tool image segmentation. For now we implement interactive image segmentation based on spatially-varying color and depth distributions.

Qt GUI Screenshot

Getting started

tvseg is platform independent in principle, but so far has only been developed and tested on Mac OS X 10.9.

Dependencies

You will need boost, opencv, Qt 5 and CUDA (tested with version 6.0).

Mac OS X

Due to issues of CUDA with the clang compiler and libc++, out of the box tvseg will look for special versions of the above libraries, linked against libstdc++, which you can install using Homebrew from my custom Tap

brew install NikolausDemmel/devel/boost-libstdcxx
brew install NikolausDemmel/devel/opencv-libstdcxx.rb
brew install NikolausDemmel/devel/qt5-libstdcxx.rb

Alternatives, like using GCC will require you to manually tweak the tvseg.pro file.

With all dependencies installed, you should be able to open the project in QtCreator and compile it.

Other platforms

In order to get tvseg to compile and run a little bit of manual tweaking of the tvseg.pro project file is currently necessary. We hope to support at least Linux out of the box in the future.

Contribution

Please fork, hack away and send pull requests.

See AUTHORS.md.

Documentation

Screencasts

TODO

Parameter file description

An overview over the parameters that can be set in the settings.ini and through the GUI can be found in documentation for settings.

Theory

There is a report describing spatially varying color and depth distributions as implemented by tvseg and an accompanying set of slides.

Code structure overview

The following gives a high-level overview over the code structure. In general the software is structured to distinguish between the Qt GUI and the core library with all algorithms. The library is independent from Qt (at the time of writing this is not quite true, but that is at least the intention) and uses Boost and OpenCV and the STL, so there is some amount of data conversion going on between library and GUI, but this is aided by helper functions.

There is fair amount of boilerplate code that is necessary for

  • making a clean interface between GUI and library, while the former is using Qt data structures, while the latter is relying on STL and Boost;
  • dealing with the oddities of CUDA with clang; even when using libstdc++, CUDA chokes on some includes like Bosst.Assert (which implies also e.g. Boost shared_ptr) or OpenCV, meaning we have to make sure non of those headers are included in the definition of any data structure that we mean to pass down to CUDA code;
  • facilitating parts of the code base that are envisioned to be more general than they currently are implemented. For example the CVAlgorithmInterface and AlgorithmWidget do not make perfect sense in their currently fairly limited use/implementation.

The source file layout is as follows:

LICENSE

This repository contains modified version of various software libraries for which you might have to consider the original license (this list is not necessarily exhaustive):

project files license
Boost: Enum, Fusion lib/boost/, lib/tvseg/settings/defineparams.h Boost License
Easylogging++ lib/tvseg/3rdparty/ MIT license
NVIDIA CUDA samples lib/tvseg/cuda/errorhandling.h, lib/cuda_samples/ CUDA samples EULA
rosconsole lib/tvseg/util/logging.h BSD license
QtPropertyBrowser src/3rdparty/qtpropertybrowser/ BSD license: see source files
MatLab scripts from the NYU2 dataset toolbox image_capture/ website

All original code in the tvseg project is licensed under a BSD license:

Copyright (c) 2013, 2014, Nikolaus Demmel
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.