Capture Class Reference

A class that represents a capture from an Azure Kinect device. More...

Static Public Member Functions
def	create ()
	Create an empty capture object. More...

Detailed Description

A class that represents a capture from an Azure Kinect device.

Property Name	Type	R/W	Description ----------—
color	Image	R/W	The color image container.
depth	Image	R/W	The depth image container.
ir	Image	R/W	The IR image container.
temperature	float	R/W	The temperature

Remarks

• A capture represents a set of images that were captured by a device at approximately the same time. A capture may have a color, IR, and depth image. A capture may have up to one image of each type. A capture may have no image for a given type as well.

• Do not use the Capture() constructor to get a Capture instance. It will return an object that does not have a handle to the capture resources held by the SDK. Instead, use the create() function.

• Captures also store a temperature value which represents the temperature of the device at the time of the capture.

• While all the images associated with the capture were collected at approximately the same time, each image has an individual timestamp which may differ from each other. If the device was configured to capture depth and color images separated by a delay, Device.get_capture() will return a capture containing both image types separated by the configured delay.

• Empty captures are created with create().

• Captures can be obtained from a Device object using get_capture().

• A Capture object may be copied or deep copied. A shallow copy shares the same images as the original, and any changes in one will affect the other. A deep copy does not share any resources with the original, and changes in one will not affect the other. In both shallow and deep copies, deleting one will have no effects on the other.

Member Function Documentation

create()

def create ( )

static

Create an empty capture object.

Returns

Capture instance with empty contents.

Remarks

• If unsuccessful, None is returned.

---

The documentation for this class was generated from the following file:

• src/k4a/_bindings/capture.py