pcl::io::LZFDepth16ImageWriter Class Reference

PCL-LZF 16-bit depth image format writer. More...

#include <lzf_image_io.h>

Inheritance diagram for pcl::io::LZFDepth16ImageWriter:

List of all members.

Public Member Functions
	LZFDepth16ImageWriter ()
virtual bool	write (const char *data, uint32_t width, uint32_t height, const std::string &filename)
	Save a 16-bit depth image into PCL-LZF format.
virtual bool	writeParameters (const CameraParameters &parameters, const std::string &filename)
	Write camera parameters to disk.
virtual	~LZFDepth16ImageWriter ()
Protected Attributes
double	z_multiplication_factor_
	Z-value depth multiplication factor (i.e., if raw data is in [mm] and we want [m], we need to multiply with 0.001)

---

Detailed Description

PCL-LZF 16-bit depth image format writer.

The main advantage of using the PCL-LZF image I/O routines is a very good file size versus I/O speed ratio. Tests performed using LZF, Snappy, ZIP, GZ2, BZIP2, as well as PNG, JPEG, and TIFF compression have shown that the internal PCL LZF methods provide the best score for the types of applications PCL is suited for.

Author:

Radu B. Rusu

Definition at line 480 of file lzf_image_io.h.

---

Constructor & Destructor Documentation

pcl::io::LZFDepth16ImageWriter::LZFDepth16ImageWriter

(

)

[inline]

Empty constructor

Definition at line 484 of file lzf_image_io.h.

virtual pcl::io::LZFDepth16ImageWriter::~LZFDepth16ImageWriter

(

)

[inline, virtual]

Empty destructor

Definition at line 490 of file lzf_image_io.h.

---

Member Function Documentation

bool pcl::io::LZFDepth16ImageWriter::write	(	const char *	data,
		uint32_t	width,
		uint32_t	height,
		const std::string &	filename
	)		[virtual]

Save a 16-bit depth image into PCL-LZF format.

Parameters:

[in]	data	the array holding the depth image
[in]	width	the with of the data array
[in]	height	the height of the data array
[in]	filename	the file name to write (preferred extension: .pclzf)

Returns:

true if operation successful, false otherwise

Implements pcl::io::LZFImageWriter.

Definition at line 162 of file lzf_image_io.cpp.

bool pcl::io::LZFDepth16ImageWriter::writeParameters	(	const CameraParameters &	parameters,
		const std::string &	filename
	)		[virtual]

Write camera parameters to disk.

Parameters:

[in]	parameters	the camera parameters
[in]	filename	the file name to write

Returns:

true if operation successful, false otherwise This overwrites the following parameters in the xml file, under the <depth> tag: <focal_length_x>...</focal_length_x> <focal_length_y>...</focal_length_y> <principal_point_x>...</principal_point_x> <principal_point_y>...</principal_point_y> <z_multiplication_factor>...</z_multiplication_factor>

Implements pcl::io::LZFImageWriter.

Definition at line 210 of file lzf_image_io.cpp.

---

Member Data Documentation

double pcl::io::LZFDepth16ImageWriter::z_multiplication_factor_ [protected]

Z-value depth multiplication factor (i.e., if raw data is in [mm] and we want [m], we need to multiply with 0.001)

Definition at line 524 of file lzf_image_io.h.

---

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

• lzf_image_io.h
• lzf_image_io.cpp