pyrealsense2.frame

class pyrealsense2.frame

Base class for multiple frame extensions

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: pyrealsense2.frame) -> None

2. __init__(self: pyrealsense2.frame, arg0: pyrealsense2.frame) -> None

Methods

__init__(*args, **kwargs)	Overloaded function.
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.

as_depth_frame(self: pyrealsense2.frame) → rs2::depth_frame

as_frame(self: pyrealsense2.frame) → pyrealsense2.frame

as_frameset(self: pyrealsense2.frame) → rs2::frameset

as_gpu_frame(self: pyrealsense2.frame) → rs2::gpu_frame

as_labeled_points(self: pyrealsense2.frame) → rs2::labeled_points

as_motion_frame(self: pyrealsense2.frame) → rs2::motion_frame

as_object_detection_frame(self: pyrealsense2.frame) → rs2::object_detection_frame

as_perception_frame(self: pyrealsense2.frame) → rs2::perception_frame

as_points(self: pyrealsense2.frame) → rs2::points

as_pose_frame(self: pyrealsense2.frame) → rs2::pose_frame

as_video_frame(self: pyrealsense2.frame) → rs2::video_frame

property data

Data from the frame handle. Identical to calling get_data.

property frame_number

The frame number. Identical to calling get_frame_number.

property frame_timestamp_domain

The timestamp domain. Identical to calling get_frame_timestamp_domain.

get_data(self: pyrealsense2.frame) → pyrealsense2.BufData

Retrieve data from the frame handle.

get_data_size(self: pyrealsense2.frame) → int

Retrieve data size from frame handle.

get_frame_metadata(self: pyrealsense2.frame, frame_metadata: pyrealsense2.frame_metadata_value) → int

Retrieve the current value of a single frame_metadata.

get_frame_number(self: pyrealsense2.frame) → int

Retrieve the frame number.

get_frame_timestamp_domain(self: pyrealsense2.frame) → pyrealsense2.timestamp_domain

Retrieve the timestamp domain.

get_gpu_data_or_upload(self: pyrealsense2.frame) → object

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). Returns None on non-CUDA builds. Consume the address via CuPy/PyCUDA/Numba/TensorRT; keep the frame alive until the GPU work completes.

get_profile(self: pyrealsense2.frame) → pyrealsense2.stream_profile

Retrieve stream profile from frame handle.

get_timestamp(self: pyrealsense2.frame) → float

Retrieve the time at which the frame was captured

is_depth_frame(self: pyrealsense2.frame) → bool

is_frame(self: pyrealsense2.frame) → bool

is_frameset(self: pyrealsense2.frame) → bool

is_gpu_frame(self: pyrealsense2.frame) → bool

is_labeled_points(self: pyrealsense2.frame) → bool

is_motion_frame(self: pyrealsense2.frame) → bool

is_object_detection_frame(self: pyrealsense2.frame) → bool

is_perception_frame(self: pyrealsense2.frame) → bool

is_points(self: pyrealsense2.frame) → bool

is_pose_frame(self: pyrealsense2.frame) → bool

is_video_frame(self: pyrealsense2.frame) → bool

keep(self: pyrealsense2.frame) → None

Keep the frame, otherwise if no refernce to the frame, the frame will be released.

property profile

Stream profile from frame handle. Identical to calling get_profile.

supports_frame_metadata(self: pyrealsense2.frame, frame_metadata: pyrealsense2.frame_metadata_value) → bool

Determine if the device allows a specific metadata to be queried.

swap(self: pyrealsense2.frame, other: pyrealsense2.frame) → None

Swap the internal frame handle with the one in parameter

property timestamp

Time at which the frame was captured. Identical to calling get_timestamp.