Fawkes API
Fawkes Development Version
generator.cpp
1
2
/**************************************************************************
3
* lookuptable_generator.cpp - interface for generating arbitrary color
4
* lookup tables
5
*
6
* Generated: Tue Mar 27 17:07:15 2006
7
* Copyright 2005-2007 Tim Niemueller [www.niemueller.de]
8
*
9
***************************************************************************/
10
11
/* This program is free software; you can redistribute it and/or modify
12
* it under the terms of the GNU General Public License as published by
13
* the Free Software Foundation; either version 2 of the License, or
14
* (at your option) any later version. A runtime exception applies to
15
* this software (see LICENSE.GPL_WRE file mentioned below for details).
16
*
17
* This program is distributed in the hope that it will be useful,
18
* but WITHOUT ANY WARRANTY; without even the implied warranty of
19
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20
* GNU Library General Public License for more details.
21
*
22
* Read the full text in the LICENSE.GPL_WRE file in the doc directory.
23
*/
24
25
#include <fvutils/colormap/generator.h>
26
27
namespace
firevision {
28
29
/** @class ColormapGenerator <fvutils/colormap/generator.h>
30
* Interface for colormap generators.
31
*
32
* @fn void ColormapGenerator::set_buffer(unsigned char *buffer, unsigned int width, unsigned int height)
33
* Set image buffer.
34
* Set the image buffer that is to be considered next.
35
* @param buffer image buffer (YUV422 planar format assumed)
36
* @param width width of image in pixels
37
* @param height height of image in pixels
38
*
39
* @fn Colormap * ColormapGenerator::get_current()
40
* Get the current colormap.
41
* With this method you can access the current LUT. This is useful to display the
42
* current results as "what would happen if we'd use this LUT?".
43
* @return current colormap
44
*
45
* @fn void ColormapGenerator::consider()
46
* Considers the given buffer and extracts the needed information.
47
* @see set_buffer()
48
*
49
* @fn void ColormapGenerator::calc()
50
* Calculate LUT.
51
* Does the calculation of the lookup table without extracting any further information
52
* from the given buffer.
53
*
54
* @fn void ColormapGenerator::undo()
55
* Undo last calls to consider().
56
* This will eliminate all calls to consider() since the last call to
57
* resetUndo(), reset() or object generation.
58
*
59
* @fn void ColormapGenerator::reset()
60
* Reset the generator.
61
* This throws away all results accumulated up to now and starts from scratch
62
* with the generation process.
63
*
64
* @fn void ColormapGenerator::reset_undo()
65
* Reset undo buffer.
66
* This throws away all undo information and starts a new undo buffer.
67
*
68
* @fn bool ColormapGenerator::has_histograms()
69
* Check if this generator has histograms.
70
* @return true, if this generator has histograms, false otherwise
71
*
72
* @fn std::map< std::string, Histogram *> * ColormapGenerator::get_histograms()
73
* Get histograms.
74
* @return a map of histograms, if any.
75
*
76
*/
77
78
/** Virtual empty destructor. */
79
ColormapGenerator::~ColormapGenerator
()
80
{
81
}
82
83
}
// end namespace firevision
firevision::ColormapGenerator::~ColormapGenerator
virtual ~ColormapGenerator()
Virtual empty destructor.
Definition:
generator.cpp:79
src
libs
fvutils
colormap
generator.cpp
Generated by
1.8.15