The four arguments are the scaling numbers that describe the bounding box
that will crop the image. The upper left point of the bounding box will be at
(left_x*image_width, top_y*image_height), and the lower right point will
be at (right_x*image_width, bottom_y*image_height).
Args
image_data
String of the source image data.
left_x
Float value between 0.0 and 1.0, inclusive.
top_y
Float value between 0.0 and 1.0, inclusive.
right_x
Float value between 0.0 and 1.0, inclusive.
bottom_y
Float value between 0.0 and 1.0, inclusive.
output_encoding
A value from OUTPUT_ENCODING_TYPES.
quality
A value between 1 and 100 to specify the quality of the encoding.
This value is only used to control JPEG quality.
correct_orientation
A value from ORIENTATION_CORRECTION_TYPE to indicate
if orientation correction should be performed during the transformation.
rpc
An optional UserRPC object.
transparent_substitution_rgb
When transparent pixels are not supported in
the destination image format, then transparent pixels will be substituted
for the specified color, which must be in 32-bit RGB format.
Returns
Raw image data of the transformed image.
Raises
TypeError
If the arguments are not of type float.
BadRequestError
If the bounding box values are invalid.
Error
All other errors. See Image.ExecuteTransforms for more details.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-09-30 UTC."],[[["This function `crop` allows you to crop an image using provided boundary coordinates."],["The crop area is defined by `left_x`, `top_y`, `right_x`, and `bottom_y`, which are float values between 0.0 and 1.0, representing the bounding box relative to the original image dimensions."],["The output image can be configured using `output_encoding` and `quality`, to determine the image type, and the `correct_orientation` flag can be used to indicate if orientation correction should be applied."],["The function returns the raw image data of the cropped and transformed image."],["It can raise `TypeError`, `BadRequestError`, or `Error` based on the validity of the arguments or the underlying process."]]],[]]