CaptureImage Class

Namespace: id3.Devices

Definition

Represent images captured by devices, incorporating metadata like the total number of frames captured and the timestamp of the capture.

This class is pivotal for applications that process or analyze sequences of images over time, requiring context on the timing and sequence of captures.

Python

class CaptureImage

Dart

class CaptureImage implements Finalizable

C#

public partial class CaptureImage

Java

public class CaptureImage implements AutoCloseable, Serializable

C

typedef struct id3DevicesCaptureImage *ID3_DEVICES_CAPTURE_IMAGE;

Usage

Python

captureImageInstance = CaptureImage()
# ...

Explicit destruction

# ...
del captureImageInstance

Dart

final captureImageInstance = sdk.CaptureImage();
// ...

Explicit destruction

// ...
captureImageInstance.dispose()

C#

using (var captureImageInstance = new CaptureImage())
{
   // ...
}

Explicit destruction

var captureImageInstance = new CaptureImage()
// ...
captureImageInstance.Dispose()

Java

try (CaptureImage captureImageInstance = new CaptureImage()) {
// ...
}

Explicit destruction

CaptureImage captureImageInstance = new CaptureImage();
// ...
captureImageInstance.close();

C

ID3_DEVICES_CAPTURE_IMAGE hCaptureImage{};
int err = id3DevicesCaptureImage_Initialize(&hCaptureImage);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesCaptureImage_Dispose(&hCaptureImage);
}

Properties

Name	Type	Description
data	byte[]	Raw data buffer of the image.
frameCount	int	Tracks the total number of frames captured since the start of the capture session.
height	int	Height in pixels.
pixelDepth	int	Pixel depth.
pixelFormat	PixelFormat	Pixel format.
stride	int	Stride in bytes.
timestamp	long	Records the capture time of the image, typically represented as a timestamp relative to a fixed point in time (e.g., Unix epoch).
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
clone	Clones the CaptureImage object.
compare	Computes the difference with another image.
correctGamma	Applies a gamma correction 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.
extractRoi	Extracts a region of interest in the image according to the given bounds.
flip	Flips the image in-place.
flipTo	Flips the image.
getPixels	Gets a pointer to the image pixels.
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.