at.ac.sbg.cosy.soccerbot.recognition
Interface IRegion

All Superinterfaces:
java.lang.Comparable
All Known Implementing Classes:
Region

public interface IRegion
extends java.lang.Comparable

IRegion defines a set of (4-connected) pixels that is used to give a semantic description of an image.

Author:
Peter Wild

Method Summary
 IRegion copy()
          Deep copy of region
 int getCenter_X()
          Returns the center x-coordinate (midpoint) of the recognized region (used for robot navigation)
 int getCenter_Y()
          Returns the center y-coordinate (midpoint) of the recognized region (used for robot navigation)
 boolean getClipped()
          Returns information whether region may be clipped (at boundary of image)
 int getHeight()
          Returns the maximum height of the region
 int getHSV()
          Returns hsv value in 32-bit hsv format (0xHHHHSSVV)
 int getId()
          Returns region id (may be used for retrieving additional region information)
 int getSize()
          Returns the numberf of pixels within the region
 int getWidth()
          Returns the maximum width of the region
 void setCenter_X(int center_x)
          sets the center x-coordinate (midpoint) of the recognized region (used for robot navigation)
 void setCenter_Y(int center_y)
          sets the center y-coordinate (midpoint) of the recognized region (used for robot navigation)
 void setClipped(boolean clipped)
          Sets clipping information (at boundary of image)
 void setHeight(int height)
          Sets the maximum height of the region
 void setHSV(int hsv)
          Sets the region hsv value
 void setId(int id)
          Sets the region id (may be used for retrieving additional region information)
 void setSize(int size)
          Sets the size (number of pixels) of the region
 void setWidth(int width)
          Sets the maximum width of the region
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getId

int getId()
Returns region id (may be used for retrieving additional region information)

Returns:
unique region id

setId

void setId(int id)
Sets the region id (may be used for retrieving additional region information)

Parameters:
id - region identifier

getHSV

int getHSV()
Returns hsv value in 32-bit hsv format (0xHHHHSSVV)

Returns:
average hsv value encoded in 32-bit format (0xHHHHSSVV)

setHSV

void setHSV(int hsv)
Sets the region hsv value

Parameters:
hsv - average hsv value encoded in 32-bit format (0xHHHHSSVV)

getCenter_X

int getCenter_X()
Returns the center x-coordinate (midpoint) of the recognized region (used for robot navigation)

Returns:
center of region

getCenter_Y

int getCenter_Y()
Returns the center y-coordinate (midpoint) of the recognized region (used for robot navigation)

Returns:
center of region

setCenter_X

void setCenter_X(int center_x)
sets the center x-coordinate (midpoint) of the recognized region (used for robot navigation)

Parameters:
center_x - center of region

setCenter_Y

void setCenter_Y(int center_y)
sets the center y-coordinate (midpoint) of the recognized region (used for robot navigation)

Parameters:
center_y - center of region

getWidth

int getWidth()
Returns the maximum width of the region

Returns:
width of region

setWidth

void setWidth(int width)
Sets the maximum width of the region

Parameters:
width - width of region

getHeight

int getHeight()
Returns the maximum height of the region

Returns:
height of region

setHeight

void setHeight(int height)
Sets the maximum height of the region

Parameters:
height - height of region

getSize

int getSize()
Returns the numberf of pixels within the region

Returns:
number of pixels

setSize

void setSize(int size)
Sets the size (number of pixels) of the region

Parameters:
size - number of pixels

getClipped

boolean getClipped()
Returns information whether region may be clipped (at boundary of image)

Returns:
whether region is clipped

setClipped

void setClipped(boolean clipped)
Sets clipping information (at boundary of image)

Parameters:
clipped - whether region is clipped

copy

IRegion copy()
Deep copy of region

Returns:
deep copy