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__
(...)as_depth_frame
(...)as_frame
(...)as_frameset
(...)as_motion_frame
(...)as_points
(...)as_pose_frame
(...)as_video_frame
(...)first
((self: pyrealsense2.composite_frame, ...)Retrieve the first frame of a specific stream type and optionally with a specific format. first_or_default
(...)Retrieve the first frame of a specific stream and optionally with a specific format. foreach
((self: pyrealsense2.composite_frame, ...)Extract internal frame handles from the frameset and invoke the action function get_color_frame
(...)Retrieve the first color frame, if no frame is found, search for the color frame from IR stream. get_data
(...)Retrieve data from the frame handle. get_data_size
((self: pyrealsense2.frame) -> int)Retrieve data size from frame handle. get_depth_frame
(...)Retrieve the first depth frame, if no frame is found, return an empty frame instance. get_fisheye_frame
(...)Retrieve the fisheye monochrome video frame 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_infrared_frame
(...)Retrieve the first infrared frame, if no frame is found, return an empty frame instance. get_pose_frame
(...)Retrieve the pose frame 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. size
((self: pyrealsense2.composite_frame) -> int)Return the size of the frameset 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. -
first
(self: pyrealsense2.composite_frame, s: pyrealsense2.stream, f: pyrealsense2.format=format.any) → 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) → 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) → 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_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
-