PlayerCc::StereoProxy Class Reference

the Stereo proxy provides access to the stereo device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::StereoProxy:
Inheritance graph
Collaboration diagram for PlayerCc::StereoProxy:
Collaboration graph

Detailed Description

the Stereo proxy provides access to the stereo device.

Public Member Functions

 StereoProxy (PlayerClient *aPc, uint32_t aIndex=0)
 Constructor.
 
 ~StereoProxy ()
 Destructor.
 
void SaveLeftFrame (const std::string aPrefix, uint32_t aWidth=4)
 Save the left frame. More...
 
void SaveRightFrame (const std::string aPrefix, uint32_t aWidth=4)
 Save the right frame. More...
 
void SaveDisparityFrame (const std::string aPrefix, uint32_t aWidth=4)
 Save the disparity frame. More...
 
void DecompressLeft ()
 decompress the left image
 
void DecompressRight ()
 decompress the right image
 
void DecompressDisparity ()
 decompress the disparity image
 
uint32_t GetLeftDepth () const
 Left image color depth.
 
uint32_t GetRightDepth () const
 Right image color depth.
 
uint32_t GetDisparityDepth () const
 Disparity image color depth.
 
uint32_t GetLeftWidth () const
 Left image width (pixels)
 
uint32_t GetRightWidth () const
 Right image width (pixels)
 
uint32_t GetDisparityWidth () const
 Disparity image width (pixels)
 
uint32_t GetLeftHeight () const
 Left image height (pixels)
 
uint32_t GetRightHeight () const
 Right image height (pixels)
 
uint32_t GetDisparityHeight () const
 Disparity image height (pixels)
 
uint32_t GetLeftFormat () const
 Image format Possible values include. More...
 
uint32_t GetRightFormat () const
 Image format Possible values include. More...
 
uint32_t GetDisparityFormat () const
 Image format Possible values include. More...
 
uint32_t GetLeftImageSize () const
 Size of the left image (bytes)
 
uint32_t GetRightImageSize () const
 Size of the right image (bytes)
 
uint32_t GetDisparityImageSize () const
 Size of the disparity image (bytes)
 
void GetLeftImage (uint8_t *aImage) const
 Left image data This function copies the image data into the data buffer aImage. More...
 
void GetRightImage (uint8_t *aImage) const
 Right image data This function copies the image data into the data buffer aImage. More...
 
void GetDisparityImage (uint8_t *aImage) const
 Disparity image data This function copies the image data into the data buffer aImage. More...
 
uint32_t GetLeftCompression () const
 Get the left image's compression type Currently supported compression types are: More...
 
uint32_t GetRightCompression () const
 Get the right image's compression type Currently supported compression types are: More...
 
uint32_t GetDisparityCompression () const
 Get the disparity image's compression type Currently supported compression types are: More...
 
uint32_t GetCount () const
 return the point count
 
player_pointcloud3d_stereo_element_t GetPoint (uint32_t aIndex) const
 return a particular point value
 
player_pointcloud3d_stereo_element_t operator[] (uint32_t aIndex) const
 This operator provides an alternate way of access the point data. More...
 
- Public Member Functions inherited from PlayerCc::ClientProxy
bool IsValid () const
 Proxy has any information. More...
 
bool IsFresh () const
 Check for fresh data. More...
 
void NotFresh ()
 Reset Fresh flag. More...
 
std::string GetDriverName () const
 Get the underlying driver's name. More...
 
double GetDataTime () const
 Returns the received timestamp of the last data sample [s].
 
double GetElapsedTime () const
 Returns the time between the current data time and the time of the last data sample [s].
 
PlayerClientGetPlayerClient () const
 Get a pointer to the Player Client. More...
 
uint32_t GetIndex () const
 Get device index. More...
 
uint32_t GetInterface () const
 Get Interface Code. More...
 
std::string GetInterfaceStr () const
 Get Interface Name. More...
 
void SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
 Set a replace rule for this proxy on the server. More...
 
int HasCapability (uint32_t aType, uint32_t aSubtype)
 Request capabilities of device. More...
 
int GetBoolProp (char *aProperty, bool *aValue)
 Request a boolean property. More...
 
int SetBoolProp (char *aProperty, bool aValue)
 Set a boolean property. More...
 
int GetIntProp (char *aProperty, int32_t *aValue)
 Request an integer property. More...
 
int SetIntProp (char *aProperty, int32_t aValue)
 Set an integer property. More...
 
int GetDblProp (char *aProperty, double *aValue)
 Request a double property. More...
 
int SetDblProp (char *aProperty, double aValue)
 Set a double property. More...
 
int GetStrProp (char *aProperty, char **aValue)
 Request a string property. More...
 
int SetStrProp (char *aProperty, char *aValue)
 Set a string property. More...
 
