pyrealsense2.composite_frame

class pyrealsense2.composite_frame

Extends the frame class with additional frameset related attributes and functions

__init__(self: pyrealsense2.composite_frame, arg0: pyrealsense2.frame) → None

Methods

__init__(self, arg0)
as_depth_frame(self)
as_frame(self)
as_frameset(self)
as_gpu_frame(self)
as_labeled_points(self)
as_motion_frame(self)
as_object_detection_frame(self)
as_perception_frame(self)
as_points(self)
as_pose_frame(self)
as_video_frame(self)
first(self, s, f)	Retrieve the first frame of a specific stream type and optionally with a specific format.
first_or_default(self, s, f)	Retrieve the first frame of a specific stream and optionally with a specific format.
foreach(self, callable)	Extract internal frame handles from the frameset and invoke the action function
get_color_frame(self[, index])	Retrieve the first color frame, if no frame is found, search for the color frame from IR stream.
get_data(self)	Retrieve data from the frame handle.
get_data_size(self)	Retrieve data size from frame handle.
get_depth_frame(self)	Retrieve the first depth frame, if no frame is found, return an empty frame instance.
get_fisheye_frame(self[, index])	Retrieve the fisheye monochrome video frame
get_frame_metadata(self, frame_metadata)	Retrieve the current value of a single frame_metadata.
get_frame_number(self)	Retrieve the frame number.
get_frame_timestamp_domain(self)	Retrieve the timestamp domain.
get_gpu_data_or_upload(self)	Always returns a usable CUDA device pointer on a CUDA build as a (address:int, copied:bool) tuple: zero-copy when available (copied=False), otherwise the SDK uploads to a cached device buffer (copied=True).
get_infrared_frame(self[, index])	Retrieve the first infrared frame, if no frame is found, return an empty frame instance.
get_labeled_point_cloud_frame(self)	Retrieve the labeled point cloud frame, if no frame is found, return an empty frame instance.
get_object_detection_frame(self[, index])	Retrieve the object detection frame, if no frame is found, return an empty frame instance.
get_pose_frame(self[, index])	Retrieve the pose frame
get_profile(self)	Retrieve stream profile from frame handle.
get_timestamp(self)	Retrieve the time at which the frame was captured
is_depth_frame(self)
is_frame(self)
is_frameset(self)
is_gpu_frame(self)
is_labeled_points(self)
is_motion_frame(self)
is_object_detection_frame(self)
is_perception_frame(self)
is_points(self)
is_pose_frame(self)
is_video_frame(self)
keep(self)	Keep the frame, otherwise if no refernce to the frame, the frame will be released.
size(self)	Return the size of the frameset
supports_frame_metadata(self, frame_metadata)	Determine if the device allows a specific metadata to be queried.
swap(self, other)	Swap the internal frame handle with the one in parameter

Attributes

data	Data from the frame handle.
frame_number	The frame number.
frame_timestamp_domain	The timestamp domain.
profile	Stream profile from frame handle.
timestamp	Time at which the frame was captured.

first(self: pyrealsense2.composite_frame, s: pyrealsense2.stream, f: pyrealsense2.format = <format.any: 0>) → pyrealsense2.frame

Retrieve the first frame of a specific stream type and optionally with a specific format. If no frame is found, an error will be thrown.

first_or_default(self: pyrealsense2.composite_frame, s: pyrealsense2.stream, f: pyrealsense2.format = <format.any: 0>) → pyrealsense2.frame

Retrieve the first frame of a specific stream and optionally with a specific format. If no frame is found, return an empty frame instance.

foreach(self: pyrealsense2.composite_frame, callable: Callable[[pyrealsense2.frame], None]) → None

Extract internal frame handles from the frameset and invoke the action function

get_color_frame(self: pyrealsense2.composite_frame, index: int = 0) → pyrealsense2.video_frame

Retrieve the first color frame, if no frame is found, search for the color frame from IR stream. If one still can’t be found, return an empty frame instance.

get_depth_frame(self: pyrealsense2.composite_frame) → pyrealsense2.depth_frame

Retrieve the first depth frame, if no frame is found, return an empty frame instance.

get_fisheye_frame(self: pyrealsense2.composite_frame, index: int = 0) → pyrealsense2.video_frame

Retrieve the fisheye monochrome video frame

get_infrared_frame(self: pyrealsense2.composite_frame, index: int = 0) → pyrealsense2.video_frame

Retrieve the first infrared frame, if no frame is found, return an empty frame instance.

get_labeled_point_cloud_frame(self: pyrealsense2.composite_frame) → pyrealsense2.labeled_points

Retrieve the labeled point cloud frame, if no frame is found, return an empty frame instance.

get_object_detection_frame(self: pyrealsense2.composite_frame, index: int = 0) → pyrealsense2.object_detection_frame

Retrieve the object detection frame, if no frame is found, return an empty frame instance.

get_pose_frame(self: pyrealsense2.composite_frame, index: int = 0) → pyrealsense2.pose_frame

Retrieve the pose frame

size(self: pyrealsense2.composite_frame) → int

Return the size of the frameset