| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Textract::Point; | ||
| 3 | use Moose; | ||
| 4 | has X => (is => 'ro', isa => 'Num'); | ||
| 5 | has Y => (is => 'ro', isa => 'Num'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Textract::Point | ||
| 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::Textract::Point object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { X => $value, ..., Y => $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::Textract::Point object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->X | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The X and Y coordinates of a point on a document page. The X and Y | ||
| 38 | values that are returned are ratios of the overall document page size. | ||
| 39 | For example, if the input document is 700 x 200 and the operation | ||
| 40 | returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel | ||
| 41 | coordinate on the document page. | ||
| 42 | |||
| 43 | An array of C<Point> objects, C<Polygon>, is returned by | ||
| 44 | DetectDocumentText. C<Polygon> represents a fine-grained polygon around | ||
| 45 | detected text. For more information, see Geometry in the Amazon | ||
| 46 | Textract Developer Guide. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 X => Num | ||
| 52 | |||
| 53 | The value of the X coordinate for a point on a C<Polygon>. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Y => Num | ||
| 57 | |||
| 58 | The value of the Y coordinate for a point on a C<Polygon>. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head1 SEE ALSO | ||
| 63 | |||
| 64 | This class forms part of L<Paws>, describing an object used in L<Paws::Textract> | ||
| 65 | |||
| 66 | =head1 BUGS and CONTRIBUTIONS | ||
| 67 | |||
| 68 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 69 | |||
| 70 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 71 | |||
| 72 | =cut | ||
| 73 |