AWS SDK for C++  1.9.159
AWS SDK for C++
Public Member Functions | List of all members
Aws::Rekognition::Model::BoundingBox Class Reference

#include <BoundingBox.h>

Public Member Functions

 BoundingBox ()
 
 BoundingBox (Aws::Utils::Json::JsonView jsonValue)
 
BoundingBoxoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
double GetWidth () const
 
bool WidthHasBeenSet () const
 
void SetWidth (double value)
 
BoundingBoxWithWidth (double value)
 
double GetHeight () const
 
bool HeightHasBeenSet () const
 
void SetHeight (double value)
 
BoundingBoxWithHeight (double value)
 
double GetLeft () const
 
bool LeftHasBeenSet () const
 
void SetLeft (double value)
 
BoundingBoxWithLeft (double value)
 
double GetTop () const
 
bool TopHasBeenSet () const
 
void SetTop (double value)
 
BoundingBoxWithTop (double value)
 

Detailed Description

Identifies the bounding box around the label, face, text or personal protective equipment. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

See Also:

AWS API Reference

Definition at line 46 of file BoundingBox.h.

Constructor & Destructor Documentation

◆ BoundingBox() [1/2]

Aws::Rekognition::Model::BoundingBox::BoundingBox ( )

◆ BoundingBox() [2/2]

Aws::Rekognition::Model::BoundingBox::BoundingBox ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetHeight()

double Aws::Rekognition::Model::BoundingBox::GetHeight ( ) const
inline

Height of the bounding box as a ratio of the overall image height.

Definition at line 79 of file BoundingBox.h.

◆ GetLeft()

double Aws::Rekognition::Model::BoundingBox::GetLeft ( ) const
inline

Left coordinate of the bounding box as a ratio of overall image width.

Definition at line 100 of file BoundingBox.h.

◆ GetTop()

double Aws::Rekognition::Model::BoundingBox::GetTop ( ) const
inline

Top coordinate of the bounding box as a ratio of overall image height.

Definition at line 121 of file BoundingBox.h.

◆ GetWidth()

double Aws::Rekognition::Model::BoundingBox::GetWidth ( ) const
inline

Width of the bounding box as a ratio of the overall image width.

Definition at line 58 of file BoundingBox.h.

◆ HeightHasBeenSet()

bool Aws::Rekognition::Model::BoundingBox::HeightHasBeenSet ( ) const
inline

Height of the bounding box as a ratio of the overall image height.

Definition at line 84 of file BoundingBox.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Rekognition::Model::BoundingBox::Jsonize ( ) const

◆ LeftHasBeenSet()

bool Aws::Rekognition::Model::BoundingBox::LeftHasBeenSet ( ) const
inline

Left coordinate of the bounding box as a ratio of overall image width.

Definition at line 105 of file BoundingBox.h.

◆ operator=()

BoundingBox& Aws::Rekognition::Model::BoundingBox::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetHeight()

void Aws::Rekognition::Model::BoundingBox::SetHeight ( double  value)
inline

Height of the bounding box as a ratio of the overall image height.

Definition at line 89 of file BoundingBox.h.

◆ SetLeft()

void Aws::Rekognition::Model::BoundingBox::SetLeft ( double  value)
inline

Left coordinate of the bounding box as a ratio of overall image width.

Definition at line 110 of file BoundingBox.h.

◆ SetTop()

void Aws::Rekognition::Model::BoundingBox::SetTop ( double  value)
inline

Top coordinate of the bounding box as a ratio of overall image height.

Definition at line 131 of file BoundingBox.h.

◆ SetWidth()

void Aws::Rekognition::Model::BoundingBox::SetWidth ( double  value)
inline

Width of the bounding box as a ratio of the overall image width.

Definition at line 68 of file BoundingBox.h.

◆ TopHasBeenSet()

bool Aws::Rekognition::Model::BoundingBox::TopHasBeenSet ( ) const
inline

Top coordinate of the bounding box as a ratio of overall image height.

Definition at line 126 of file BoundingBox.h.

◆ WidthHasBeenSet()

bool Aws::Rekognition::Model::BoundingBox::WidthHasBeenSet ( ) const
inline

Width of the bounding box as a ratio of the overall image width.

Definition at line 63 of file BoundingBox.h.

◆ WithHeight()

BoundingBox& Aws::Rekognition::Model::BoundingBox::WithHeight ( double  value)
inline

Height of the bounding box as a ratio of the overall image height.

Definition at line 94 of file BoundingBox.h.

◆ WithLeft()

BoundingBox& Aws::Rekognition::Model::BoundingBox::WithLeft ( double  value)
inline

Left coordinate of the bounding box as a ratio of overall image width.

Definition at line 115 of file BoundingBox.h.

◆ WithTop()

BoundingBox& Aws::Rekognition::Model::BoundingBox::WithTop ( double  value)
inline

Top coordinate of the bounding box as a ratio of overall image height.

Definition at line 136 of file BoundingBox.h.

◆ WithWidth()

BoundingBox& Aws::Rekognition::Model::BoundingBox::WithWidth ( double  value)
inline

Width of the bounding box as a ratio of the overall image width.

Definition at line 73 of file BoundingBox.h.


The documentation for this class was generated from the following file: