org.openimaj.image.feature.global

Enum AvgBrightness.Mode

java.lang.Object

java.lang.Enum<AvgBrightness.Mode>

org.openimaj.image.feature.global.AvgBrightness.Mode

All Implemented Interfaces:

Serializable, Comparable<AvgBrightness.Mode>

Enclosing class:

AvgBrightness

public static enum AvgBrightness.Mode
extends Enum<AvgBrightness.Mode>

Modes for computing brightness.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
NTSC_LUMINANCE Luminance using the NTSC weighting scheme (equivalent to the Y in the YUV colour space)

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	computeBrightness(MBFImage img, FImage mask) Compute the average brightness of the given image (applying the mask if it's not null).
static AvgBrightness.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AvgBrightness.Mode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NTSC_LUMINANCE

public static final AvgBrightness.Mode NTSC_LUMINANCE

Luminance using the NTSC weighting scheme (equivalent to the Y in the YUV colour space)

Method Detail

values

public static AvgBrightness.Mode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AvgBrightness.Mode c : AvgBrightness.Mode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AvgBrightness.Mode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

computeBrightness

public abstract double computeBrightness(MBFImage img,
                       FImage mask)

Compute the average brightness of the given image (applying the mask if it's not null).

Parameters:

img - the image to extract the average brightness from

mask - the mask

Returns:

the average brightness