Implementation of CICADA: Colocalization and In-situ Correction of Aberration for Distance Analysis
Ruby Perl
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
cicada.gemspec

README.md

Build Status

#Introduction

This package is a ruby implementation of Colocalization and In-situ Correction of Aberration for Distance Analysis (CICADA). (See Fuller and Straight, 2012, doi:10.1111/j.1365-2818.2012.03654.x)

Depends on the rimageanalysistools package, which in turn depends on the [ImageAnalysisTools java library] (http://cjfuller.github.com/imageanalysistools/). Requires jruby. (Only tested on jruby >=1.7 in ruby 1.9 mode.)

#Installing

gem install cicada

#Running

The gem will install an executable called cicada. To run:

cicada /path/to/parameters/file

#Documentation

API documentation is available here.

Documentation for the parameter files, including which parameters are required and their meanings, can be found on the wiki.

#License

Cicada is released under the MIT/X11 license. See LICENSE for specific text. Some dependencies of the ImageAnalysisTools library are relased under different licenses. See that project's license information for details.