org.openimaj.image.processing.mask

Enum MatteGenerator.MatteType

java.lang.Object

java.lang.Enum<MatteGenerator.MatteType>

org.openimaj.image.processing.mask.MatteGenerator.MatteType

All Implemented Interfaces:

Serializable, Comparable<MatteGenerator.MatteType>

Enclosing class:

MatteGenerator

public static enum MatteGenerator.MatteType
extends Enum<MatteGenerator.MatteType>

An enumerator for various matte algorithms.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANGLED_LINEAR_GRADIENT Generates linear gradients that can be angled to any angle.
LINEAR_HORIZONTAL_GRADIENT A basic linear horizontal gradient.
LINEAR_VERTICAL_GRADIENT A basic linear vertical gradient.
RADIAL_GRADIENT Basic radial gradient centred on the middle of the matte.

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	generateMatte(FImage img, Object... args) Generate the matte into the given image.
static MatteGenerator.MatteType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MatteGenerator.MatteType[]	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

LINEAR_VERTICAL_GRADIENT

public static final MatteGenerator.MatteType LINEAR_VERTICAL_GRADIENT

A basic linear vertical gradient. The argument should be boolean which, if TRUE, determines that the gradient will be black at the top and white at the bottom. If non-existent, or FALSE, the gradient will be white at the top and black at the bottom.

LINEAR_HORIZONTAL_GRADIENT

public static final MatteGenerator.MatteType LINEAR_HORIZONTAL_GRADIENT

A basic linear horizontal gradient. The argument should be boolean which, if TRUE, determines that the gradient will be black at the left and white at the right. If non-existent, or FALSE, the gradient will be white at the left and black at the right.

RADIAL_GRADIENT

public static final MatteGenerator.MatteType RADIAL_GRADIENT

Basic radial gradient centred on the middle of the matte. The argument should be boolean which, if TRUE, determines whether the gradient will be black or white in the middle (TRUE for white).

ANGLED_LINEAR_GRADIENT

public static final MatteGenerator.MatteType ANGLED_LINEAR_GRADIENT

Generates linear gradients that can be angled to any angle. The angle of the gradient is given in the first argument as a double. The position of the point at which the gradient is rotated, is given in the next two arguments, also as doubles. If any are missing, they are considered 0. To invert the gradient, invert the resulting FImage.

Method Detail

values

public static MatteGenerator.MatteType[] 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 (MatteGenerator.MatteType c : MatteGenerator.MatteType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MatteGenerator.MatteType 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

generateMatte

public abstract void generateMatte(FImage img,
                 Object... args)

Generate the matte into the given image.

Parameters:

img - The image to generate the matte into

args - The arguments for the matte generator