Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# Image.crop Method

Module: Image

## Definition

Crop a rectangular region of interest in the image according to the given bounds.

Python

    crop(self, left: int, top: int, width: int, height: int) -> Image

Parameters

> `left` int
> in Left bound of the crop to extract.
> `top` int
> in Top bound of the crop to extract.
> `width` int
> in Width of the crop to extract.
> `height` int
> in Height of the crop to extract.

Returns

> Image
> The extracted region of interest.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    Image crop(int left, int top, int width, int height)

Parameters

> `left` int
> in Left bound of the crop to extract.
> `top` int
> in Top bound of the crop to extract.
> `width` int
> in Width of the crop to extract.
> `height` int
> in Height of the crop to extract.

Returns

> Image
> The extracted region of interest.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public Image Crop(int left, int top, int width, int height)

Parameters

> `left` int
> in Left bound of the crop to extract.
> `top` int
> in Top bound of the crop to extract.
> `width` int
> in Width of the crop to extract.
> `height` int
> in Height of the crop to extract.

Returns

> Image
> The extracted region of interest.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public Image crop(int left, int top, int width, int height) throws FaceException

Parameters

> `left` int
> in Left bound of the crop to extract.
> `top` int
> in Top bound of the crop to extract.
> `width` int
> in Width of the crop to extract.
> `height` int
> in Height of the crop to extract.

Returns

> Image
> The extracted region of interest.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public func crop(left: Int32, top: Int32, width: Int32, height: Int32) throws -> Image

Parameters

> `left` Int32
> in Left bound of the crop to extract.
> `top` Int32
> in Top bound of the crop to extract.
> `width` Int32
> in Width of the crop to extract.
> `height` Int32
> in Height of the crop to extract.

Returns

> Image
> The extracted region of interest.

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3FaceImage_Crop (
        ID3_FACE_IMAGE hImage,
        int left,
        int top,
        int width,
        int height,
        ID3_FACE_IMAGE hImageCrop)

Parameters

> `hImage` ID3_FACE_IMAGE
> in Handle to the Image object.
> `left` int
> in Left bound of the crop to extract.
> `top` int
> in Top bound of the crop to extract.
> `width` int
> in Width of the crop to extract.
> `height` int
> in Height of the crop to extract.
> `hImageCrop` ID3_FACE_IMAGE
> out The extracted region of interest.

Returns

> `int`
> An error code.
> See id3FaceError file for the list of possible error codes.