File Coverage

blib/lib/Paws/Rekognition/BoundingBox.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Rekognition::BoundingBox;
2 1     1   290 use Moose;
  1         3  
  1         6  
3             has Height => (is => 'ro', isa => 'Num');
4             has Left => (is => 'ro', isa => 'Num');
5             has Top => (is => 'ro', isa => 'Num');
6             has Width => (is => 'ro', isa => 'Num');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::Rekognition::BoundingBox
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::Rekognition::BoundingBox object:
25              
26             $service_obj->Method(Att1 => { Height => $value, ..., Width => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::Rekognition::BoundingBox object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Height
34              
35             =head1 DESCRIPTION
36              
37             Identifies the bounding box around the object or face. The C<left>
38             (x-coordinate) and C<top> (y-coordinate) are coordinates representing
39             the top and left sides of the bounding box. Note that the upper-left
40             corner of the image is the origin (0,0).
41              
42             The C<top> and C<left> values returned are ratios of the overall image
43             size. For example, if the input image is 700x200 pixels, and the
44             top-left coordinate of the bounding box is 350x50 pixels, the API
45             returns a C<left> value of 0.5 (350/700) and a C<top> value of 0.25
46             (50/200).
47              
48             The C<width> and C<height> values represent the dimensions of the
49             bounding box as a ratio of the overall image dimension. For example, if
50             the input image is 700x200 pixels, and the bounding box width is 70
51             pixels, the width returned is 0.1.
52              
53             The bounding box coordinates can have negative values. For example, if
54             Amazon Rekognition is able to detect a face that is at the image edge
55             and is only partially visible, the service can return coordinates that
56             are outside the image bounds and, depending on the image edge, you
57             might get negative values or values greater than 1 for the C<left> or
58             C<top> values.
59              
60             =head1 ATTRIBUTES
61              
62              
63             =head2 Height => Num
64              
65             Height of the bounding box as a ratio of the overall image height.
66              
67              
68             =head2 Left => Num
69              
70             Left coordinate of the bounding box as a ratio of overall image width.
71              
72              
73             =head2 Top => Num
74              
75             Top coordinate of the bounding box as a ratio of overall image height.
76              
77              
78             =head2 Width => Num
79              
80             Width of the bounding box as a ratio of the overall image width.
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::Rekognition>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95