org.openimaj.image.feature.global

Class AvgBrightness

java.lang.Object

org.openimaj.image.mask.AbstractMaskedObject<FImage>

org.openimaj.image.feature.global.AvgBrightness

All Implemented Interfaces:

FeatureVectorProvider<DoubleFV>, ImageAnalyser<MBFImage>, MaskedObject<FImage>

public class AvgBrightness
extends AbstractMaskedObject<FImage>
implements ImageAnalyser<MBFImage>, FeatureVectorProvider<DoubleFV>

Extract the average brightness of an image. Brightness can be computed in a number of different ways, depending on the chosen AvgBrightness.Mode.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AvgBrightness.Mode Modes for computing brightness.

Field Summary

Fields inherited from class org.openimaj.image.mask.AbstractMaskedObject

mask

Constructor Summary

Constructors

Constructor and Description
AvgBrightness() Construct with the NTSC_LUMINANCE mode and no mask set
AvgBrightness(AvgBrightness.Mode mode) Construct with the given mode and no mask set
AvgBrightness(AvgBrightness.Mode mode, FImage mask) Construct with the given mode and a mask.

Method Summary

Modifier and Type	Method and Description
void	analyseImage(MBFImage image) Analyse an image.
double	getBrightness() Get the brightness.
DoubleFV	getFeatureVector() Get the FeatureVector associated with this object.

Methods inherited from class org.openimaj.image.mask.AbstractMaskedObject

getMask, setMask

Methods inherited from class java.lang.Object

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

Constructor Detail

AvgBrightness

public AvgBrightness()

Construct with the NTSC_LUMINANCE mode and no mask set

AvgBrightness

public AvgBrightness(AvgBrightness.Mode mode)

Construct with the given mode and no mask set

Parameters:

mode - the AvgBrightness.Mode

AvgBrightness

public AvgBrightness(AvgBrightness.Mode mode,
                     FImage mask)

Construct with the given mode and a mask.

Parameters:

mode - the AvgBrightness.Mode

mask - the mask.

Method Detail

analyseImage

public void analyseImage(MBFImage image)

Description copied from interface: ImageAnalyser

Analyse an image.

Specified by:

analyseImage in interface ImageAnalyser<MBFImage>

Parameters:

image - The image to process in place.

getBrightness

public double getBrightness()

Get the brightness.

Returns:

the brightness

getFeatureVector

public DoubleFV getFeatureVector()

Description copied from interface: FeatureVectorProvider

Get the FeatureVector associated with this object.

Specified by:

getFeatureVector in interface FeatureVectorProvider<DoubleFV>

Returns:

the feature vector.