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