Image Class

Namespace: id3.Face

Definition

Represents an image.

Properties

Name	Type	Description
data	byte[]	Raw data buffer of the image.
height	int	Height in pixels.
pixelDepth	int	Pixel depth.
pixelFormat	PixelFormat	Pixel format.
stride	int	Stride in bytes.
width	int	Width in pixels.

Static Methods

Name	Description
fromBuffer	Creates an Image from the specified data buffer.
fromFile	Creates an Image from the specified file.
fromNumpy	Creates an Image from the specified data buffer. Supported pixel formats are grayscale formats, BGR and RGB 24bits, and BGRA. For integers format, input datatype must be UINT8.
fromRawBuffer	Creates an Image from the specified raw data buffer.
fromYuvPlanes	Creates an Image from the specified YUV planes.
set	Sets the Image object fields.

Methods

Name	Description
cannyEdgeDetection	Applies Canny edge detection to a grayscale image in-place.
cannyEdgeDetectionTo	Applies Canny edge detection to a grayscale image.
changeAspectRatio	Changes the aspect ratio of the image using an interpolation between cropping and padding.
changeAspectRatioWithColor	Changes the aspect ratio of the image using an interpolation between cropping and padding with a custom color.
clone	Clones the Image object.
compare	Computes the difference with another image.
convertToGrayscale	Converts the image to grayscale in-place.
convertToGrayscaleTo	Converts the image to grayscale.
correctGamma	Applies a gamma correction to the image.
crop	Crop a rectangular region of interest in the image according to the given bounds.
cropCenter	Crops the image at its center with the specified aspect ratio.
dilate	Applies morphological dilation to the image in-place.
dilateTo	Applies morphological dilation to the image.
downscale	Downscales the image in-place so that its maximum dimension is equal to the given maximum size, while preserving the aspect ratio.
downscaleTo	Downscales the image so that its maximum dimension equals the given maximum size, while preserving the aspect ratio.
equalizeHistogram	Equalizes the histogram of a grayscale image in-place.
equalizeHistogramTo	Equalizes the histogram of a grayscale image.
erode	Applies morphological erosion to the image in-place.
erodeTo	Applies morphological erosion to the image.
extractRoi	Extracts a region of interest in the image according to the given bounds.
extractRoiWithColor	Extracts a region of interest in the image according to the given bounds.
flip	Flips the image in-place.
flipTo	Flips the image.
gaussianBlur	Applies Gaussian blur to the image in-place.
gaussianBlurTo	Applies Gaussian blur to the image.
getPixels	Gets a pointer to the image pixels.
medianBlur	Applies median blur to the image in-place.
medianBlurTo	Applies median blur to the image.
normalize	Normalizes the image values to the specified range in-place.
normalizeQuantile	Normalizes a grayscale image based on quantiles in-place.
normalizeQuantileTo	Normalizes a grayscale image based on quantiles.
normalizeTo	Normalizes the image values to the specified range.
pad	Add padding around the image
padCenter	Pads the image at its center with a black background to match the specified aspect ratio.
padCenterWithColor	Pads the image at its center with a custom background color to match the specified aspect ratio.
reallocate	Reallocates the internal memory of the Image from parameters.
resize	Resizes the image in-place to the required width and height.
resizeTo	Resizes the image to the specified width and height.
rotate	Rotates the image in-place to the specified angle.
rotateTo	Rotates the image to the specified angle.
toBuffer	Exports the image to a buffer.
toBufferObject	Copies the image to a buffer in the specified format.
toFile	Saves the image to the specified file.
toNumpy	Exports the image to a numpy array (Python only)
toRawBuffer	Copies image pixels in the specified format into a buffer.
transpose	Transposes the image object.