YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::IRgbVisualParams Class Referenceabstract

An interface for retrieving intrinsic parameter from a rgb camera. More...

#include <yarp/dev/IRgbVisualParams.h>

+ Inheritance diagram for yarp::dev::IRgbVisualParams:

Public Member Functions

virtual ~IRgbVisualParams ()
 
virtual int getRgbHeight ()=0
 Return the height of each frame.
 
virtual int getRgbWidth ()=0
 Return the width of each frame.
 
virtual yarp::dev::ReturnValue getRgbSupportedConfigurations (std::vector< yarp::dev::CameraConfigData > &configurations)=0
 Get the possible configurations of the camera.
 
virtual yarp::dev::ReturnValue getRgbResolution (int &width, int &height)=0
 Get the resolution of the rgb image from the camera.
 
virtual yarp::dev::ReturnValue setRgbResolution (int width, int height)=0
 Set the resolution of the rgb image from the camera.
 
virtual yarp::dev::ReturnValue getRgbFOV (double &horizontalFov, double &verticalFov)=0
 Get the field of view (FOV) of the rgb camera.
 
virtual yarp::dev::ReturnValue setRgbFOV (double horizontalFov, double verticalFov)=0
 Set the field of view (FOV) of the rgb camera.
 
virtual yarp::dev::ReturnValue getRgbIntrinsicParam (yarp::sig::IntrinsicParams &intrinsic)=0
 Get the intrinsic parameters of the rgb camera.
 
virtual yarp::dev::ReturnValue getRgbMirroring (bool &mirror)=0
 Get the mirroring setting of the sensor.
 
virtual yarp::dev::ReturnValue setRgbMirroring (bool mirror)=0
 Set the mirroring setting of the sensor.
 

Detailed Description

An interface for retrieving intrinsic parameter from a rgb camera.

Definition at line 33 of file IRgbVisualParams.h.

Constructor & Destructor Documentation

◆ ~IRgbVisualParams()

yarp::dev::IRgbVisualParams::~IRgbVisualParams ( )
virtualdefault

Member Function Documentation

◆ getRgbFOV()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::getRgbFOV ( double &  horizontalFov,
double &  verticalFov 
)
pure virtual

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

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getRgbHeight()

virtual int yarp::dev::IRgbVisualParams::getRgbHeight ( )
pure virtual

◆ getRgbIntrinsicParam()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::getRgbIntrinsicParam ( yarp::sig::IntrinsicParams &  intrinsic)
pure virtual

Get the intrinsic parameters of the rgb camera.

Parameters
intrinsicreturn a yarp::sig::IntrinsicParams containing intrinsic parameters of the optical model of the camera.
Returns
true if success

Implemented in FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, USBCameraDriver, and V4L_camera.

◆ getRgbMirroring()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::getRgbMirroring ( bool &  mirror)
pure virtual

Get the mirroring setting of the sensor.

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

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getRgbResolution()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::getRgbResolution ( int &  width,
int &  height 
)
pure virtual

Get the resolution of the rgb image from the camera.

Parameters
widthimage width
heightimage height
Returns
true on success

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getRgbSupportedConfigurations()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::getRgbSupportedConfigurations ( std::vector< yarp::dev::CameraConfigData > &  configurations)
pure virtual

Get the possible configurations of the camera.

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

Implemented in FrameGrabberCropper, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ getRgbWidth()

virtual int yarp::dev::IRgbVisualParams::getRgbWidth ( )
pure virtual

◆ setRgbFOV()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::setRgbFOV ( double  horizontalFov,
double  verticalFov 
)
pure virtual

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

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setRgbMirroring()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::setRgbMirroring ( bool  mirror)
pure virtual

Set the mirroring setting of the sensor.

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

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.

◆ setRgbResolution()

virtual yarp::dev::ReturnValue yarp::dev::IRgbVisualParams::setRgbResolution ( int  width,
int  height 
)
pure virtual

Set the resolution of the rgb image from the camera.

Parameters
widthimage width
heightimage height
Returns
true on success

Implemented in argusCameraDriver, pylonCameraDriver, realsense2Driver, RgbdSensor_nwc_ros2, FakeDepthCameraDriver_mini, FakeFrameGrabber, FrameGrabberCropper, FrameGrabber_nwc_yarp, RGBDSensor_nwc_yarp, depthCameraDriver, USBCameraDriver, and V4L_camera.


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