YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
FrameGrabberCropper Class Reference

FrameGrabberCropper: An image frame grabber device which can also crop the frame. More...

#include <frameGrabberCropper/FrameGrabberCropper.h>

+ Inheritance diagram for FrameGrabberCropper:

Public Member Functions

 FrameGrabberCropper ()=default
 
 FrameGrabberCropper (const FrameGrabberCropper &)=delete
 
 FrameGrabberCropper (FrameGrabberCropper &&)=delete
 
FrameGrabberCropper & operator= (const FrameGrabberCropper &)=delete
 
FrameGrabberCropper & operator= (FrameGrabberCropper &&)=delete
 
 ~FrameGrabberCropper () override
 
bool close () override
 Close the DeviceDriver.
 
bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool attach (yarp::dev::PolyDriver *poly) override
 Attach to another object.
 
bool detach () override
 Detach the object (you must have first called attach).
 
bool attachAll (const yarp::dev::PolyDriverList &device2attach) override
 Attach to a list of objects.
 
bool detachAll () override
 Detach the object (you must have first called attach).
 
yarp::dev::ReturnValue getCameraDescription (yarp::dev::CameraDescriptor &camera) override
 Get a basic description of the camera hw.
 
yarp::dev::ReturnValue hasFeature (yarp::dev::cameraFeature_id_t feature, bool &hasFeature) override
 Check if camera has the requested feature (saturation, brightness ... )
 
yarp::dev::ReturnValue setFeature (yarp::dev::cameraFeature_id_t feature, double value) override
 Set the requested feature to a value (saturation, brightness ... )
 
yarp::dev::ReturnValue getFeature (yarp::dev::cameraFeature_id_t feature, double &value) override
 Get the current value for the requested feature.
 
yarp::dev::ReturnValue setFeature (yarp::dev::cameraFeature_id_t feature, double value1, double value2) override
 Set the requested feature to a value using 2 params (like white balance)
 
yarp::dev::ReturnValue getFeature (yarp::dev::cameraFeature_id_t feature, double &value1, double &value2) override
 Get the current value for the requested feature.
 
yarp::dev::ReturnValue hasOnOff (yarp::dev::cameraFeature_id_t feature, bool &HasOnOff) override
 Check if the camera has the ability to turn on/off the requested feature.
 
yarp::dev::ReturnValue setActive (yarp::dev::cameraFeature_id_t feature, bool onoff) override
 Set the requested feature on or off.
 
yarp::dev::ReturnValue getActive (yarp::dev::cameraFeature_id_t feature, bool &isActive) override
 Get the current status of the feature, on or off.
 
yarp::dev::ReturnValue hasAuto (yarp::dev::cameraFeature_id_t feature, bool &hasAuto) override
 Check if the requested feature has the 'auto' mode.
 
yarp::dev::ReturnValue hasManual (yarp::dev::cameraFeature_id_t feature, bool &hasManual) override
 Check if the requested feature has the 'manual' mode.
 
yarp::dev::ReturnValue hasOnePush (yarp::dev::cameraFeature_id_t feature, bool &hasOnePush) override
 Check if the requested feature has the 'onePush' mode.
 
yarp::dev::ReturnValue setMode (yarp::dev::cameraFeature_id_t feature, yarp::dev::FeatureMode mode) override
 Set the requested mode for the feature.
 
yarp::dev::ReturnValue getMode (yarp::dev::cameraFeature_id_t feature, yarp::dev::FeatureMode &mode) override
 Get the current mode for the feature.
 
yarp::dev::ReturnValue setOnePush (yarp::dev::cameraFeature_id_t feature) override
 Set the requested feature to a value (saturation, brightness ... )
 
yarp::dev::ReturnValue getVideoModeMaskDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue getVideoModeDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue setVideoModeDC1394 (int video_mode) override
 
yarp::dev::ReturnValue getFPSMaskDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue getFPSDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue setFPSDC1394 (int fps) override
 
yarp::dev::ReturnValue getISOSpeedDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue setISOSpeedDC1394 (int speed) override
 
yarp::dev::ReturnValue getColorCodingMaskDC1394 (unsigned int video_mode, unsigned int &val) override
 
yarp::dev::ReturnValue getColorCodingDC1394 (unsigned int &val) override
 
yarp::dev::ReturnValue setColorCodingDC1394 (int coding) override
 
