Metadata-Version: 2.1
Name: maskslic
Version: 0.3.4.post1
Summary: Simple linear iterative clustering (SLIC) in a region of interest (ROI)
Home-page: https://www.birving.com
Author: Benjamin Irving
Author-email: mail@birving.com
License: Copyright (C) 2016-2019, Benjamin Irving. See LICENSE file for distribution conditions
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: License :: Free for non-commercial use
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# maskSLIC
Simple linear iterative clustering (SLIC) in a region of interest

## Outline
This code demonstrates the adaption of SLIC for a defined region of interest. 
The main contribution is in the placement of seed points within the ROI. 

The code is a modification of the SLIC implementation provided by Scikit-image (http://scikit-image.org/)

An online demo is available at: http://maskslic.birving.com/index

An outline of the method is available at: http://arxiv.org/abs/1606.09518

Figure 1: An example region and the automatically placed seed points using this method. 

![seed points](doc/images/p1.png)

Figure 2: The final superpixel regions within the ROI

![superpixels](doc/images/p2.png)

## Getting started

Install dependencies  
`pip install -r requirements.txt`

build cython code  
`python setup.py build_ext --inplace`

run example  
`python run_example.py`

Using a python `virtualenv` is reccommended on linux to get the latest versions of the dependencies. 


## Development
This code is still a work in progress.
