Fawkes API  Fawkes Development Version
firevision::ColormapGenerator Class Referenceabstract

Interface for colormap generators. More...

#include <>>

Inheritance diagram for firevision::ColormapGenerator:

Public Member Functions

virtual ~ColormapGenerator ()
 Virtual empty destructor. More...
 
virtual void set_buffer (unsigned char *buffer, unsigned int width, unsigned int height)=0
 Set image buffer. More...
 
virtual YuvColormapget_current ()=0
 Get the current colormap. More...
 
virtual void consider ()=0
 Considers the given buffer and extracts the needed information. More...
 
virtual void calc ()=0
 Calculate LUT. More...
 
virtual void undo ()=0
 Undo last calls to consider(). More...
 
virtual void reset ()=0
 Reset the generator. More...
 
virtual void reset_undo ()=0
 Reset undo buffer. More...
 
virtual bool has_histograms ()=0
 Check if this generator has histograms. More...
 
virtual std::map< hint_t, Histogram * > * get_histograms ()=0
 Get histograms. More...
 

Detailed Description

Interface for colormap generators.

Definition at line 39 of file generator.h.

Constructor & Destructor Documentation

◆ ~ColormapGenerator()

firevision::ColormapGenerator::~ColormapGenerator ( )
virtual

Virtual empty destructor.

Definition at line 83 of file generator.cpp.

Member Function Documentation

◆ calc()

void firevision::ColormapGenerator::calc ( )
pure virtual

Calculate LUT.

Does the calculation of the lookup table without extracting any further information from the given buffer.

Implemented in firevision::BayesColormapGenerator.

◆ consider()

void firevision::ColormapGenerator::consider ( )
pure virtual

Considers the given buffer and extracts the needed information.

See also
set_buffer()

Implemented in firevision::BayesColormapGenerator.

◆ get_current()

Colormap * firevision::ColormapGenerator::get_current ( )
pure virtual

Get the current colormap.

With this method you can access the current LUT. This is useful to display the current results as "what would happen if we'd use this LUT?".

Returns
current colormap

Implemented in firevision::BayesColormapGenerator.

◆ get_histograms()

std::map< std::string, Histogram * > * firevision::ColormapGenerator::get_histograms ( )
pure virtual

Get histograms.

Returns
a map of histograms, if any.

Implemented in firevision::BayesColormapGenerator.

◆ has_histograms()

bool firevision::ColormapGenerator::has_histograms ( )
pure virtual

Check if this generator has histograms.

Returns
true, if this generator has histograms, false otherwise

Implemented in firevision::BayesColormapGenerator.

◆ reset()

void firevision::ColormapGenerator::reset ( void  )
pure virtual

Reset the generator.

This throws away all results accumulated up to now and starts from scratch with the generation process.

Implemented in firevision::BayesColormapGenerator.

◆ reset_undo()

void firevision::ColormapGenerator::reset_undo ( )
pure virtual

Reset undo buffer.

This throws away all undo information and starts a new undo buffer.

Implemented in firevision::BayesColormapGenerator.

◆ set_buffer()

void firevision::ColormapGenerator::set_buffer ( unsigned char *  buffer,
unsigned int  width,
unsigned int  height 
)
pure virtual

Set image buffer.

Set the image buffer that is to be considered next.

Parameters
bufferimage buffer (YUV422 planar format assumed)
widthwidth of image in pixels
heightheight of image in pixels

Implemented in firevision::BayesColormapGenerator.

◆ undo()

void firevision::ColormapGenerator::undo ( )
pure virtual

Undo last calls to consider().

This will eliminate all calls to consider() since the last call to resetUndo(), reset() or object generation.

Implemented in firevision::BayesColormapGenerator.


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