README.md 2.09 KB
Newer Older
danyfel80's avatar
danyfel80 committed
1
# SURF - Speeded Up Robust Features
Daniel Felipe  GONZALEZ OBANDO's avatar
Daniel Felipe GONZALEZ OBANDO committed
2

danyfel80's avatar
danyfel80 committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
This repository contains the code used for the plugin Match SURF Features and Extract SURF Features.

This two plugins are available as both Interface plugins and Protocols blocks.

The project has been prepared using gradle and eclipse to simplify project configuration. See below to setup this project on your machine.

## Installation

### Requirements

In order to be able to work with this project you must have installed the following software:

- **Icy**, version 1.9.5.1 or above. ( [Available here](http://icy.bioimageanalysis.org) )
  - The following plugins should be already installed in order to use the SURF project:
    - EzPlug SDK
    - Protocols SDK
- **Eclipse**, version _Neon_ or above. Make sure to have the _Buildship_ plugin installed. ([Available here](http://www.eclipse.org/downloads/))
- **Icy4Eclipse** plugin for Eclipse, the latest version available. Follow [these](http://icy.bioimageanalysis.org/index.php?display=startDevWithIcy) instructions.

### Setup

1. Use your *Git* repository manager of preference to download this repository (even Eclipse can do this). The repository URL is [https://gitlab.pasteur.fr/bia/org.bioimageanalysis.icy.surf.git](https://gitlab.pasteur.fr/bia/org.bioimageanalysis.icy.surf.git).
2. Make sure the environment variable **ICY_HOME** is set to the location of your Icy installation. _**Note**: This could be tricky on Mac so make sure to follow [these](https://stackoverflow.com/questions/829749/launch-mac-eclipse-with-environment-variables-set) instructions._
3. Open Eclipse and select the menu *File > Import...* Then select *Gradle > Existing Gradle Project*. Click *Next* the project root directory is demanded select the folder **org.bioimageanalysis.icy.surf** inside the folder you downloaded the at. Finally, click *Finish* to create the project in eclipse.

Eclipse will download the dependencies specified in the *gradle.build* file. When it finishes you should see the project without any problem on the project explorer of Eclipse. *If this is not the case, check that the environment variable ICY_HOME is correctly defined.*