Functions
	BOOST_PYTHON_MODULE (camera_calibration_parsers_wrapper)

bool	parseCalibration (const std::string &buffer, const std::string &format, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Parse calibration parameters from a string in memory. More...

bool	parseCalibrationIni (const std::string &buffer, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Parse calibration parameters from a string in memory of INI format. More...

bool	readCalibration (const std::string &file_name, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Read calibration parameters from a file. More...

def	readCalibration (file_name)

bool	readCalibrationIni (const std::string &file_name, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Read calibration parameters from an INI file. More...

bool	readCalibrationIni (std::istream &in, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Read calibration parameters from an INI file. More...

boost::python::tuple	readCalibrationWrapper (const std::string &file_name)

bool	readCalibrationYml (const std::string &file_name, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Read calibration parameters from a YAML file. More...

bool	readCalibrationYml (std::istream &in, std::string &camera_name, sensor_msgs::CameraInfo &cam_info)
	Read calibration parameters from a YAML file. More...

template<typename M >
std::string	to_python (const M &msg)

bool	writeCalibration (const std::string &file_name, const std::string &camera_name, const sensor_msgs::CameraInfo &cam_info)
	Write calibration parameters to a file. More...

bool	writeCalibrationIni (const std::string &file_name, const std::string &camera_name, const sensor_msgs::CameraInfo &cam_info)
	Write calibration parameters to a file in INI format. More...

bool	writeCalibrationIni (std::ostream &out, const std::string &camera_name, const sensor_msgs::CameraInfo &cam_info)
	Write calibration parameters to a file in INI format. More...

bool	writeCalibrationYml (const std::string &file_name, const std::string &camera_name, const sensor_msgs::CameraInfo &cam_info)
	Write calibration parameters to a file in YAML format. More...

bool	writeCalibrationYml (std::ostream &out, const std::string &camera_name, const sensor_msgs::CameraInfo &cam_info)
	Write calibration parameters to a file in YAML format. More...

Detailed Description

Todo:: : use stream-based API, so no read/parse distinction

Function Documentation

◆ BOOST_PYTHON_MODULE()

camera_calibration_parsers::BOOST_PYTHON_MODULE ( camera_calibration_parsers_wrapper )

Definition at line 102 of file parse_wrapper.cpp.

◆ parseCalibration()

bool camera_calibration_parsers::parseCalibration	(	const std::string &	buffer,
		const std::string &	format,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Parse calibration parameters from a string in memory.

Parameters

	buffer	Calibration string
	format	Format of calibration string, "yml" or "ini"
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 97 of file parse.cpp.

◆ parseCalibrationIni()

bool camera_calibration_parsers::parseCalibrationIni	(	const std::string &	buffer,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Parse calibration parameters from a string in memory of INI format.

Parameters

	buffer	Calibration string
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 274 of file parse_ini.cpp.

◆ readCalibration() [1/2]

bool camera_calibration_parsers::readCalibration	(	const std::string &	file_name,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Read calibration parameters from a file.

The file may be YAML or INI format.

Parameters

	file_name	File to read
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 86 of file parse.cpp.

◆ readCalibration() [2/2]

def camera_calibration_parsers.readCalibration ( file_name )

Read .ini or .yaml calibration file and return (camera name and cameraInfo message).

@param file_name: camera calibration file name
@type file_name: str
@return: (camera name, cameraInfo message) or None on Error
@rtype: tuple(str, sensor_msgs.msg.CameraInfo | None

Definition at line 4 of file __init__.py.

◆ readCalibrationIni() [1/2]

bool camera_calibration_parsers::readCalibrationIni	(	const std::string &	file_name,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Read calibration parameters from an INI file.

Parameters

	file_name	File to read
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 259 of file parse_ini.cpp.

◆ readCalibrationIni() [2/2]

bool camera_calibration_parsers::readCalibrationIni	(	std::istream &	in,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Read calibration parameters from an INI file.

Parameters

	in	Input stream to read from
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 253 of file parse_ini.cpp.

◆ readCalibrationWrapper()

boost::python::tuple camera_calibration_parsers::readCalibrationWrapper ( const std::string & file_name )

Definition at line 89 of file parse_wrapper.cpp.

◆ readCalibrationYml() [1/2]

bool camera_calibration_parsers::readCalibrationYml	(	const std::string &	file_name,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Read calibration parameters from a YAML file.

Parameters

	file_name	File to read
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 296 of file parse_yml.cpp.

◆ readCalibrationYml() [2/2]

bool camera_calibration_parsers::readCalibrationYml	(	std::istream &	in,
		std::string &	camera_name,
		sensor_msgs::CameraInfo &	cam_info
	)

Read calibration parameters from a YAML file.

Parameters

	in	Input stream to read from
[out]	camera_name	Name of the camera
[out]	cam_info	Camera parameters

Definition at line 212 of file parse_yml.cpp.

◆ to_python()

template<typename M >

std::string camera_calibration_parsers::to_python ( const M & msg )

Definition at line 73 of file parse_wrapper.cpp.

◆ writeCalibration()

bool camera_calibration_parsers::writeCalibration	(	const std::string &	file_name,
		const std::string &	camera_name,
		const sensor_msgs::CameraInfo &	cam_info
	)

Write calibration parameters to a file.

The file name extension (.yml, .yaml, or .ini) determines the output format.

Parameters

file_name	File to write
camera_name	Name of the camera
cam_info	Camera parameters

Definition at line 75 of file parse.cpp.

◆ writeCalibrationIni() [1/2]

bool camera_calibration_parsers::writeCalibrationIni	(	const std::string &	file_name,
		const std::string &	camera_name,
		const sensor_msgs::CameraInfo &	cam_info
	)

Write calibration parameters to a file in INI format.

Parameters

file_name	File to write
camera_name	Name of the camera
cam_info	Camera parameters

Definition at line 145 of file parse_ini.cpp.

◆ writeCalibrationIni() [2/2]

bool camera_calibration_parsers::writeCalibrationIni	(	std::ostream &	out,
		const std::string &	camera_name,
		const sensor_msgs::CameraInfo &	cam_info
	)

Write calibration parameters to a file in INI format.

Parameters

out	Output stream to write to
camera_name	Name of the camera
cam_info	Camera parameters

Todo:: time?

Todo:: time?

Definition at line 113 of file parse_ini.cpp.

◆ writeCalibrationYml() [1/2]

bool camera_calibration_parsers::writeCalibrationYml	(	const std::string &	file_name,
		const std::string &	camera_name,
		const sensor_msgs::CameraInfo &	cam_info
	)

Write calibration parameters to a file in YAML format.

Parameters

file_name	File to write
camera_name	Name of the camera
cam_info	Camera parameters

Definition at line 195 of file parse_yml.cpp.

◆ writeCalibrationYml() [2/2]

bool camera_calibration_parsers::writeCalibrationYml	(	std::ostream &	out,
		const std::string &	camera_name,
		const sensor_msgs::CameraInfo &	cam_info
	)

Write calibration parameters to a file in YAML format.

Parameters

out	Output stream to write to
camera_name	Name of the camera
cam_info	Camera parameters

Definition at line 147 of file parse_yml.cpp.

Functions

Detailed Description

Function Documentation

◆ BOOST_PYTHON_MODULE()

◆ parseCalibration()

◆ parseCalibrationIni()

◆ readCalibration() [1/2]

◆ readCalibration() [2/2]

◆ readCalibrationIni() [1/2]

◆ readCalibrationIni() [2/2]

◆ readCalibrationWrapper()

◆ readCalibrationYml() [1/2]

◆ readCalibrationYml() [2/2]

◆ to_python()

◆ writeCalibration()

◆ writeCalibrationIni() [1/2]

◆ writeCalibrationIni() [2/2]

◆ writeCalibrationYml() [1/2]

◆ writeCalibrationYml() [2/2]