Point Cloud Library (PCL)  1.14.1-dev
List of all members | Public Member Functions
pcl::io::LZFRGB24ImageWriter Class Reference

PCL-LZF 24-bit RGB image format writer. More...

#include <pcl/io/lzf_image_io.h>

+ Inheritance diagram for pcl::io::LZFRGB24ImageWriter:
+ Collaboration diagram for pcl::io::LZFRGB24ImageWriter:

Public Member Functions

 LZFRGB24ImageWriter ()=default
 Empty constructor. More...
 
 ~LZFRGB24ImageWriter () override=default
 Empty destructor. More...
 
bool write (const char *data, std::uint32_t width, std::uint32_t height, const std::string &filename) override
 Save a 24-bit RGB image into PCL-LZF format. More...
 
bool writeParameters (const CameraParameters &parameters, const std::string &filename) override
 Write camera parameters to disk. More...
 
- Public Member Functions inherited from pcl::io::LZFImageWriter
 LZFImageWriter ()=default
 Empty constructor. More...
 
virtual ~LZFImageWriter ()=default
 Empty destructor. More...
 
virtual bool write (const char *data, std::uint32_t width, std::uint32_t height, const CameraParameters &parameters, const std::string &filename_data, const std::string &filename_xml)
 Save an image and its camera parameters into PCL-LZF format. More...
 
bool writeParameter (const double &parameter, const std::string &tag, const std::string &filename)
 Write a single image/camera parameter to file, given an XML tag. More...
 

Additional Inherited Members

- Protected Member Functions inherited from pcl::io::LZFImageWriter
bool saveImageBlob (const char *data, std::size_t data_size, const std::string &filename)
 Save a compressed image array to disk. More...
 
std::uint32_t compress (const char *input, std::uint32_t input_size, std::uint32_t width, std::uint32_t height, const std::string &image_type, char *output)
 Realtime LZF compression. More...
 

Detailed Description

PCL-LZF 24-bit RGB 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 531 of file lzf_image_io.h.

Constructor & Destructor Documentation

◆ LZFRGB24ImageWriter()

pcl::io::LZFRGB24ImageWriter::LZFRGB24ImageWriter ( )
default

Empty constructor.

◆ ~LZFRGB24ImageWriter()

pcl::io::LZFRGB24ImageWriter::~LZFRGB24ImageWriter ( )
overridedefault

Empty destructor.

Member Function Documentation

◆ write()

bool pcl::io::LZFRGB24ImageWriter::write ( const char *  data,
std::uint32_t  width,
std::uint32_t  height,
const std::string &  filename 
)
overridevirtual

Save a 24-bit RGB image into PCL-LZF format.

Parameters
[in]datathe array holding the RGB image (as [RGB..RGB] or [BGR..BGR])
[in]widththe with of the data array
[in]heightthe height of the data array
[in]filenamethe file name to write (preferred extension: .pclzf)
Returns
true if operation successful, false otherwise

Implements pcl::io::LZFImageWriter.

Reimplemented in pcl::io::LZFBayer8ImageWriter, and pcl::io::LZFYUV422ImageWriter.

◆ writeParameters()

bool pcl::io::LZFRGB24ImageWriter::writeParameters ( const CameraParameters parameters,
const std::string &  filename 
)
overridevirtual

Write camera parameters to disk.

Parameters
[in]parametersthe camera parameters
[in]filenamethe file name to write
Returns
true if operation successful, false otherwise

Implements pcl::io::LZFImageWriter.


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