pyrealsense2.perception_frame

class pyrealsense2.perception_frame

Extends the frame class with attributes inferred from the frame content, such as object detection results.

__init__(self: pyrealsense2.perception_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)

get_data(self)

Retrieve data from the frame handle.

get_data_size(self)

Retrieve data size from frame handle.

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_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.

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.