RegionLabeling.BinaryRegion (imagingbook-common 1.4-SNAPSHOT API)

java.lang.Object
- imagingbook.pub.regions.RegionLabeling.BinaryRegion

All Implemented Interfaces:

Comparable<RegionLabeling.BinaryRegion>, Iterable<Point>

Enclosing class:

RegionLabeling
```
public class RegionLabeling.BinaryRegion
extends Object
implements Comparable<RegionLabeling.BinaryRegion>, Iterable<Point>
```
This inner class of RegionLabeling represents a connected component or binary region. It supports iteration over the contained points, e.g., by
```
 BinaryRegion R = ...;
 for (Point p : R) {
    // process p ...
 }
 
```

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addInnerContour(Contour contr)`
`protected void`	`addPixel(int u, int v)` Use this method to add a single pixel to this region.
`void`	`clearProperties()` Removes all properties attached to this region.
`int`	`compareTo(RegionLabeling.BinaryRegion r2)`
`Rectangle`	`getBoundingBox()` Get the x/y axes-parallel bounding box as a rectangle (including the extremal coordinates).
`Point2D`	`getCenter()` Deprecated. Returns the centroid of this region as a 2D point. Use `getCenterPoint` or `getXc` and `getYc` instead.
`Point2D`	`getCenterPoint()` Returns the centroid of this region as a 2D point.
`List<Contour>`	`getInnerContours()` Get all inner contours of this region.
`int`	`getLabel()` Get the label associated with this region.
`Contour`	`getOuterContour()` Get the (single) outer contour of this region.
`double`	`getProperty(String name)` Retrieves the specified region property.
`Iterable<Point>`	`getRegionPoints()` Deprecated. Replaced by BinaryRegion implementing `Iterable<Point>`.
`int`	`getSize()` Get the size of this region.
`long`	`getX1Sum()` Returns the sum of the x-values of the points contained in this region.
`long`	`getX2Sum()` Returns the sum of the squared x-values of the points contained in this region.
`double`	`getXc()` Get the x-value of the region's centroid.
`long`	`getY1Sum()` Returns the sum of the y-values of the points contained in this region.
`long`	`getY2Sum()` Returns the sum of the squared y-values of the points contained in this region.
`double`	`getYc()` Get the y-value of the region's centroid.
`Iterator<Point>`	`iterator()`
`protected void`	`makeInnerContours()`
`protected void`	`setOuterContour(Contour contr)`
`void`	`setProperty(String name, double val)` Sets the specified property of this region to the given value.
`String`	`toString()`
`protected void`	`update()` Call this method to update the region's statistics.

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

- Method Detail
  - getXc
```
public double getXc()
```
    Get the x-value of the region's centroid.
    
    Returns:
    
    the x-value of the region's centroid.
  - getYc
```
public double getYc()
```
    Get the y-value of the region's centroid.
    
    Returns:
    
    the y-value of the region's centroid.
  - getX1Sum
```
public long getX1Sum()
```
    Returns the sum of the x-values of the points contained in this region.
    
    Returns:
    
    the sum of x-values.
  - getY1Sum
```
public long getY1Sum()
```
    Returns the sum of the y-values of the points contained in this region.
    
    Returns:
    
    the sum of y-values.
  - getX2Sum
```
public long getX2Sum()
```
    Returns the sum of the squared x-values of the points contained in this region.
    
    Returns:
    
    the sum of squared x-values.
  - getY2Sum
```
public long getY2Sum()
```
    Returns the sum of the squared y-values of the points contained in this region.
    
    Returns:
    
    the sum of squared y-values.
  - getLabel
```
public int getLabel()
```
    Get the label associated with this region.
    
    Returns:
    
    the region label.
  - getSize
```
public int getSize()
```
    Get the size of this region.
    
    Returns:
    
    the number of region points.
  - getBoundingBox
```
public Rectangle getBoundingBox()
```
    Get the x/y axes-parallel bounding box as a rectangle (including the extremal coordinates).
    
    Returns:
    
    the bounding box rectangle.
  - getCenter
```
public Point2D getCenter()
```
    Deprecated. Returns the centroid of this region as a 2D point. Use getCenterPoint or getXc and getYc instead.
    
    Returns:
    
    the centroid of this region.
  - getCenterPoint
```
public Point2D getCenterPoint()
```
    Returns the centroid of this region as a 2D point. See also getXc, getYc.
    
    Returns:
    
    the centroid of this region.
  - iterator
```
public Iterator<Point> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Point>
  - getRegionPoints
```
public Iterable<Point> getRegionPoints()
```
    Deprecated. Replaced by BinaryRegion implementing Iterable<Point>.
    
    Returns:
    
    iterator to be used in a for-loop.
  - addPixel
```
protected void addPixel(int u,
                        int v)
```
    Use this method to add a single pixel to this region. Updates summation and boundary variables used to calculate various region statistics.
    
    Parameters:
    
    u - x-position
    
    v - y-position
  - update
```
protected void update()
```
    Call this method to update the region's statistics. For now only the center coordinates (xc, yc) are updated. Add additional statements as needed to update your own region statistics.
  - getOuterContour
```
public Contour getOuterContour()
```
    Get the (single) outer contour of this region. Points on an outer contour are arranged in clockwise order.
    
    Returns:
    
    the outer contour.
  - setOuterContour
```
protected void setOuterContour(Contour contr)
```
  - getInnerContours
```
public List<Contour> getInnerContours()
```
    Get all inner contours of this region. Points on inner contours are arranged in counter-clockwise order.
    
    Returns:
    
    the list of inner contours.
  - makeInnerContours
```
protected void makeInnerContours()
```
  - addInnerContour
```
protected void addInnerContour(Contour contr)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(RegionLabeling.BinaryRegion r2)
```
    Specified by:
    
    compareTo in interface Comparable<RegionLabeling.BinaryRegion>
  - setProperty
```
public void setProperty(String name,
                        double val)
```
    Sets the specified property of this region to the given value.
    
    Parameters:
    
    name - Chosen name of the property.
    
    val - Value associated with this property.
  - getProperty
```
public double getProperty(String name)
```
    Retrieves the specified region property. An IllegalArgumentException is thrown if the property is not defined for this region.
    
    Parameters:
    
    name - The name of the property.
    
    Returns:
    
    The value associated with the specified property.
  - clearProperties
```
public void clearProperties()
```
    Removes all properties attached to this region.

Class RegionLabeling.BinaryRegion

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

getXc

getYc

getX1Sum

getY1Sum

getX2Sum

getY2Sum

getLabel

getSize

getBoundingBox

getCenter

getCenterPoint

iterator

getRegionPoints

addPixel

update

getOuterContour

setOuterContour

getInnerContours

makeInnerContours

addInnerContour

toString

compareTo

setProperty

getProperty

clearProperties