Photohawk is a pure Java implementation of the following image comparison algorithms:
- Absolute error
- Equals
- Mean absolute error
- Mean squared error
- Peak absolute error
- Structured similarity metric
Additionally photohawk can be used as a command line app and it packages the implementation as a Taverna plugin for use in a Taverna workflow.
To build the library and plugin, follow these steps:
- Clone the repository
- Go into the repository folder
- Build the project using maven
mvn package
This will create the jar files photohawk-commandline-VERSION.jar and photohawk-commandline-VERSION-jar-with-dependencies.jar in the target folder photohawk-commandline/target.
4. Run the jar with java -jar photohawk-commandline/target/photohawk-commandline-VERSION-jar-with-dependencies.jar
To build the library and plugin, follow these steps:
- Clone the repository
- Go into the repository folder
- Build the project using maven
mvn deploy
This will deploy the built packages to /tmp/photohawk and /tmp/photohawk-SNAPSHOT respectively.
Alternatively override the distributionManagement in your settings.xml.
4. Update the photohawk-repository and photohawk-snapshot-repository in the photohawk-plugin-VERSION.xml to point to your repository
5. Copy the deployed artefacts your repository
Note that a hosted version is currently available at http://datascience.github.io/photohawk/taverna/updates/2.4.0/snapshot.
- Open Taverna
- Add the plugin site
- Open
Menu -> Advanced -> Updates and plugins -> Find new plugins -> Add update site - Choose a site name
- Enter the site URL
http://datascience.github.io/photohawk/taverna/updates/2.4.0/releaseorhttp://datascience.github.io/photohawk/taverna/updates/2.4.0/snapshot
- Open
- Install the plugin
- Tick the checkbox next to
Photohawk Taverna plugin - Click Install
- Tick the checkbox next to
- Restart Taverna
- Install Eclipse
- Install Maven 3
- Install the m2eclipse plugin
- Create a new workspace
- Import the projects
- Open
File -> Import... -> Existing Maven Projects - Select the repository as
Root Directory - Select all projects
- Click
Finish
- Open
- Install the checkstyle plugin
- Set up the code formatter
- Open
Window -> Preferences - Open
Java -> Code style -> Formatter - Click
Import...and select the filecode-style/eclipse_formatter.xml
- Open
- Set up checktyle
- Open
Window -> Preferences - Open
Checkstyle - Select
New... -> External configurationand selectcode-style/checkstyle.xml - Activate the checkstyle plugin for all projects
- Open
Right click photohawk-activity-ui/src/test/java/at.ac.tuwien.photohawk.taverna.ui.TavernaWorkbenchWithExamplePlugin.java and select Debug as -> Java Application.
For further information check Testing the service in Taverna of the Taverna tutorial Creating plugins for Taverna 2.