org.openimaj.image.connectedcomponent.proc

Enum BasicShapeDescriptor.BasicShapeDescriptorType

java.lang.Object

java.lang.Enum<BasicShapeDescriptor.BasicShapeDescriptorType>

org.openimaj.image.connectedcomponent.proc.BasicShapeDescriptor.BasicShapeDescriptorType

All Implemented Interfaces:

Serializable, Comparable<BasicShapeDescriptor.BasicShapeDescriptorType>

Enclosing class:

BasicShapeDescriptor

public static enum BasicShapeDescriptor.BasicShapeDescriptorType
extends Enum<BasicShapeDescriptor.BasicShapeDescriptorType>

An enum of all the different basic shape descriptors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AREA The area of the component
CENTROID The centroid of the component
CHFIT The ratio of the area of the component to the area of its convex hull
COMPACTNESS The compactness of the component.
CORNERS The estimated number of corners of the component
DIRECTION The primary orientation of the component
ELONGATEDNESS The elongatedness of the component.

Method Summary

Modifier and Type	Method and Description
abstract DoubleFV	getFeatureVector(BasicShapeDescriptor desc) Create a @link{FeatureVector} representation of the specified description
static BasicShapeDescriptor.BasicShapeDescriptorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasicShapeDescriptor.BasicShapeDescriptorType[]	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

AREA

public static final BasicShapeDescriptor.BasicShapeDescriptorType AREA

The area of the component

See Also:

PixelSet.calculateArea()

CENTROID

public static final BasicShapeDescriptor.BasicShapeDescriptorType CENTROID

The centroid of the component

See Also:

PixelSet.calculateCentroid()

DIRECTION

public static final BasicShapeDescriptor.BasicShapeDescriptorType DIRECTION

The primary orientation of the component

See Also:

PixelSet.calculateDirection()

ELONGATEDNESS

public static final BasicShapeDescriptor.BasicShapeDescriptorType ELONGATEDNESS

The elongatedness of the component. Elongatedness is defined as the ratio of the height to width of the oriented bounding box of the component.

See Also:

ConnectedComponent.calculateOrientatedBoundingBoxAspectRatio()

COMPACTNESS

public static final BasicShapeDescriptor.BasicShapeDescriptorType COMPACTNESS

The compactness of the component. Compactness is defined as the ratio of the squared edge length of the component to its area.

CHFIT

public static final BasicShapeDescriptor.BasicShapeDescriptorType CHFIT

The ratio of the area of the component to the area of its convex hull

See Also:

ConnectedComponent.calculatePercentageConvexHullFit()

CORNERS

public static final BasicShapeDescriptor.BasicShapeDescriptorType CORNERS

The estimated number of corners of the component

See Also:

ConnectedComponent.estimateNumberOfVertices(int, int)

Method Detail

values

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

Returns:

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

valueOf

public static BasicShapeDescriptor.BasicShapeDescriptorType 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

getFeatureVector

public abstract DoubleFV getFeatureVector(BasicShapeDescriptor desc)

Create a @link{FeatureVector} representation of the specified description

Parameters:

desc - the descriptor

Returns:

the feature vector representation