template<typename T >
connection_t ConnectReadSignal (T aSubscriber)
 Connect a read signal to this proxy. More...
 
void DisconnectReadSignal (connection_t aSubscriber)
 Disconnect a signal from this proxy. More...
 

Private Member Functions

void Subscribe (uint32_t aIndex)
 
void Unsubscribe ()
 
void SaveFrame (const std::string aPrefix, uint32_t aWidth, playerc_camera_t aDevice, uint8_t aIndex)
 Save a frame.
 
void Decompress (playerc_camera_t aDevice)
 Decompress an image.
 

Private Attributes

playerc_stereo_tmDevice
 libplayerc data structure
 
std::string mPrefix
 Default image prefix.
 
uint32_t mFrameNo [3]
 Frame counter for image saving methods.
 

Additional Inherited Members

- Public Types inherited from PlayerCc::ClientProxy
typedef int connection_t
 
typedef boost::mutex::scoped_lock scoped_lock_t
 
typedef int read_signal_t
 
- Protected Member Functions inherited from PlayerCc::ClientProxy
 ClientProxy (PlayerClient *aPc, uint32_t aIndex)
 
template<typename T >
GetVar (const T &aV) const
 
template<typename T >
void GetVarByRef (const T aBegin, const T aEnd, T aDest) const
 
- Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClientmPc
 
playerc_client_tmClient
 
playerc_device_tmInfo
 
bool mFresh
 

Member Function Documentation

◆ GetDisparityCompression()

uint32_t PlayerCc::StereoProxy::GetDisparityCompression ( ) const
inline

Get the disparity image's compression type Currently supported compression types are:

References playerc_camera_t::compression.

◆ GetDisparityFormat()

uint32_t PlayerCc::StereoProxy::GetDisparityFormat ( ) const
inline

◆ GetDisparityImage()

void PlayerCc::StereoProxy::GetDisparityImage ( uint8_t *  aImage) const
inline

Disparity image data This function copies the image data into the data buffer aImage.

The buffer should be allocated according to the width, height, and depth of the image. The size can be found by calling GetDisparityImageSize().

References playerc_camera_t::image, and playerc_camera_t::image_count.

◆ GetLeftCompression()

uint32_t PlayerCc::StereoProxy::GetLeftCompression ( ) const
inline

Get the left image's compression type Currently supported compression types are:

References playerc_camera_t::compression.

◆ GetLeftFormat()

uint32_t PlayerCc::StereoProxy::GetLeftFormat ( ) const
inline

◆ GetLeftImage()

void PlayerCc::StereoProxy::GetLeftImage ( uint8_t *  aImage) const
inline

Left image data This function copies the image data into the data buffer aImage.

The buffer should be allocated according to the width, height, and depth of the image. The size can be found by calling GetLeftImageSize().

References playerc_camera_t::image, and playerc_camera_t::image_count.

◆ GetRightCompression()

uint32_t PlayerCc::StereoProxy::GetRightCompression ( ) const
inline

Get the right image's compression type Currently supported compression types are:

References playerc_camera_t::compression.

◆ GetRightFormat()

uint32_t PlayerCc::StereoProxy::GetRightFormat ( ) const
inline

◆ GetRightImage()

void PlayerCc::StereoProxy::GetRightImage ( uint8_t *  aImage) const
inline

Right image data This function copies the image data into the data buffer aImage.

The buffer should be allocated according to the width, height, and depth of the image. The size can be found by calling GetRightImageSize().

References playerc_camera_t::image, and playerc_camera_t::image_count.

◆ operator[]()

player_pointcloud3d_stereo_element_t PlayerCc::StereoProxy::operator[] ( uint32_t  aIndex) const
inline

This operator provides an alternate way of access the point data.

For example, StereoProxy[0] == StereoProxy.GetPoint(0)

◆ SaveDisparityFrame()

void PlayerCc::StereoProxy::SaveDisparityFrame ( const std::string  aPrefix,
uint32_t  aWidth = 4 
)
inline

Save the disparity frame.

  • aPrefix is the string prefix to name the image.
  • aWidth is the number of 0s to pad the image numbering with.

◆ SaveLeftFrame()

void PlayerCc::StereoProxy::SaveLeftFrame ( const std::string  aPrefix,
uint32_t  aWidth = 4 
)
inline

Save the left frame.

  • aPrefix is the string prefix to name the image.
  • aWidth is the number of 0s to pad the image numbering with.

◆ SaveRightFrame()

void PlayerCc::StereoProxy::SaveRightFrame ( const std::string  aPrefix,
uint32_t  aWidth = 4 
)
inline

Save the right frame.

  • aPrefix is the string prefix to name the image.
  • aWidth is the number of 0s to pad the image numbering with.

The documentation for this class was generated from the following file: