FakeFrameGrabber_ParamsParser Class Reference

This class is the parameters parser for class FakeFrameGrabber. More...

#include <fake/fakeFrameGrabber/FakeFrameGrabber_ParamsParser.h>

Inheritance diagram for FakeFrameGrabber_ParamsParser:

Classes
struct	parser_version_type

Public Member Functions
	FakeFrameGrabber_ParamsParser ()
	~FakeFrameGrabber_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.
Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Public Attributes
const std::string	m_device_classname = {"FakeFrameGrabber"}
const std::string	m_device_name = {"fakeFrameGrabber"}
bool	m_parser_is_strict = false
const parser_version_type	m_parser_version = {}
const std::string	m_width_defaultValue = {"320"}
const std::string	m_height_defaultValue = {"240"}
const std::string	m_horizontalFov_defaultValue = {"1.0"}
const std::string	m_verticalFov_defaultValue = {"2.0"}
const std::string	m_fakeFrameGrabber_rpc_port_defaultValue = {"/fakeFrameGrabber/rpc"}
const std::string	m_mirror_defaultValue = {"false"}
const std::string	m_syncro_defaultValue = {"false"}
const std::string	m_topIsLow_defaultValue = {"true"}
const std::string	m_physFocalLength_defaultValue = {"3.0"}
const std::string	m_focalLengthX_defaultValue = {"4.0"}
const std::string	m_focalLengthY_defaultValue = {"5.0"}
const std::string	m_principalPointX_defaultValue = {"6.0"}
const std::string	m_principalPointY_defaultValue = {"7.0"}
const std::string	m_distortionModel_defaultValue = {"FishEye"}
const std::string	m_k1_defaultValue = {"8.0"}
const std::string	m_k2_defaultValue = {"9.0"}
const std::string	m_k3_defaultValue = {"10.0"}
const std::string	m_t1_defaultValue = {"11.0"}
const std::string	m_t2_defaultValue = {"12.0"}
const std::string	m_freq_defaultValue = {"0"}
const std::string	m_period_defaultValue = {"0"}
const std::string	m_mode_defaultValue = {"[line]"}
const std::string	m_src_defaultValue = {""}
const std::string	m_add_timestamp_defaultValue = {"false"}
const std::string	m_add_noise_defaultValue = {"false"}
const std::string	m_bayer_defaultValue = {"false"}
const std::string	m_mono_defaultValue = {"false"}
const std::string	m_snr_defaultValue = {"0.5"}
const std::string	m_rectificationMatrix_defaultValue = {"(1.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0)"}
int	m_width = {320}
int	m_height = {240}
double	m_horizontalFov = {1.0}
double	m_verticalFov = {2.0}
std::string	m_fakeFrameGrabber_rpc_port = {"/fakeFrameGrabber/rpc"}
bool	m_mirror = {false}
bool	m_syncro = {false}
bool	m_topIsLow = {true}
double	m_physFocalLength = {3.0}
double	m_focalLengthX = {4.0}
double	m_focalLengthY = {5.0}
double	m_principalPointX = {6.0}
double	m_principalPointY = {7.0}
std::string	m_distortionModel = {"FishEye"}
double	m_k1 = {8.0}
double	m_k2 = {9.0}
double	m_k3 = {10.0}
double	m_t1 = {11.0}
double	m_t2 = {12.0}
double	m_freq = {0}
double	m_period = {0}
std::string	m_mode = {"[line]"}
std::string	m_src = {}
bool	m_add_timestamp = {false}
bool	m_add_noise = {false}
bool	m_bayer = {false}
bool	m_mono = {false}
double	m_snr = {0.5}
std::vector< double >	m_rectificationMatrix = { }

Detailed Description

This class is the parameters parser for class FakeFrameGrabber.

These are the used parameters:

