 |
OrbbecSDK 2.6.3
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
|
Loading...
Searching...
No Matches
|
OrbbecSDK 2.6.3
OrbbecSDK: Software-Development-Kit for Orbbec 3D Cameras
|
Define the DepthFrame class, which inherits from the VideoFrame class. More...
#include <Frame.hpp>
Public Member Functions | |
| DepthFrame (const ob_frame *impl) | |
| Construct a new DepthFrame object with a given pointer to the internal frame object. | |
| ~DepthFrame () noexcept override=default | |
| float | getValueScale () const |
| Get the value scale of the depth frame. The pixel value of depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm. | |
| void | setValueScale (float valueScale) |
| Set the value scale of the depth frame. The pixel value of the depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm. | |
| Public Member Functions inherited from ob::VideoFrame | |
| VideoFrame (const ob_frame *impl) | |
| Construct a new VideoFrame object with a given pointer to the internal frame object. | |
| ~VideoFrame () noexcept override=default | |
| uint32_t | getWidth () const |
| Get the width of the frame. | |
| uint32_t | getHeight () const |
| Get the height of the frame. | |
| OBPixelType | getPixelType () const |
| Get the Pixel Type object. | |
| uint8_t | getPixelAvailableBitSize () const |
| Get the effective number of pixels in the frame. | |
| void | setPixelType (OBPixelType pixelType) |
| Set video frame pixel format. | |
| void | setPixelAvailableBitSize (uint8_t bitSize) |
| Set the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are effective bits, and the upper 6 bits are filled with 0) | |
| uint32_t | width () const |
| uint32_t | height () const |
| uint8_t | pixelAvailableBitSize () const |
| Public Member Functions inherited from ob::Frame | |
| Frame (const ob_frame *impl) | |
| Construct a new Frame object with a given pointer to the internal frame object. | |
| const ob_frame * | getImpl () const |
| Get the internal (impl) frame object. | |
| virtual | ~Frame () noexcept |
| Destroy the Frame object. | |
| virtual OBFrameType | getType () const |
| Get the type of frame. | |
| virtual OBFormat | getFormat () const |
| Get the format of the frame. | |
| virtual uint64_t | getIndex () const |
| Get the sequence number of the frame. | |
| virtual uint8_t * | getData () const |
| Get frame data. | |
| virtual uint32_t | getDataSize () const |
| Get the size of the frame data. | |
| uint64_t | getTimeStampUs () const |
| Get the hardware timestamp of the frame in microseconds. | |
| uint64_t | getSystemTimeStampUs () const |
| Get the system timestamp of the frame in microseconds. | |
| uint64_t | getGlobalTimeStampUs () const |
| Get the global timestamp of the frame in microseconds. | |
| uint8_t * | getMetadata () const |
| Get the metadata pointer of the frame. | |
| uint32_t | getMetadataSize () const |
| Get the size of the metadata of the frame. | |
| bool | hasMetadata (OBFrameMetadataType type) const |
| Check if the frame object has metadata of a given type. | |
| int64_t | getMetadataValue (OBFrameMetadataType type) const |
| Get the metadata value. | |
| std::shared_ptr< StreamProfile > | getStreamProfile () const |
| get StreamProfile of the frame | |
| std::shared_ptr< Sensor > | getSensor () const |
| get owner sensor of the frame | |
| std::shared_ptr< Device > | getDevice () const |
| get owner device of the frame | |
| template<typename T> | |
| bool | is () const |
| Check if the runtime type of the frame object is compatible with a given type. | |
| template<typename T> | |
| std::shared_ptr< T > | as () |
| Convert the frame object to a target type. | |
| template<typename T> | |
| std::shared_ptr< const T > | as () const |
| Convert the frame object to a target type. | |
| void | copyFrameInfo (std::shared_ptr< const Frame > srcFrame) |
| Copy the information of the source frame object to the destination frame object. | |
| void | setSystemTimestampUs (uint64_t systemTimestampUs) |
| Set the system timestamp of the frame in microseconds. | |
| void | updateData (const uint8_t *data, uint32_t dataSize) |
| Update the data of a frame. | |
| void | updateMetadata (const uint8_t *metadata, uint32_t metadataSize) |
| Update the metadata of the frame. | |
| void | setStreamProfile (std::shared_ptr< const StreamProfile > profile) |
| Set (override) the stream profile of the frame. | |
| OBFrameType | type () const |
| virtual OBFormat | format () const |
| virtual uint64_t | index () const |
| virtual void * | data () const |
| virtual uint32_t | dataSize () const |
| uint64_t | timeStamp () const |
| uint64_t | timeStampUs () const |
| uint64_t | systemTimeStamp () const |
| uint64_t | systemTimeStampUs () const |
| uint64_t | globalTimeStampUs () const |
| uint8_t * | metadata () const |
| uint32_t | metadataSize () const |
Additional Inherited Members | |
| Protected Attributes inherited from ob::Frame | |
| const ob_frame * | impl_ = nullptr |
| The pointer to the internal (c api level) frame object. | |
Define the DepthFrame class, which inherits from the VideoFrame class.
|
inlineexplicit |
Construct a new DepthFrame object with a given pointer to the internal frame object.
| [in] | impl | The pointer to the internal frame object. |
|
overridedefaultnoexcept |
|
inline |
Get the value scale of the depth frame. The pixel value of depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm.
Definition at line 639 of file Frame.hpp.
Referenced by getValueScale().
|
inline |
Set the value scale of the depth frame. The pixel value of the depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm.
| [in] | valueScale | The value scale of the depth frame |
1.14.0
