stream.image.features

Class AverageRGB

java.lang.Object

stream.AbstractProcessor

stream.image.AbstractImageProcessor

stream.image.features.AverageRGB

All Implemented Interfaces:

ImageProcessor, stream.Processor, stream.StatefulProcessor

public class AverageRGB
extends AbstractImageProcessor

This processor computes the average color value for all three RGB channels.

Author:

chris, Matthias

Field Summary

Fields inherited from class stream.image.AbstractImageProcessor

imageKey

Fields inherited from class stream.AbstractProcessor

context

Fields inherited from interface stream.image.ImageProcessor

DEFAULT_IMAGE_KEY

Constructor Summary

Constructors

Constructor and Description
AverageRGB()

Method Summary

Modifier and Type	Method and Description
Boolean	getIncludeRatios() Delivers, if the processor is including the ratios or not.
stream.Data	process(stream.Data item, ImageRGB img)
void	setIncludeRatios(boolean includeRatios) If desired, the processor includes the ration between the color channels.

Methods inherited from class stream.image.AbstractImageProcessor

getImage, process, setImage

Methods inherited from class stream.AbstractProcessor

finish, init, resetState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AverageRGB

public AverageRGB()

Method Detail

setIncludeRatios

@Parameter(description="Sets, if the processor includes the ration between the color channels, or just the average RGB color values. Ratios are (red/blue), (red/green), (green/blue).",
           defaultValue="false")
public void setIncludeRatios(boolean includeRatios)

If desired, the processor includes the ration between the color channels. Ratios are { (red/blue), (red/green), (green/blue) }.

Parameters:

includeRatios -

getIncludeRatios

public Boolean getIncludeRatios()

Delivers, if the processor is including the ratios or not.

Returns:

process

public stream.Data process(stream.Data item,
                           ImageRGB img)

Specified by:

process in interface ImageProcessor

Specified by:

process in class AbstractImageProcessor