Group name	Parameter name	Type	Units	Default Value	Required	Description	Notes
-	width	int	-	320	0	desired width of test image	-
-	height	int	-	240	0	desired height of test image	-
-	horizontalFov	double	-	1.0	0	desired horizontal fov of test image	-
-	verticalFov	double	-	2.0	0	desired horizontal fov of test image	-
-	fakeFrameGrabber_rpc_port	string	-	/fakeFrameGrabber/rpc	0	rpc port for the fakeFrameGrabber	-
-	mirror	bool	-	false	0	mirror height of test image	-
-	syncro	bool	-	false	0	synchronize producer and consumer, so that all images are used once and only once	-
-	topIsLow	bool	-	true	0	explicitly set the topIsLow field in the images	-
-	physFocalLength	double	-	3.0	0	Physical focal length	-
-	focalLengthX	double	-	4.0	0	Horizontal component of the focal length	-
-	focalLengthY	double	-	5.0	0	Vertical component of the focal length	-
-	principalPointX	double	-	6.0	0	X coordinate of the principal point	-
-	principalPointY	double	-	7.0	0	Y coordinate of the principal point	-
-	distortionModel	string	-	FishEye	0	Reference to group of parameters describing the distortion model of the camera	-
-	k1	double	-	8.0	0	Radial distortion coefficient of the lens(fake	-
-	k2	double	-	9.0	0	Radial distortion coefficient of the lens(fake)	-
-	k3	double	-	10.0	0	Radial distortion coefficient of the lens(fake)	-
-	t1	double	-	11.0	0	Tangential distortion of the lens(fake)	-
-	t2	double	-	12.0	0	Tangential distortion of the lens(fake)	-
-	freq	double	-	0	0	rate of test images in Hz	-
-	period	double	-	0	0	period of test images in seconds	-
-	mode	string	-	[line]	0	bouncy [ball], scrolly [line], grid [grid], grid multisize [size], random [rand], none [none], time test[time]	-
-	src	string	-	-	0	background image to use, if any	e.g. test.ppm
-	add_timestamp	bool	-	false	0	should write the timestamp in the first bytes of the image	-
-	add_noise	bool	-	false	0	should add noise to the image (uses snr parameter)	-
-	bayer	bool	-	false	0	should emit bayer test image	-
-	mono	bool	-	false	0	should emit a monochrome image	-
-	snr	double	-	0.5	0	Signal noise ratio ([0.0-1.0]	-
-	rectificationMatrix	vector<double>	-	(1.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0)	0	Matrix that describes the lens' distortion	-

The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):

yarpdev --device fakeFrameGrabber --width 320 --height 240 --horizontalFov 1.0 --verticalFov 2.0 --fakeFrameGrabber_rpc_port /fakeFrameGrabber/rpc --mirror false --syncro false --topIsLow true --physFocalLength 3.0 --focalLengthX 4.0 --focalLengthY 5.0 --principalPointX 6.0 --principalPointY 7.0 --distortionModel FishEye --k1 8.0 --k2 9.0 --k3 10.0 --t1 11.0 --t2 12.0 --freq 0 --period 0 --mode [line] --src <optional_value> --add_timestamp false --add_noise false --bayer false --mono false --snr 0.5 --rectificationMatrix \" (1.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0) \"

yarpdev --device fakeFrameGrabber

Definition at line 69 of file FakeFrameGrabber_ParamsParser.h.

Constructor & Destructor Documentation

FakeFrameGrabber_ParamsParser()

FakeFrameGrabber_ParamsParser::FakeFrameGrabber_ParamsParser

(

)

Definition at line 23 of file FakeFrameGrabber_ParamsParser.cpp.

~FakeFrameGrabber_ParamsParser()

FakeFrameGrabber_ParamsParser::~FakeFrameGrabber_ParamsParser ( )

overridedefault

Member Function Documentation

getDeviceClassName()

std::string FakeFrameGrabber_ParamsParser::getDeviceClassName ( ) const

inlineoverridevirtual

Get the name of the DeviceDriver class.

Returns

A string containing the name of the class.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 147 of file FakeFrameGrabber_ParamsParser.h.

getDeviceName()

std::string FakeFrameGrabber_ParamsParser::getDeviceName ( ) const

inlineoverridevirtual

Get the name of the device (i.e.

the plugin name).

Returns

A string containing the name of the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 148 of file FakeFrameGrabber_ParamsParser.h.

getDocumentationOfDeviceParams()

std::string FakeFrameGrabber_ParamsParser::getDocumentationOfDeviceParams ( ) const

overridevirtual

Get the documentation of the DeviceDriver's parameters.

Returns

A string containing the documentation.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 543 of file FakeFrameGrabber_ParamsParser.cpp.

getListOfParams()

std::vector< std::string > FakeFrameGrabber_ParamsParser::getListOfParams ( ) const

overridevirtual

Return a list of all params used by the device.

Returns

A vector containing the names of parameters used by the device.

Implements yarp::dev::IDeviceDriverParams.

Definition at line 47 of file FakeFrameGrabber_ParamsParser.cpp.

parseParams()

bool FakeFrameGrabber_ParamsParser::parseParams ( const yarp::os::Searchable &  config )

overridevirtual

Parse the DeviceDriver parameters.

Returns

true if the parsing is successful, false otherwise

Implements yarp::dev::IDeviceDriverParams.

Definition at line 83 of file FakeFrameGrabber_ParamsParser.cpp.

Member Data Documentation

m_add_noise

bool FakeFrameGrabber_ParamsParser::m_add_noise = {false}

Definition at line 140 of file FakeFrameGrabber_ParamsParser.h.

m_add_noise_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_add_noise_defaultValue = {"false"}

Definition at line 110 of file FakeFrameGrabber_ParamsParser.h.

m_add_timestamp

bool FakeFrameGrabber_ParamsParser::m_add_timestamp = {false}

Definition at line 139 of file FakeFrameGrabber_ParamsParser.h.

m_add_timestamp_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_add_timestamp_defaultValue = {"false"}

Definition at line 109 of file FakeFrameGrabber_ParamsParser.h.

m_bayer

bool FakeFrameGrabber_ParamsParser::m_bayer = {false}

Definition at line 141 of file FakeFrameGrabber_ParamsParser.h.

m_bayer_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_bayer_defaultValue = {"false"}

Definition at line 111 of file FakeFrameGrabber_ParamsParser.h.

m_device_classname

const std::string FakeFrameGrabber_ParamsParser::m_device_classname = {"FakeFrameGrabber"}

Definition at line 76 of file FakeFrameGrabber_ParamsParser.h.

m_device_name

const std::string FakeFrameGrabber_ParamsParser::m_device_name = {"fakeFrameGrabber"}

Definition at line 77 of file FakeFrameGrabber_ParamsParser.h.

m_distortionModel

std::string FakeFrameGrabber_ParamsParser::m_distortionModel = {"FishEye"}

Definition at line 129 of file FakeFrameGrabber_ParamsParser.h.

m_distortionModel_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_distortionModel_defaultValue = {"FishEye"}

Definition at line 99 of file FakeFrameGrabber_ParamsParser.h.

m_fakeFrameGrabber_rpc_port

std::string FakeFrameGrabber_ParamsParser::m_fakeFrameGrabber_rpc_port = {"/fakeFrameGrabber/rpc"}

Definition at line 120 of file FakeFrameGrabber_ParamsParser.h.

m_fakeFrameGrabber_rpc_port_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_fakeFrameGrabber_rpc_port_defaultValue = {"/fakeFrameGrabber/rpc"}

Definition at line 90 of file FakeFrameGrabber_ParamsParser.h.

m_focalLengthX

double FakeFrameGrabber_ParamsParser::m_focalLengthX = {4.0}

Definition at line 125 of file FakeFrameGrabber_ParamsParser.h.

m_focalLengthX_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_focalLengthX_defaultValue = {"4.0"}

Definition at line 95 of file FakeFrameGrabber_ParamsParser.h.

m_focalLengthY

double FakeFrameGrabber_ParamsParser::m_focalLengthY = {5.0}

Definition at line 126 of file FakeFrameGrabber_ParamsParser.h.

m_focalLengthY_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_focalLengthY_defaultValue = {"5.0"}

Definition at line 96 of file FakeFrameGrabber_ParamsParser.h.

m_freq

double FakeFrameGrabber_ParamsParser::m_freq = {0}

Definition at line 135 of file FakeFrameGrabber_ParamsParser.h.

m_freq_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_freq_defaultValue = {"0"}

Definition at line 105 of file FakeFrameGrabber_ParamsParser.h.

m_height

int FakeFrameGrabber_ParamsParser::m_height = {240}

Definition at line 117 of file FakeFrameGrabber_ParamsParser.h.

m_height_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_height_defaultValue = {"240"}

Definition at line 87 of file FakeFrameGrabber_ParamsParser.h.

m_horizontalFov

double FakeFrameGrabber_ParamsParser::m_horizontalFov = {1.0}

Definition at line 118 of file FakeFrameGrabber_ParamsParser.h.

m_horizontalFov_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_horizontalFov_defaultValue = {"1.0"}

Definition at line 88 of file FakeFrameGrabber_ParamsParser.h.

m_k1

double FakeFrameGrabber_ParamsParser::m_k1 = {8.0}

Definition at line 130 of file FakeFrameGrabber_ParamsParser.h.

m_k1_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_k1_defaultValue = {"8.0"}

Definition at line 100 of file FakeFrameGrabber_ParamsParser.h.

m_k2

double FakeFrameGrabber_ParamsParser::m_k2 = {9.0}

Definition at line 131 of file FakeFrameGrabber_ParamsParser.h.

m_k2_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_k2_defaultValue = {"9.0"}

Definition at line 101 of file FakeFrameGrabber_ParamsParser.h.

m_k3

double FakeFrameGrabber_ParamsParser::m_k3 = {10.0}

Definition at line 132 of file FakeFrameGrabber_ParamsParser.h.

m_k3_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_k3_defaultValue = {"10.0"}

Definition at line 102 of file FakeFrameGrabber_ParamsParser.h.

m_mirror

bool FakeFrameGrabber_ParamsParser::m_mirror = {false}

Definition at line 121 of file FakeFrameGrabber_ParamsParser.h.

m_mirror_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_mirror_defaultValue = {"false"}

Definition at line 91 of file FakeFrameGrabber_ParamsParser.h.

m_mode

std::string FakeFrameGrabber_ParamsParser::m_mode = {"[line]"}

Definition at line 137 of file FakeFrameGrabber_ParamsParser.h.

m_mode_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_mode_defaultValue = {"[line]"}

Definition at line 107 of file FakeFrameGrabber_ParamsParser.h.

m_mono

bool FakeFrameGrabber_ParamsParser::m_mono = {false}

Definition at line 142 of file FakeFrameGrabber_ParamsParser.h.

m_mono_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_mono_defaultValue = {"false"}

Definition at line 112 of file FakeFrameGrabber_ParamsParser.h.

m_parser_is_strict

bool FakeFrameGrabber_ParamsParser::m_parser_is_strict = false

Definition at line 78 of file FakeFrameGrabber_ParamsParser.h.

m_parser_version

const parser_version_type FakeFrameGrabber_ParamsParser::m_parser_version = {}

Definition at line 84 of file FakeFrameGrabber_ParamsParser.h.

m_period

double FakeFrameGrabber_ParamsParser::m_period = {0}

Definition at line 136 of file FakeFrameGrabber_ParamsParser.h.

m_period_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_period_defaultValue = {"0"}

Definition at line 106 of file FakeFrameGrabber_ParamsParser.h.

m_physFocalLength

double FakeFrameGrabber_ParamsParser::m_physFocalLength = {3.0}

Definition at line 124 of file FakeFrameGrabber_ParamsParser.h.

m_physFocalLength_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_physFocalLength_defaultValue = {"3.0"}

Definition at line 94 of file FakeFrameGrabber_ParamsParser.h.

m_principalPointX

double FakeFrameGrabber_ParamsParser::m_principalPointX = {6.0}

Definition at line 127 of file FakeFrameGrabber_ParamsParser.h.

m_principalPointX_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_principalPointX_defaultValue = {"6.0"}

Definition at line 97 of file FakeFrameGrabber_ParamsParser.h.

m_principalPointY

double FakeFrameGrabber_ParamsParser::m_principalPointY = {7.0}

Definition at line 128 of file FakeFrameGrabber_ParamsParser.h.

m_principalPointY_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_principalPointY_defaultValue = {"7.0"}

Definition at line 98 of file FakeFrameGrabber_ParamsParser.h.

m_rectificationMatrix

std::vector<double> FakeFrameGrabber_ParamsParser::m_rectificationMatrix = { }

Definition at line 144 of file FakeFrameGrabber_ParamsParser.h.

m_rectificationMatrix_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_rectificationMatrix_defaultValue = {"(1.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0)"}

Definition at line 114 of file FakeFrameGrabber_ParamsParser.h.

m_snr

double FakeFrameGrabber_ParamsParser::m_snr = {0.5}

Definition at line 143 of file FakeFrameGrabber_ParamsParser.h.

m_snr_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_snr_defaultValue = {"0.5"}

Definition at line 113 of file FakeFrameGrabber_ParamsParser.h.

m_src

std::string FakeFrameGrabber_ParamsParser::m_src = {}

Definition at line 138 of file FakeFrameGrabber_ParamsParser.h.

m_src_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_src_defaultValue = {""}

Definition at line 108 of file FakeFrameGrabber_ParamsParser.h.

m_syncro

bool FakeFrameGrabber_ParamsParser::m_syncro = {false}

Definition at line 122 of file FakeFrameGrabber_ParamsParser.h.

m_syncro_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_syncro_defaultValue = {"false"}

Definition at line 92 of file FakeFrameGrabber_ParamsParser.h.

m_t1

double FakeFrameGrabber_ParamsParser::m_t1 = {11.0}

Definition at line 133 of file FakeFrameGrabber_ParamsParser.h.

m_t1_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_t1_defaultValue = {"11.0"}

Definition at line 103 of file FakeFrameGrabber_ParamsParser.h.

m_t2

double FakeFrameGrabber_ParamsParser::m_t2 = {12.0}

Definition at line 134 of file FakeFrameGrabber_ParamsParser.h.

m_t2_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_t2_defaultValue = {"12.0"}

Definition at line 104 of file FakeFrameGrabber_ParamsParser.h.

m_topIsLow

bool FakeFrameGrabber_ParamsParser::m_topIsLow = {true}

Definition at line 123 of file FakeFrameGrabber_ParamsParser.h.

m_topIsLow_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_topIsLow_defaultValue = {"true"}

Definition at line 93 of file FakeFrameGrabber_ParamsParser.h.

m_verticalFov

double FakeFrameGrabber_ParamsParser::m_verticalFov = {2.0}

Definition at line 119 of file FakeFrameGrabber_ParamsParser.h.

m_verticalFov_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_verticalFov_defaultValue = {"2.0"}

Definition at line 89 of file FakeFrameGrabber_ParamsParser.h.

m_width

int FakeFrameGrabber_ParamsParser::m_width = {320}

Definition at line 116 of file FakeFrameGrabber_ParamsParser.h.

m_width_defaultValue

const std::string FakeFrameGrabber_ParamsParser::m_width_defaultValue = {"320"}

Definition at line 86 of file FakeFrameGrabber_ParamsParser.h.

---

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

• src/devices/fake/fakeFrameGrabber/FakeFrameGrabber_ParamsParser.h
• src/devices/fake/fakeFrameGrabber/FakeFrameGrabber_ParamsParser.cpp