yarp::dev::ReturnValue getFormat7MaxWindowDC1394 (unsigned int &xdim, unsigned int &ydim, unsigned int &xstep, unsigned int &ystep, unsigned int &xoffstep, unsigned int &yoffstep) override
 
yarp::dev::ReturnValue getFormat7WindowDC1394 (unsigned int &xdim, unsigned int &ydim, int &x0, int &y0) override
 
yarp::dev::ReturnValue setFormat7WindowDC1394 (unsigned int xdim, unsigned int ydim, int x0, int y0) override
 
yarp::dev::ReturnValue setOperationModeDC1394 (bool b1394b) override
 
yarp::dev::ReturnValue getOperationModeDC1394 (bool &b1394b) override
 
yarp::dev::ReturnValue setTransmissionDC1394 (bool bTxON) override
 
yarp::dev::ReturnValue getTransmissionDC1394 (bool &bTxON) override
 
yarp::dev::ReturnValue setBroadcastDC1394 (bool onoff) override
 
yarp::dev::ReturnValue setDefaultsDC1394 () override
 
yarp::dev::ReturnValue setResetDC1394 () override
 
yarp::dev::ReturnValue setPowerDC1394 (bool onoff) override
 
yarp::dev::ReturnValue setCaptureDC1394 (bool bON) override
 
yarp::dev::ReturnValue getBytesPerPacketDC1394 (unsigned int &bpp) override
 
yarp::dev::ReturnValue setBytesPerPacketDC1394 (unsigned int bpp) override
 
int getRgbHeight () override
 Return the height of each frame.
 
int getRgbWidth () override
 Return the width of each frame.
 
yarp::dev::ReturnValue getRgbResolution (int &width, int &height) override
 Get the resolution of the rgb image from the camera.
 
yarp::dev::ReturnValue setRgbResolution (int width, int height) override
 Set the resolution of the rgb image from the camera.
 
yarp::dev::ReturnValue getRgbFOV (double &horizontalFov, double &verticalFov) override
 Get the field of view (FOV) of the rgb camera.
 
yarp::dev::ReturnValue setRgbFOV (double horizontalFov, double verticalFov) override
 Set the field of view (FOV) of the rgb camera.
 
yarp::dev::ReturnValue getRgbIntrinsicParam (yarp::sig::IntrinsicParams &intrinsic) override
 Get the intrinsic parameters of the rgb camera.
 
yarp::dev::ReturnValue getRgbSupportedConfigurations (std::vector< yarp::dev::CameraConfig > &cfgs) override
 Get the possible configurations of the camera.
 
yarp::dev::ReturnValue getRgbMirroring (bool &mirror) override
 Get the mirroring setting of the sensor.
 
yarp::dev::ReturnValue setRgbMirroring (bool mirror) override
 Set the mirroring setting of the sensor.
 
yarp::os::Stamp getLastInputStamp () override
 Return the time stamp relative to the last acquisition.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriver & operator= (const DeviceDriver &other)=delete
 
DeviceDriver & operator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDriver * getImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::dev::IWrapper
virtual ~IWrapper ()
 Destructor.
 
- Public Member Functions inherited from yarp::dev::IMultipleWrapper
virtual ~IMultipleWrapper ()
 Destructor.
 
- Public Member Functions inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
 ~FrameGrabberCropperOf () override=default
 
yarp::dev::ReturnValue getImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
 Get an image from the frame grabber.
 
int height () const override
 Return the height of each frame.
 
int width () const override
 Return the width of each frame.
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberOf< ImageType >
virtual yarp::dev::ReturnValue getImageCrop (yarp::dev::cropType_id_t cropType, std::vector< yarp::dev::VertexData > vertices, ImageType &image)
 Get a crop of the image from the frame grabber.
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberImageBase
virtual ~IFrameGrabberImageBase ()
 Destructor.
 
- Public Member Functions inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
 ~FrameGrabberCropperOf () override=default
 
yarp::dev::ReturnValue getImage (yarp::sig::ImageOf< yarp::sig::PixelMono > &image) override
 Get an image from the frame grabber.
 
int height () const override
 Return the height of each frame.
 
int width () const override
 Return the width of each frame.
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberControls
virtual ~IFrameGrabberControls ()
 Destructor.
 
std::string busType2String (BusType type)
 
FeatureMode toFeatureMode (bool _auto)
 
- Public Member Functions inherited from yarp::dev::IFrameGrabberControlsDC1394
virtual ~IFrameGrabberControlsDC1394 ()
 
- Public Member Functions inherited from yarp::dev::IRgbVisualParams
virtual ~IRgbVisualParams ()
 
