Intel Realsense D435 python wrapper pyrealsense.frame类

from frame.py

# encoding: utf-8
# module pyrealsense2.pyrealsense2
# from D:\Yolov3_Tensorflow\python\lib\site-packages\pyrealsense2\pyrealsense2.cp36-win_amd64.pyd
# by generator 1.147
"""
LibrealsenseTM Python Bindings
        ==============================
        Library for accessing Intel RealSenseTM cameras
"""

# imports
import pybind11_builtins as __pybind11_builtins


class frame(__pybind11_builtins.pybind11_object):
    """ 
    Base class for multiple frame extensions 
    多个帧扩展的基类
    """
    def as_depth_frame(self): # real signature unknown; restored from __doc__
        """ as_depth_frame(self: pyrealsense2.pyrealsense2.frame) -> rs2::depth_frame """
        pass

    def as_frame(self): # real signature unknown; restored from __doc__
        """ as_frame(self: pyrealsense2.pyrealsense2.frame) -> pyrealsense2.pyrealsense2.frame """
        pass

    def as_frameset(self): # real signature unknown; restored from __doc__
        """ as_frameset(self: pyrealsense2.pyrealsense2.frame) -> rs2::frameset """
        pass

    def as_motion_frame(self): # real signature unknown; restored from __doc__
        """ as_motion_frame(self: pyrealsense2.pyrealsense2.frame) -> rs2::motion_frame """
        pass

    def as_points(self): # real signature unknown; restored from __doc__
        """ as_points(self: pyrealsense2.pyrealsense2.frame) -> rs2::points """
        pass

    def as_pose_frame(self): # real signature unknown; restored from __doc__
        """ as_pose_frame(self: pyrealsense2.pyrealsense2.frame) -> rs2::pose_frame """
        pass

    def as_video_frame(self): # real signature unknown; restored from __doc__
        """ as_video_frame(self: pyrealsense2.pyrealsense2.frame) -> rs2::video_frame """
        pass

    def get_data(self): # real signature unknown; restored from __doc__
        """
        get_data(self: pyrealsense2.pyrealsense2.frame) -> pyrealsense2.pyrealsense2.BufData
        
        Retrieve data from the frame handle. 从帧句柄检索数据。
        """
        pass

    def get_data_size(self): # real signature unknown; restored from __doc__
        """
        get_data_size(self: pyrealsense2.pyrealsense2.frame) -> int
        
        Retrieve data size from frame handle. 从帧句柄检索数据大小。
        比如，640×480的color_frame的size是691200
        """
        return 0

    def get_frame_metadata(self, frame_metadata): # real signature unknown; restored from __doc__
        """
        get_frame_metadata(self: pyrealsense2.pyrealsense2.frame, frame_metadata: pyrealsense2.pyrealsense2.frame_metadata_value) -> int
        
        Retrieve the current value of a single frame_metadata. 
        检索单个frame_metadata（帧-元数据）的当前值。
        """
        return 0

    def get_frame_number(self): # real signature unknown; restored from __doc__
        """
        get_frame_number(self: pyrealsense2.pyrealsense2.frame) -> int
        
        Retrieve the frame number. 检索帧号。
        
		print(color_frame.get_frame_number())打印出来是一连串数字，代表帧序号，
		从1开始，但是发现1有时会打印两次，可能是帧刚开始传输时不稳定
        """
        return 0

    def get_frame_timestamp_domain(self): # real signature unknown; restored from __doc__
        """
        get_frame_timestamp_domain(self: pyrealsense2.pyrealsense2.frame) -> pyrealsense2.pyrealsense2.timestamp_domain
        
        Retrieve the timestamp domain. 检索时间戳域。
        
        print(color_frame.get_frame_timestamp_domain())
        打印出来是timestamp_domain.system_time

        """
        pass

    def get_profile(self): # real signature unknown; restored from __doc__
        """
        get_profile(self: pyrealsense2.pyrealsense2.frame) -> pyrealsense2.pyrealsense2.stream_profile
        
        Retrieve stream profile from frame handle. 从帧句柄检索流配置文件。
        pipeline.start(cfg)返回的类型其实就是profile

		print(color_frame.get_profile())
		打印出来是
		print(depth_frame.get_profile())
		打印出来是
        """
        pass

    def get_timestamp(self): # real signature unknown; restored from __doc__
        """
        get_timestamp(self: pyrealsense2.pyrealsense2.frame) -> float
        
        Retrieve the time at which the frame was captured 检索捕获帧的时间

		print(frames.get_timestamp())
		打印出来是以毫秒为单位的时间：
		1578639642613.4795
		1578639642646.3882
		1578639642679.436
		1578639642712.7637
		...
        """
        return 0.0

    def is_depth_frame(self): # real signature unknown; restored from __doc__
        """ is_depth_frame(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_frame(self): # real signature unknown; restored from __doc__
        """ is_frame(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_frameset(self): # real signature unknown; restored from __doc__
        """ is_frameset(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_motion_frame(self): # real signature unknown; restored from __doc__
        """ is_motion_frame(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_points(self): # real signature unknown; restored from __doc__
        """ is_points(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_pose_frame(self): # real signature unknown; restored from __doc__
        """ is_pose_frame(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def is_video_frame(self): # real signature unknown; restored from __doc__
        """ is_video_frame(self: pyrealsense2.pyrealsense2.frame) -> bool """
        return False

    def keep(self): # real signature unknown; restored from __doc__
        """
        keep(self: pyrealsense2.pyrealsense2.frame) -> None
        
        Keep the frame, otherwise if no refernce to the frame, the frame will be released.
        保留帧，否则，如果没有引用帧，帧将被释放。
        """
        pass

    def supports_frame_metadata(self, frame_metadata): # real signature unknown; restored from __doc__
        """
        supports_frame_metadata(self: pyrealsense2.pyrealsense2.frame, frame_metadata: pyrealsense2.pyrealsense2.frame_metadata_value) -> bool
        
        Determine if the device allows a specific metadata to be queried.
        确定设备是否允许查询特定的元数据。
        """
        return False

    def swap(self, other): # real signature unknown; restored from __doc__
        """
        swap(self: pyrealsense2.pyrealsense2.frame, other: pyrealsense2.pyrealsense2.frame) -> None
        
        Swap the internal frame handle with the one in parameter
        用参数中的一个交换内部帧句柄
        """
        pass

    def __init__(self, *args, **kwargs): # real signature unknown; restored from __doc__
        """
        __init__(*args, **kwargs)
        Overloaded function.
        
        1. __init__(self: pyrealsense2.pyrealsense2.frame) -> None
        
        2. __init__(self: pyrealsense2.pyrealsense2.frame, arg0: pyrealsense2.pyrealsense2.frame) -> None
        """
        pass

    def __nonzero__(self): # real signature unknown; restored from __doc__
        """
        __nonzero__(self: pyrealsense2.pyrealsense2.frame) -> bool
        
        check if internal frame handle is valid 检查内部帧句柄是否有效
        """
        return False

    data = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """
    Data from the frame handle. Identical to calling get_data.
    来自帧句柄的数据。 与调用get_data相同。
    """

    frame_number = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """
    The frame number. Identical to calling get_frame_number.
    帧号。 与调用get_frame_number相同。（貌似不是获取帧的维数，有时为1，有时11，不知道干嘛用的）
    """

    frame_timestamp_domain = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """
    The timestamp domain. Identical to calling get_frame_timestamp_domain.
    时间戳域。 与调用get_frame_timestamp_domain相同。
    """

    profile = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """
    Stream profile from frame handle. Identical to calling get_profile.
    来自帧句柄的流配置文件。 与调用get_profile相同。
    """

    timestamp = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """
    Time at which the frame was captured. Identical to calling get_timestamp.
    捕获帧的时间。 与调用get_timestamp相同
    """