imagingbook.pub.regions

Class Contour

java.lang.Object

imagingbook.pub.regions.Contour

All Implemented Interfaces:

Comparable<Contour>, Iterable<Point>

public class Contour
extends Object
implements Comparable<Contour>, Iterable<Point>

This class represents a closed contour as a sequence of pixel coordinates. It implements the Comparable interface for sorting contours by length. It supports iteration over the points along the contour, e.g., by

 Contour C = ...;
 for (Point p : C) {
    // process p ...
 }
 

Version:

2016-11-08

Constructor Summary

Constructors

Constructor and Description
Contour(int label) Creates a new (empty) contour with the given region label.

Method Summary

Modifier and Type	Method and Description
protected void	addPoint(Point p)
int	compareTo(Contour c2)
int	getLabel() Get the region label associated with this contour.
int	getLength() Get the length of the contour.
Point[]	getPointArray() Get the contour points as an array.
List<Point>	getPointList() Get the list of contour points.
Path2D	getPolygonPath() Get the polygon for this contour (for subsequent drawing).
Path2D	getPolygonPath(double xOffset, double yOffset) Get the polygon for this contour (for subsequent drawing).
Iterator<Point>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Contour

public Contour(int label)

Creates a new (empty) contour with the given region label.

Parameters:

label - the region label for this contour.

Method Detail

addPoint

protected void addPoint(Point p)

getPointList

public List<Point> getPointList()

Get the list of contour points.

Returns:

a reference to the internal list of contour points.

getPointArray

public Point[] getPointArray()

Get the contour points as an array.

Returns:

a new array of contour points.

getLength

public int getLength()

Get the length of the contour.

Returns:

the number of points on the contour.

getLabel

public int getLabel()

Get the region label associated with this contour.

Returns:

the region label of the contour.

toString

public String toString()

Overrides:

toString in class Object

getPolygonPath

public Path2D getPolygonPath()

Get the polygon for this contour (for subsequent drawing).

Returns:

the polygon.

getPolygonPath

public Path2D getPolygonPath(double xOffset,
                             double yOffset)

Get the polygon for this contour (for subsequent drawing). An offset can be specified for shifting the contour positions at pixel centers (set to 0.5/0.5).

Parameters:

xOffset - the horizontal offset.

yOffset - the vertical offset.

Returns:

a polygon.

compareTo

public int compareTo(Contour c2)

Specified by:

compareTo in interface Comparable<Contour>

iterator

public Iterator<Point> iterator()

Specified by:

iterator in interface Iterable<Point>