org.openimaj.image.contour

Class Contour

java.lang.Object

org.openimaj.math.geometry.point.PointList

org.openimaj.math.geometry.shape.Polygon

org.openimaj.image.contour.Contour

All Implemented Interfaces:

Cloneable, Iterable<Point2d>, GeometricObject2d, Shape

public class Contour
extends Polygon

A contour or hierarchical set of contours within an image.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
List<Contour>	children sub contours
Contour	parent The parent contour, might be null
Pixel	start where the contour starts
ContourType	type The type of contour

Fields inherited from class org.openimaj.math.geometry.point.PointList

points

Constructor Summary

Constructors

Constructor and Description
Contour(ContourType type) Construct a contour with the given type and start at the origin
Contour(ContourType type, int x, int y) Construct a contour with the given type and start pixel
Contour(ContourType type, Pixel p) Construct a contour with the given type and start pixel
Contour(int x, int y) Construct a contour with the given starting coordinate and a null type.

Method Summary

Modifier and Type	Method and Description
Iterable<Contour>	contourIterable() Get an Iterable over all the contours belonging to this root (including the root itself)
Iterator<Contour>	contourIterator() Get an iterator over the complete set of contours (including the root itself)
void	finish() Complete this contour by computing it's bounding box
boolean	isHole() Returns whether this polygon is representing a hole in another polygon.
protected void	setParent(Contour bp)
String	toString() Displays the complete list of vertices unless the number of vertices is greater than 10 - then a sublist is shown of 5 from the start and 5 from the end separated by ellipses.

Methods inherited from class org.openimaj.math.geometry.shape.Polygon

addInnerPolygon, addInnerPolygon, addVertex, addVertex, asPolygon, calculateArea, calculateCentroid, calculateConvexHullMelkman, calculateDirection, calculateFirstMoment, calculatePerimeter, calculateRegularBoundingBox, calculateSecondMoment, calculateSecondMomentCentralised, calculateSignedArea, clone, close, closestPoint, difference, equals, equals, getInnerPoly, getInnerPolys, getNumInnerPoly, getVertices, hashCode, hasNoInnerPolygons, intersect, intersectionArea, intersectionArea, isClockwise, isClosed, isConvex, isEmpty, isInside, minimumBoundingRectangle, minimumBoundingRectangle, nVertices, open, reduceVertices, roundVertices, scale, scale, scaleX, scaleXY, scaleY, setIsHole, toEllipse, transform, translate, union, xor

Methods inherited from class org.openimaj.math.geometry.point.PointList

calculateConvexHull, computeIntrinsicScale, computeMean, get, getHeight, getLines, getLines, getWidth, iterator, maxX, maxY, minX, minY, rotate, rotate, scaleCentroid, size

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openimaj.math.geometry.GeometricObject2d

getHeight, getWidth, maxX, maxY, minX, minY, scaleCentroid

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

type

public ContourType type

The type of contour

children

public List<Contour> children

sub contours

parent

public Contour parent

The parent contour, might be null

start

public Pixel start

where the contour starts

Constructor Detail

Contour

public Contour(ContourType type)

Construct a contour with the given type and start at the origin

Parameters:

type - the type

Contour

public Contour(ContourType type,
               int x,
               int y)

Construct a contour with the given type and start pixel

Parameters:

type - the type

x - the x-ordinate of the start pixel

y - the y-ordinate of the start pixel

Contour

public Contour(ContourType type,
               Pixel p)

Construct a contour with the given type and start pixel

Parameters:

type - the type

p - the coordinate of the start pixel

Contour

public Contour(int x,
               int y)

Construct a contour with the given starting coordinate and a null type.

Parameters:

x - the x-ordinate of the start pixel

y - the y-ordinate of the start pixel

Method Detail

setParent

protected void setParent(Contour bp)

toString

public String toString()

Description copied from class: Polygon

Displays the complete list of vertices unless the number of vertices is greater than 10 - then a sublist is shown of 5 from the start and 5 from the end separated by ellipses.

Overrides:

toString in class Polygon

See Also:

Object.toString()

finish

public void finish()

Complete this contour by computing it's bounding box

contourIterator

public Iterator<Contour> contourIterator()

Get an iterator over the complete set of contours (including the root itself)

Returns:

the iterator

contourIterable

public Iterable<Contour> contourIterable()

Get an Iterable over all the contours belonging to this root (including the root itself)

Returns:

the iterable

isHole

public boolean isHole()

Description copied from class: Polygon

Returns whether this polygon is representing a hole in another polygon.

Overrides:

isHole in class Polygon

Returns:

Whether this polygon is representing a hole in another polygon.