Image.extractRoiWithColor Method

Module: Image

Definition

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

extract_roi_with_color(self, bounds: Rectangle, color_red: int, color_green: int, color_blue: int) -> Image

Parameters

bounds Rectangle
in Bounds of the crop to extract.

color_red int
in Background color red (from 0 to 255)

color_green int
in Background color green (from 0 to 255)

color_blue int
in Background color blue (from 0 to 255)

Returns

Image
The extracted region of interest.

Exceptions

FaceException
An error has occurred during Face Library execution.
Image extractRoiWithColor(Rectangle bounds, int colorRed, int colorGreen, int colorBlue)

Parameters

bounds Rectangle
in Bounds of the crop to extract.

colorRed int
in Background color red (from 0 to 255)

colorGreen int
in Background color green (from 0 to 255)

colorBlue int
in Background color blue (from 0 to 255)

Returns

Image
The extracted region of interest.

Exceptions

FaceException
An error has occurred during Face Library execution.
public Image ExtractRoiWithColor(Rectangle bounds, int colorRed, int colorGreen, int colorBlue)

Parameters

bounds Rectangle
in Bounds of the crop to extract.

colorRed int
in Background color red (from 0 to 255)

colorGreen int
in Background color green (from 0 to 255)

colorBlue int
in Background color blue (from 0 to 255)

Returns

Image
The extracted region of interest.

Exceptions

FaceException
An error has occurred during Face Library execution.
public Image extractRoiWithColor(Rectangle bounds, int colorRed, int colorGreen, int colorBlue) throws FaceException

Parameters

bounds Rectangle
in Bounds of the crop to extract.

colorRed int
in Background color red (from 0 to 255)

colorGreen int
in Background color green (from 0 to 255)

colorBlue int
in Background color blue (from 0 to 255)

Returns

Image
The extracted region of interest.

Exceptions

FaceException
An error has occurred during Face Library execution.
public func extractRoiWithColor(bounds: Rectangle, colorRed: Int32, colorGreen: Int32, colorBlue: Int32) throws -> Image

Parameters

bounds Rectangle
in Bounds of the crop to extract.

colorRed Int32
in Background color red (from 0 to 255)

colorGreen Int32
in Background color green (from 0 to 255)

colorBlue Int32
in Background color blue (from 0 to 255)

Returns

Image
The extracted region of interest.

Exceptions

FaceException
An error has occurred during Face Library execution.
int id3FaceImage_ExtractRoiWithColor (
    ID3_FACE_IMAGE hImage,
    const id3FaceRectangle * sBounds,
    int colorRed,
    int colorGreen,
    int colorBlue,
    ID3_FACE_IMAGE hImageRoi)

Parameters

hImage ID3_FACE_IMAGE
in Handle to the Image object.

sBounds const id3FaceRectangle *
in Bounds of the crop to extract.

colorRed int
in Background color red (from 0 to 255)

colorGreen int
in Background color green (from 0 to 255)

colorBlue int
in Background color blue (from 0 to 255)

hImageRoi ID3_FACE_IMAGE
out The extracted region of interest.

Returns

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