com.amazonaws.services.rekognition.model

Class RegionOfInterest

java.lang.Object

com.amazonaws.services.rekognition.model.RegionOfInterest

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegionOfInterest
extends Object
implements Serializable, Cloneable, StructuredPojo

Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a BoundingBox or Polygon to set a region of the screen.

A word, face, or label is included in the region if it is more than half in that region. If there is more than one region, the word, face, or label is compared with all regions of the screen. Any object of interest that is more than half in a region is kept in the results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RegionOfInterest()

Method Summary

Modifier and Type	Method and Description
RegionOfInterest	clone()
boolean	equals(Object obj)
BoundingBox	getBoundingBox() The box representing a region of interest on screen.
List<Point>	getPolygon() Specifies a shape made up of up to 10 Point objects to define a region of interest.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setBoundingBox(BoundingBox boundingBox) The box representing a region of interest on screen.
void	setPolygon(Collection<Point> polygon) Specifies a shape made up of up to 10 Point objects to define a region of interest.
String	toString() Returns a string representation of this object.
RegionOfInterest	withBoundingBox(BoundingBox boundingBox) The box representing a region of interest on screen.
RegionOfInterest	withPolygon(Collection<Point> polygon) Specifies a shape made up of up to 10 Point objects to define a region of interest.
RegionOfInterest	withPolygon(Point... polygon) Specifies a shape made up of up to 10 Point objects to define a region of interest.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegionOfInterest

public RegionOfInterest()

Method Detail

setBoundingBox

public void setBoundingBox(BoundingBox boundingBox)

The box representing a region of interest on screen.

Parameters:

boundingBox - The box representing a region of interest on screen.

getBoundingBox

public BoundingBox getBoundingBox()

The box representing a region of interest on screen.

Returns:

The box representing a region of interest on screen.

withBoundingBox

public RegionOfInterest withBoundingBox(BoundingBox boundingBox)

The box representing a region of interest on screen.

Parameters:

boundingBox - The box representing a region of interest on screen.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPolygon

public List<Point> getPolygon()

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Returns:

Specifies a shape made up of up to 10 Point objects to define a region of interest.

setPolygon

public void setPolygon(Collection<Point> polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Parameters:

polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

withPolygon

public RegionOfInterest withPolygon(Point... polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

NOTE: This method appends the values to the existing list (if any). Use setPolygon(java.util.Collection) or withPolygon(java.util.Collection) if you want to override the existing values.

Parameters:

polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPolygon

public RegionOfInterest withPolygon(Collection<Point> polygon)

Specifies a shape made up of up to 10 Point objects to define a region of interest.

Parameters:

polygon - Specifies a shape made up of up to 10 Point objects to define a region of interest.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegionOfInterest clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.