Alexei
A type-safe interface of image processing algorithms.
Screenshots
Demo
The sample application (the source is in the app folder) has been published on Google Play to facilitate the access:
Setup
Gradle:
dependencies {
compile 'com.github.thiagokimo:alexei-library:1.4'
}
Maven:
<dependency>
<groupId>com.github.thiagokimo</groupId>
<artifactId>alexei-library</artifactId>
<version>1.4</version> </dependency>Usage
The basic API declaration is quite simple:
Alexei.with(context)
.analyze(image)
.perform(calculus)
.showMe(answer);
It's like saying: "Alexei, analyze this image, perform some calculus and give me the answer!"
Example
Alexei.with(context)
.analyze(imageView)
.perform(ImageProcessingThing.DOMINANT_COLOR)
.showMe(new Answer<Color>(){
@Override
public void beforeExecution() {
// anything you want to define before the calculation
}
@Override
public void afterExecution(Color answer, long elapsedTime) {
// your usual things after the calculation
}
@Override
public void ifFails(Exception error) {
// when shit happens, do your stuff here!
}
}
);
Internal Calculus
Alexei has some predefined image processing calculus. Check them out:
Custom Calculus
Create a custom calculus and implement a method called theCalculation, returning the object you expect to calculate. The Answer generic type must match your custom calculus generic type.
Alexei.with(context)
.analyze(image)
.perform(new Calculus<YourObject>() {
@Override
protected YourObject theCalculation(Bitmap image) {
// do your bizarre stuff here!
return new YourObject();
}
}
)
.showMe(new Answer<YourObject>() {
@Override
public void beforeExecution() {
}
@Override
public void afterExecution(YourObject answer, long elapsedTime) {
}
@Override
public void ifFails(Exception error) {
}
}
);
Custom Executor
It is also possible to let Alexei perform its calculus in a custom Executor.
Alexei
.with(context)
.analyze(image)
.perform(calculus)
.withExecutor(YOUR_CUSTOM_EXECUTOR_HERE)
.showMe(answer);
Contribuiting
To suggest a new feature/bug-fix:
- Fork it
- Create your feature/bug-fix branch(
git checkout -b my-new-feature-or-fix) - Commit your changes (
git commit -am 'Add some feature/fix') - Do your pull-request
To add a new predefined calculus:
- Fork it
- Create your feature/bug-fix branch(
git checkout -b my-new-feature-or-fix) - Create your calculus inside
calculuspackage. - Create a fragment in the demo app with the new calculations being applied in an image.
- Do your pull-request.
THE IMAGES OF THE DEMO APP MUST BE HOT BLOND GIRLS.
TODO
- Feed Alexei with more predefined calculus.
Who the fu#% is Alexei?
Alexei was one of my favorite professors in college. He's well known for its studies in Image Processing and Computer Vision fields. It was almost impossible to not think in his class while I was writting this library :P
License
Copyright 2011, 2012 Thiago Rocha Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.