Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions
firevision::ColorModelLookupTable Class Reference

Color model based on a lookup table. More...

#include <>>

Inheritance diagram for firevision::ColorModelLookupTable:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ColorModelLookupTable (YuvColormap *colormap)
 Create a lookup table with given dimensions not using shared memory.
 ColorModelLookupTable (const char *file)
 Create a lookup table, load contents from file.
 ColorModelLookupTable (const char *file, const char *lut_id, bool destroy_on_free=false)
 Create a lookup table using shared memory, load contents from file.
 ColorModelLookupTable (unsigned int depth, const char *lut_id, bool destroy_on_free)
 Create a lookup table with given dimensions using shared memory.
 ColorModelLookupTable (const char *lut_id, bool destroy_on_free)
 Create a lookup table with given dimensions using shared memory.
virtual ~ColorModelLookupTable ()
 Destructor.
virtual color_t determine (unsigned int y, unsigned int u, unsigned int v) const
 Determine classification of YUV pixel.
const char * get_name ()
 Get name of color model.
YuvColormap * get_colormap () const
 Get colormap.
void load (const char *filename)
 Load colormap from file.
void set_colormap (const YuvColormap &yuvcm)
 Set colormap.
void reset ()
 Reset colormap.
ColorModelLookupTable & operator+= (const ColorModelLookupTable &cmlt)
 Add colormaps.
- Public Member Functions inherited from firevision::ColorModel
virtual ~ColorModel ()
 Virtual empty destructor.
virtual void uv_to_image (unsigned char *yuv422_planar_buffer, unsigned int y)
 Create image from color model.

Static Public Member Functions

static std::string compose_filename (const std::string format)
 Compose filename.

Detailed Description

Color model based on a lookup table.

Very fast and easy implementation of a lookup table. It ignores the luminance and determines the classification just based on the U and V chrominance values. This model is very versatile as you can generate the lookuptable with many different methods.

Definition at line 37 of file lookuptable.h.

Constructor & Destructor Documentation

firevision::ColorModelLookupTable::ColorModelLookupTable ( YuvColormap *  colormap)

Create a lookup table with given dimensions not using shared memory.

Parameters:
colormapcolormap to use, the colormap is consumed, meaning that the color model takes ownership of the colormap and deletes it in its dtor.

Definition at line 64 of file lookuptable.cpp.

firevision::ColorModelLookupTable::ColorModelLookupTable ( const char *  file)

Create a lookup table, load contents from file.

Parameters:
filename of the file to load from

Definition at line 115 of file lookuptable.cpp.

References firevision::ColormapFile::get_colormap(), and firevision::FireVisionDataFile::read().

firevision::ColorModelLookupTable::ColorModelLookupTable ( const char *  file,
const char *  lut_id,
bool  destroy_on_free = false 
)

Create a lookup table using shared memory, load contents from file.

Parameters:
filename of the file to load from
lut_idID of the LUT in shared memory, use a constant from utils/shm_registry.h
destroy_on_freetrue to destroy lookup table in shmem on delete

Definition at line 96 of file lookuptable.cpp.

References firevision::ColormapFile::get_colormap(), and firevision::FireVisionDataFile::read().

firevision::ColorModelLookupTable::ColorModelLookupTable ( unsigned int  depth,
const char *  lut_id,
bool  destroy_on_free 
)

Create a lookup table with given dimensions using shared memory.

Parameters:
depthdepth of the lookup table
lut_idID of the LUT in shared memory
destroy_on_freetrue to destroy lookup table in shmem on delete

Definition at line 84 of file lookuptable.cpp.

firevision::ColorModelLookupTable::ColorModelLookupTable ( const char *  lut_id,
bool  destroy_on_free 
)

Create a lookup table with given dimensions using shared memory.

Parameters:
lut_idID of the LUT in shared memory
destroy_on_freetrue to destroy lookup table in shmem on delete

Definition at line 73 of file lookuptable.cpp.

firevision::ColorModelLookupTable::~ColorModelLookupTable ( )
virtual

Destructor.

Definition at line 129 of file lookuptable.cpp.

Member Function Documentation

std::string firevision::ColorModelLookupTable::compose_filename ( const std::string  format)
static

Compose filename.

Parameters:
formatformat string
Returns:
composed filename
See also:
ColormapFile::compose_filename()

Definition at line 207 of file lookuptable.cpp.

color_t firevision::ColorModelLookupTable::determine ( unsigned int  y,
unsigned int  u,
unsigned int  v 
) const
inlinevirtual

Determine classification of YUV pixel.

Given a pixel in the YUV colorspace the colormodel determines the color classification based on some a-priori knowledge.

Parameters:
yY value
uU value
vV value
Returns:
color classification

Implements firevision::ColorModel.

Definition at line 69 of file lookuptable.h.

References firevision::YuvColormap::determine().

YuvColormap * firevision::ColorModelLookupTable::get_colormap ( ) const

Get colormap.

Returns:
a pointer to the YUV colormap used internally.

Definition at line 145 of file lookuptable.cpp.

Referenced by FvRetrieverThread::init().

const char * firevision::ColorModelLookupTable::get_name ( )
virtual

Get name of color model.

Returns:
name of color model.
Author:
Tim Niemueller

Implements firevision::ColorModel.

Definition at line 136 of file lookuptable.cpp.

void firevision::ColorModelLookupTable::load ( const char *  filename)

Load colormap from file.

Parameters:
filenamename of colormap file

Definition at line 166 of file lookuptable.cpp.

References firevision::ColormapFile::get_colormap(), and firevision::FireVisionDataFile::read().

ColorModelLookupTable & firevision::ColorModelLookupTable::operator+= ( const ColorModelLookupTable &  cmlt)

Add colormaps.

This adds the colormap of the given lookuptable color model to internals colormap.

Parameters:
cmltlookup table color model to copy data from
Returns:
this

Definition at line 187 of file lookuptable.cpp.

void firevision::ColorModelLookupTable::reset ( )

Reset colormap.

Definition at line 196 of file lookuptable.cpp.

References reset().

Referenced by reset().

void firevision::ColorModelLookupTable::set_colormap ( const YuvColormap &  yuvcm)

Set colormap.

Parameters:
yuvcmcolormap to assign. The content of the colormap is copied into the internal one.

Definition at line 156 of file lookuptable.cpp.

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