Image Component Library (ICL)
Public Member Functions | List of all members
icl::io::ImageOutput Struct Referenceabstract

Minimal interface for image output classes. More...

#include <ImageOutput.h>

Inheritance diagram for icl::io::ImageOutput:
icl::io::ImageCompressor icl::utils::Uncopyable icl::io::FileWriter icl::io::GenericImageOutput icl::io::LibAVVideoWriter icl::io::OpenCVVideoWriter icl::io::RSBImageOutput icl::io::SharedMemoryPublisher icl::io::V4L2LoopBackOutput icl::io::ZmqImageOutput

Public Member Functions

virtual ~ImageOutput ()
 virtual destructor More...
 
virtual void send (const core::ImgBase *image)=0
 ImageOutput instances must implement this method. More...
 
virtual CompressionSpec getCompression () const
 provide the protectedly inherited image compressor options here More...
 
virtual void setCompression (const CompressionSpec &spec)
 provide the protectedly inherited image compressor options here More...
 

Additional Inherited Members

- Protected Member Functions inherited from icl::io::ImageCompressor
Header uncompressHeader (const icl8u *compressedData, int len)
 only decodes an image header More...
 
Header createHeader (const core::ImgBase *image, bool skipMetaData)
 creates a header for a given image (not data will be null) More...
 
 ImageCompressor (const CompressionSpec &spec=CompressionSpec("none"))
 Creates an image Compressor with given compression mode. More...
 
 ~ImageCompressor ()
 Destructor. More...
 
virtual void setCompression (const CompressionSpec &spec)
 string based interface for setting the compression mode More...
 
virtual CompressionSpec getCompression () const
 can be implemented for returning the current compression mode More...
 
utils::Time pickTimeStamp (const icl8u *compressedData)
 this can help to find out wheter the data is new and must be encoded More...
 
const CompressedData compress (const core::ImgBase *image, bool skipMetaData=false)
 encodes a given image into the compressed code More...
 
const core::ImgBaseuncompress (const icl8u *compressedData, int len, core::ImgBase **dst=0)
 decodes the given byte segment More...
 
- Protected Member Functions inherited from icl::utils::Uncopyable
 Uncopyable ()
 Empty base constructor. More...
 

Detailed Description

Minimal interface for image output classes.

The image output is used as generic interface for image sinks. Usually, it is recommended to use the GenericImageOutput class tha provides a string-based interface to set up the output backend.

Compression

A few outputs do also support generic image compression, while other implementation provide output dependend compression parameters. E.g. shared memory or RSB-based network output streams use the inherited ImageCompressor to compress sent data. The file- our video image output of course use the used video/file formats compression mechanism.

Constructor & Destructor Documentation

◆ ~ImageOutput()

virtual icl::io::ImageOutput::~ImageOutput ( )
inlinevirtual

virtual destructor

Member Function Documentation

◆ getCompression()

virtual CompressionSpec icl::io::ImageCompressor::getCompression

provide the protectedly inherited image compressor options here

◆ send()

virtual void icl::io::ImageOutput::send ( const core::ImgBase image)
pure virtual

◆ setCompression()

virtual void icl::io::ImageCompressor::setCompression

provide the protectedly inherited image compressor options here


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