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(...)
as_frame(...)
as_frameset(...)
as_motion_frame(...)
as_points(...)
as_pose_frame(...)
as_video_frame(...)
get_data(...) Retrieve data from the frame handle.
get_data_size((self: pyrealsense2.frame) -> int) Retrieve data size from frame handle.
get_frame_metadata(...) Retrieve the current value of a single frame_metadata.
get_frame_number(...) Retrieve the frame number.
get_frame_timestamp_domain(...) Retrieve the timestamp domain.
get_profile(...) Retrieve stream profile from frame handle.
get_timestamp(...) Retrieve the time at which the frame was captured
is_depth_frame(...)
is_frame((self: pyrealsense2.frame) -> bool)
is_frameset((self: pyrealsense2.frame) -> bool)
is_motion_frame(...)
is_points((self: pyrealsense2.frame) -> bool)
is_pose_frame((self: pyrealsense2.frame) -> bool)
is_video_frame(...)
keep((self: pyrealsense2.frame) -> None) Keep the frame, otherwise if no refernce to the frame, the frame will be released.
supports_frame_metadata(...) Determine if the device allows a specific metadata to be queried.
swap((self: pyrealsense2.frame, ...) 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_motion_frame(self: pyrealsense2.frame) → rs2::motion_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
data

Data from the frame handle. Identical to calling get_data.

frame_number

The frame number. Identical to calling get_frame_number.

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

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

timestamp

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