- Public Member Functions inherited from yarp::dev::IPreciselyTimed
virtual ~IPreciselyTimed ()
 
- Public Member Functions inherited from FrameGrabberCropper_ParamsParser
 FrameGrabberCropper_ParamsParser ()
 
 ~FrameGrabberCropper_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
bool getParamValue (const std::string &paramName, std::string &paramValue) const override
 Return the value (represented as a string) of the requested parameter.
 
std::string getConfiguration () const override
 Return the configuration of the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Additional Inherited Members

- Public Attributes inherited from FrameGrabberCropper_ParamsParser
const std::string m_device_classname = {"FrameGrabberCropper"}
 
const std::string m_device_name = {"frameGrabberCropper"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
std::string m_provided_configuration
 
const std::string m_x1_defaultValue = {"0"}
 
const std::string m_y1_defaultValue = {"0"}
 
const std::string m_x2_defaultValue = {"100"}
 
const std::string m_y2_defaultValue = {"100"}
 
const std::string m_forwardRgbVisualParams_defaultValue = {"false"}
 
int m_x1 = {0}
 
int m_y1 = {0}
 
int m_x2 = {100}
 
int m_y2 = {100}
 
bool m_forwardRgbVisualParams = {false}
 
- Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > > * iFrameGrabberOf
 
std::vector< yarp::dev::VertexData > vertices
 
- Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
yarp::dev::IFrameGrabberOf< yarp::sig::ImageOf< yarp::sig::PixelMono > > * iFrameGrabberOf
 
std::vector< yarp::dev::VertexData > vertices
 
- Static Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelRgb > >
static constexpr yarp::dev::cropType_id_t cropType
 
- Static Protected Attributes inherited from FrameGrabberCropperOf< yarp::sig::ImageOf< yarp::sig::PixelMono > >
static constexpr yarp::dev::cropType_id_t cropType
 

Detailed Description

FrameGrabberCropper: An image frame grabber device which can also crop the frame.

In must be attached to another grabber.

Parameters required by this device are shown in class: FrameGrabberCropper_ParamsParser

Definition at line 66 of file FrameGrabberCropper.h.

Constructor & Destructor Documentation

◆ FrameGrabberCropper() [1/3]

FrameGrabberCropper::FrameGrabberCropper ( )
default

◆ FrameGrabberCropper() [2/3]

FrameGrabberCropper::FrameGrabberCropper ( const FrameGrabberCropper &  )
delete

◆ FrameGrabberCropper() [3/3]

FrameGrabberCropper::FrameGrabberCropper ( FrameGrabberCropper &&  )
delete

◆ ~FrameGrabberCropper()

FrameGrabberCropper::~FrameGrabberCropper ( )
override

Definition at line 17 of file FrameGrabberCropper.cpp.

Member Function Documentation

◆ attach()

bool FrameGrabberCropper::attach ( yarp::dev::PolyDriver *  driver)
overridevirtual

Attach to another object.

Parameters
driverthe polydriver that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 39 of file FrameGrabberCropper.cpp.

◆ attachAll()

bool FrameGrabberCropper::attachAll ( const yarp::dev::PolyDriverList &  drivers)
overridevirtual

Attach to a list of objects.

Parameters
driversthe polydriver list that you want to attach to.
Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 72 of file FrameGrabberCropper.cpp.

◆ close()

bool FrameGrabberCropper::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 34 of file FrameGrabberCropper.cpp.

◆ detach()

bool FrameGrabberCropper::detach ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IWrapper.

Definition at line 61 of file FrameGrabberCropper.cpp.

◆ detachAll()

bool FrameGrabberCropper::detachAll ( )
overridevirtual

Detach the object (you must have first called attach).

Returns
true/false on success failure.

Implements yarp::dev::IMultipleWrapper.

Definition at line 82 of file FrameGrabberCropper.cpp.

◆ getActive()

yarp::dev::ReturnValue FrameGrabberCropper::getActive ( yarp::dev::cameraFeature_id_t  feature,
bool &  isActive 
)
overridevirtual

Get the current status of the feature, on or off.

Parameters
featurethe identifier of the feature to check
isActiveflag true if the feature is active, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 220 of file FrameGrabberCropper.cpp.

◆ getBytesPerPacketDC1394()

ReturnValue FrameGrabberCropper::getBytesPerPacketDC1394 ( unsigned int &  bpp)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 473 of file FrameGrabberCropper.cpp.

◆ getCameraDescription()

yarp::dev::ReturnValue FrameGrabberCropper::getCameraDescription ( yarp::dev::CameraDescriptor &  camera)
overridevirtual

Get a basic description of the camera hw.

This is mainly used to determine the HW bus type in order to choose the corresponding interface for advanced controls.

Parameters
devicereturns an identifier for the bus
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 157 of file FrameGrabberCropper.cpp.

◆ getColorCodingDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getColorCodingDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 355 of file FrameGrabberCropper.cpp.

◆ getColorCodingMaskDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getColorCodingMaskDC1394 ( unsigned int  video_mode,
unsigned int &  val 
)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 346 of file FrameGrabberCropper.cpp.

◆ getFeature() [1/2]

yarp::dev::ReturnValue FrameGrabberCropper::getFeature ( yarp::dev::cameraFeature_id_t  feature,
double &  value 
)
overridevirtual

Get the current value for the requested feature.

Parameters
featurethe identifier of the feature to read
valuepointer to current value of the feature, from 0 to 1 expressed as a percentage
Returns
returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 180 of file FrameGrabberCropper.cpp.

◆ getFeature() [2/2]

yarp::dev::ReturnValue FrameGrabberCropper::getFeature ( yarp::dev::cameraFeature_id_t  feature,
double &  value1,
double &  value2 
)
overridevirtual

Get the current value for the requested feature.

Parameters
featurethe identifier of the feature to read
value1returns the current value of the feature, from 0 to 1 expressed as a percentage
value2returns the current value of the feature, from 0 to 1 expressed as a percentage
Returns
returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 196 of file FrameGrabberCropper.cpp.

◆ getFormat7MaxWindowDC1394()

ReturnValue FrameGrabberCropper::getFormat7MaxWindowDC1394 ( unsigned int &  xdim,
unsigned int &  ydim,
unsigned int &  xstep,
unsigned int &  ystep,
unsigned int &  xoffstep,
unsigned int &  yoffstep 
)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 372 of file FrameGrabberCropper.cpp.

◆ getFormat7WindowDC1394()

ReturnValue FrameGrabberCropper::getFormat7WindowDC1394 ( unsigned int &  xdim,
unsigned int &  ydim,
int &  x0,
int &  y0 
)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 385 of file FrameGrabberCropper.cpp.

◆ getFPSDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getFPSDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 311 of file FrameGrabberCropper.cpp.

◆ getFPSMaskDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getFPSMaskDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 302 of file FrameGrabberCropper.cpp.

◆ getISOSpeedDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getISOSpeedDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 329 of file FrameGrabberCropper.cpp.

◆ getLastInputStamp()

yarp::os::Stamp FrameGrabberCropper::getLastInputStamp ( )
inlineoverridevirtual

Return the time stamp relative to the last acquisition.

Implements yarp::dev::IPreciselyTimed.

Definition at line 166 of file FrameGrabberCropper.h.

◆ getMode()

yarp::dev::ReturnValue FrameGrabberCropper::getMode ( yarp::dev::cameraFeature_id_t  feature,
yarp::dev::FeatureMode &  mode 
)
overridevirtual

Get the current mode for the feature.

Parameters
featurethe identifier of the feature to change
hasAutoflag true if the feature is has 'auto' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 260 of file FrameGrabberCropper.cpp.

◆ getOperationModeDC1394()

ReturnValue FrameGrabberCropper::getOperationModeDC1394 ( bool &  b1394b)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 409 of file FrameGrabberCropper.cpp.

◆ getRgbFOV()

ReturnValue FrameGrabberCropper::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 113 of file FrameGrabberCropper.cpp.

◆ getRgbHeight()

int FrameGrabberCropper::getRgbHeight ( )
overridevirtual

Return the height of each frame.

Returns
rgb image height

Implements yarp::dev::IRgbVisualParams.

Definition at line 87 of file FrameGrabberCropper.cpp.

◆ getRgbIntrinsicParam()

ReturnValue FrameGrabberCropper::getRgbIntrinsicParam ( yarp::sig::IntrinsicParams &  intrinsic)
overridevirtual

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

Implements yarp::dev::IRgbVisualParams.

Definition at line 131 of file FrameGrabberCropper.cpp.

◆ getRgbMirroring()

ReturnValue FrameGrabberCropper::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 139 of file FrameGrabberCropper.cpp.

◆ getRgbResolution()

ReturnValue FrameGrabberCropper::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

Implements yarp::dev::IRgbVisualParams.

Definition at line 105 of file FrameGrabberCropper.cpp.

◆ getRgbSupportedConfigurations()

ReturnValue FrameGrabberCropper::getRgbSupportedConfigurations ( std::vector< yarp::dev::CameraConfig > &  configurations)
overridevirtual

Get the possible configurations of the camera.

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

Implements yarp::dev::IRgbVisualParams.

Definition at line 489 of file FrameGrabberCropper.cpp.

◆ getRgbWidth()

int FrameGrabberCropper::getRgbWidth ( )
overridevirtual

Return the width of each frame.

Returns
rgb image width

Implements yarp::dev::IRgbVisualParams.

Definition at line 92 of file FrameGrabberCropper.cpp.

◆ getTransmissionDC1394()

ReturnValue FrameGrabberCropper::getTransmissionDC1394 ( bool &  bTxON)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 425 of file FrameGrabberCropper.cpp.

◆ getVideoModeDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getVideoModeDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 285 of file FrameGrabberCropper.cpp.

◆ getVideoModeMaskDC1394()

yarp::dev::ReturnValue FrameGrabberCropper::getVideoModeMaskDC1394 ( unsigned int &  val)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 276 of file FrameGrabberCropper.cpp.

◆ hasAuto()

yarp::dev::ReturnValue FrameGrabberCropper::hasAuto ( yarp::dev::cameraFeature_id_t  feature,
bool &  hasAuto 
)
overridevirtual

Check if the requested feature has the 'auto' mode.

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'auto' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 228 of file FrameGrabberCropper.cpp.

◆ hasFeature()

yarp::dev::ReturnValue FrameGrabberCropper::hasFeature ( yarp::dev::cameraFeature_id_t  ,
bool &  hasFeature 
)
overridevirtual

Check if camera has the requested feature (saturation, brightness ... )

Parameters
featurethe identifier of the feature to check
hasFeatureflag value: true if the feature is present, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 165 of file FrameGrabberCropper.cpp.

◆ hasManual()

yarp::dev::ReturnValue FrameGrabberCropper::hasManual ( yarp::dev::cameraFeature_id_t  feature,
bool &  hasManual 
)
overridevirtual

Check if the requested feature has the 'manual' mode.

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'manual' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 236 of file FrameGrabberCropper.cpp.

◆ hasOnePush()

yarp::dev::ReturnValue FrameGrabberCropper::hasOnePush ( yarp::dev::cameraFeature_id_t  feature,
bool &  hasOnePush 
)
overridevirtual

Check if the requested feature has the 'onePush' mode.

Parameters
featurethe identifier of the feature to check
hasAutoflag true if the feature is has 'onePush' mode, false otherwise
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 244 of file FrameGrabberCropper.cpp.

◆ hasOnOff()

yarp::dev::ReturnValue FrameGrabberCropper::hasOnOff ( yarp::dev::cameraFeature_id_t  feature,
bool &  HasOnOff 
)
overridevirtual

Check if the camera has the ability to turn on/off the requested feature.

Parameters
featurethe identifier of the feature to change
hasOnOffflag true if this feature can be turned on/off, false otherwise.
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 204 of file FrameGrabberCropper.cpp.

◆ open()

bool FrameGrabberCropper::open ( yarp::os::Searchable &  config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 23 of file FrameGrabberCropper.cpp.

◆ operator=() [1/2]

FrameGrabberCropper & FrameGrabberCropper::operator= ( const FrameGrabberCropper &  )
delete

◆ operator=() [2/2]

FrameGrabberCropper & FrameGrabberCropper::operator= ( FrameGrabberCropper &&  )
delete

◆ setActive()

yarp::dev::ReturnValue FrameGrabberCropper::setActive ( yarp::dev::cameraFeature_id_t  feature,
bool  onoff 
)
overridevirtual

Set the requested feature on or off.

Parameters
featurethe identifier of the feature to change
onofftrue to activate, off to deactivate the feature
Returns
returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 212 of file FrameGrabberCropper.cpp.

◆ setBroadcastDC1394()

ReturnValue FrameGrabberCropper::setBroadcastDC1394 ( bool  onoff)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 433 of file FrameGrabberCropper.cpp.

◆ setBytesPerPacketDC1394()

ReturnValue FrameGrabberCropper::setBytesPerPacketDC1394 ( unsigned int  bpp)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 481 of file FrameGrabberCropper.cpp.

◆ setCaptureDC1394()

ReturnValue FrameGrabberCropper::setCaptureDC1394 ( bool  bON)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 465 of file FrameGrabberCropper.cpp.

◆ setColorCodingDC1394()

ReturnValue FrameGrabberCropper::setColorCodingDC1394 ( int  coding)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 364 of file FrameGrabberCropper.cpp.

◆ setDefaultsDC1394()

ReturnValue FrameGrabberCropper::setDefaultsDC1394 ( )
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 441 of file FrameGrabberCropper.cpp.

◆ setFeature() [1/2]

yarp::dev::ReturnValue FrameGrabberCropper::setFeature ( yarp::dev::cameraFeature_id_t  feature,
double  value 
)
overridevirtual

Set the requested feature to a value (saturation, brightness ... )

Parameters
featurethe identifier of the feature to change
valuenew value of the feature, range from 0 to 1 expressed as a percentage
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 173 of file FrameGrabberCropper.cpp.

◆ setFeature() [2/2]

yarp::dev::ReturnValue FrameGrabberCropper::setFeature ( yarp::dev::cameraFeature_id_t  feature,
double  value1,
double  value2 
)
overridevirtual

Set the requested feature to a value using 2 params (like white balance)

Parameters
featurethe identifier of the feature to change
value1first param, from 0 to 1 expressed as a percentage
value2second param, from 0 to 1 expressed as a percentage
Returns
returns true if success, false otherwise (e.g. the interface is not implemented)

Implements yarp::dev::IFrameGrabberControls.

Definition at line 188 of file FrameGrabberCropper.cpp.

◆ setFormat7WindowDC1394()

ReturnValue FrameGrabberCropper::setFormat7WindowDC1394 ( unsigned int  xdim,
unsigned int  ydim,
int  x0,
int  y0 
)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 393 of file FrameGrabberCropper.cpp.

◆ setFPSDC1394()

ReturnValue FrameGrabberCropper::setFPSDC1394 ( int  fps)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 320 of file FrameGrabberCropper.cpp.

◆ setISOSpeedDC1394()

ReturnValue FrameGrabberCropper::setISOSpeedDC1394 ( int  speed)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 338 of file FrameGrabberCropper.cpp.

◆ setMode()

yarp::dev::ReturnValue FrameGrabberCropper::setMode ( yarp::dev::cameraFeature_id_t  feature,
yarp::dev::FeatureMode  mode 
)
overridevirtual

Set the requested mode for the feature.

Parameters
featurethe identifier of the feature to change
auto_onofftrue to activate 'auto' mode, false to activate 'manual' mode
Returns
returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 252 of file FrameGrabberCropper.cpp.

◆ setOnePush()

yarp::dev::ReturnValue FrameGrabberCropper::setOnePush ( yarp::dev::cameraFeature_id_t  feature)
overridevirtual

Set the requested feature to a value (saturation, brightness ... )

Parameters
featurethe identifier of the feature to change
valuenew value of the feature, from 0 to 1 as a percentage of param range
Returns
returns true on success, false on failure.

Implements yarp::dev::IFrameGrabberControls.

Definition at line 268 of file FrameGrabberCropper.cpp.

◆ setOperationModeDC1394()

ReturnValue FrameGrabberCropper::setOperationModeDC1394 ( bool  b1394b)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 401 of file FrameGrabberCropper.cpp.

◆ setPowerDC1394()

ReturnValue FrameGrabberCropper::setPowerDC1394 ( bool  onoff)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 457 of file FrameGrabberCropper.cpp.

◆ setResetDC1394()

ReturnValue FrameGrabberCropper::setResetDC1394 ( )
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 449 of file FrameGrabberCropper.cpp.

◆ setRgbFOV()

ReturnValue FrameGrabberCropper::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 123 of file FrameGrabberCropper.cpp.

◆ setRgbMirroring()

ReturnValue FrameGrabberCropper::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 149 of file FrameGrabberCropper.cpp.

◆ setRgbResolution()

ReturnValue FrameGrabberCropper::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 97 of file FrameGrabberCropper.cpp.

◆ setTransmissionDC1394()

ReturnValue FrameGrabberCropper::setTransmissionDC1394 ( bool  bTxON)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 417 of file FrameGrabberCropper.cpp.

◆ setVideoModeDC1394()

ReturnValue FrameGrabberCropper::setVideoModeDC1394 ( int  video_mode)
overridevirtual

Implements yarp::dev::IFrameGrabberControlsDC1394.

Definition at line 294 of file FrameGrabberCropper.cpp.


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