YARP
Yet Another Robot Platform
yarp::dev::Implement_RgbVisualParams_Sender Class Reference

#include <yarp/dev/IVisualParamsImpl.h>

+ Inheritance diagram for yarp::dev::Implement_RgbVisualParams_Sender:

Public Member Functions

 Implement_RgbVisualParams_Sender (yarp::os::Port &port)
 
virtual ~Implement_RgbVisualParams_Sender ()
 
int getRgbHeight () override
 Return the height of each frame. More...
 
int getRgbWidth () override
 Return the width of each frame. More...
 
bool getRgbSupportedConfigurations (yarp::sig::VectorOf< CameraConfig > &configurations) override
 Get the possible configurations of the camera. More...
 
bool getRgbResolution (int &width, int &height) override
 Get the resolution of the rgb image from the camera. More...
 
bool setRgbResolution (int width, int height) override
 Set the resolution of the rgb image from the camera. More...
 
bool getRgbFOV (double &horizontalFov, double &verticalFov) override
 Get the field of view (FOV) of the rgb camera. More...
 
bool setRgbFOV (double horizontalFov, double verticalFov) override
 Set the field of view (FOV) of the rgb camera. More...
 
bool getRgbIntrinsicParam (yarp::os::Property &intrinsic) override
 Get the intrinsic parameters of the rgb camera. More...
 
bool getRgbMirroring (bool &mirror) override
 Get the mirroring setting of the sensor. More...
 
bool setRgbMirroring (bool mirror) override
 Set the mirroring setting of the sensor. More...
 
- Public Member Functions inherited from yarp::dev::IRgbVisualParams
virtual ~IRgbVisualParams ()
 

Protected Attributes

yarp::os::Port_port
 

Detailed Description

Definition at line 31 of file IVisualParamsImpl.h.

Constructor & Destructor Documentation

◆ Implement_RgbVisualParams_Sender()

Implement_RgbVisualParams_Sender::Implement_RgbVisualParams_Sender ( yarp::os::Port port)

Definition at line 22 of file IVisualParamsImpl.cpp.

◆ ~Implement_RgbVisualParams_Sender()

virtual yarp::dev::Implement_RgbVisualParams_Sender::~Implement_RgbVisualParams_Sender ( )
inlinevirtual

Definition at line 38 of file IVisualParamsImpl.h.

Member Function Documentation

◆ getRgbFOV()

bool Implement_RgbVisualParams_Sender::getRgbFOV ( double &  horizontalFov,
double &  verticalFov 
)
overridevirtual

Get the field of view (FOV) of the rgb camera.

Parameters
horizontalFovwill return the value of the horizontal fov in degrees
verticalFovwill return the value of the vertical fov in degrees
Returns
true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 96 of file IVisualParamsImpl.cpp.

◆ getRgbHeight()

int Implement_RgbVisualParams_Sender::getRgbHeight ( )
overridevirtual

Return the height of each frame.

Returns
rgb image height

Implements yarp::dev::IRgbVisualParams.

Definition at line 24 of file IVisualParamsImpl.cpp.

◆ getRgbIntrinsicParam()

bool Implement_RgbVisualParams_Sender::getRgbIntrinsicParam ( yarp::os::Property intrinsic)
overridevirtual

Get the intrinsic parameters of the rgb camera.

Parameters
intrinsicreturn a Property containing intrinsic parameters of the optical model of the camera.
Returns
true if success

The yarp::os::Property describing the intrinsic parameters is expected to be in the form:

Parameter name SubParameter Type Units Default Value Required Description Notes
physFocalLength - double m - Yes Physical focal length of the lens in meters
focalLengthX - double pixel - Yes Horizontal component of the focal length as a multiple of pixel width
focalLengthY - double pixel - Yes Vertical component of the focal length as a multiple of pixel height
principalPointX - double pixel - Yes X coordinate of the principal point
principalPointY - double pixel - Yes Y coordinate of the principal point
retificationMatrix - 4x4 double matrix - - Yes Matrix that describes the lens' distortion
distortionModel - string - - Yes Reference to group of parameters describing the distortion model of the camera, example 'cameraDistortionModelGroup' This is another group's name to be searched for in the config file
cameraDistortionModelGroup
name string - - Yes Name of the distortion model, see notes right now only 'plumb_bob' is supported
k1 double - - Yes Radial distortion coefficient of the lens
k2 double - - Yes Radial distortion coefficient of the lens
k3 double - - Yes Radial distortion coefficient of the lens
t1 double - - Yes Tangential distortion of the lens
t2 double - - Yes Tangential distortion of the lens

Implements yarp::dev::IRgbVisualParams.

Definition at line 128 of file IVisualParamsImpl.cpp.

◆ getRgbMirroring()

bool Implement_RgbVisualParams_Sender::getRgbMirroring ( bool &  mirror)
overridevirtual

Get the mirroring setting of the sensor.

Parameters
mirrortrue if image is mirrored, false otherwise
Returns
true if success

Implements yarp::dev::IRgbVisualParams.

Definition at line 154 of file IVisualParamsImpl.cpp.

◆ getRgbResolution()

bool Implement_RgbVisualParams_Sender::getRgbResolution ( int &  width,
int &  height 
)
overridevirtual

Get the resolution of the rgb image from the camera.

Parameters
widthimage width
heightimage height
Returns
true on success

Reimplemented from yarp::dev::IRgbVisualParams.

Definition at line 64 of file IVisualParamsImpl.cpp.

◆ getRgbSupportedConfigurations()

bool Implement_RgbVisualParams_Sender::getRgbSupportedConfigurations ( yarp::sig::VectorOf< CameraConfig > &  configurations)
overridevirtual

Get the possible configurations of the camera.

Parameters
configurationslist of camera supported configurations as CameraConfig type
Returns
true on success

Reimplemented from yarp::dev::IRgbVisualParams.

Definition at line 43 of file IVisualParamsImpl.cpp.

◆ getRgbWidth()

int Implement_RgbVisualParams_Sender::getRgbWidth ( )
overridevirtual

Return the width of each frame.

Returns
rgb image width

Implements yarp::dev::IRgbVisualParams.

Definition at line 34 of file IVisualParamsImpl.cpp.

◆ setRgbFOV()

bool Implement_RgbVisualParams_Sender::setRgbFOV ( double  horizontalFov,
double  verticalFov 
)
overridevirtual

Set the field of view (FOV) of the rgb camera.

Parameters
horizontalFovwill set the value of the horizontal fov in degrees
verticalFovwill set the value of the vertical fov in degrees
Returns
true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 116 of file IVisualParamsImpl.cpp.

◆ setRgbMirroring()

bool Implement_RgbVisualParams_Sender::setRgbMirroring ( bool  mirror)
overridevirtual

Set the mirroring setting of the sensor.

Parameters
mirrortrue if image should be mirrored, false otherwise
Returns
true if success

Implements yarp::dev::IRgbVisualParams.

Definition at line 169 of file IVisualParamsImpl.cpp.

◆ setRgbResolution()

bool Implement_RgbVisualParams_Sender::setRgbResolution ( int  width,
int  height 
)
overridevirtual

Set the resolution of the rgb image from the camera.

Parameters
widthimage width
heightimage height
Returns
true on success

Implements yarp::dev::IRgbVisualParams.

Definition at line 84 of file IVisualParamsImpl.cpp.

Member Data Documentation

◆ _port

yarp::os::Port& yarp::dev::Implement_RgbVisualParams_Sender::_port
protected

Definition at line 34 of file IVisualParamsImpl.h.


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