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 #if 0 /* just to make Emacs auto-indent happy */
29 }
30 #endif
31 
32 /** @class ColormapGenerator <fvutils/colormap/generator.h>
33  * Interface for colormap generators.
34  *
35  * @fn void ColormapGenerator::set_buffer(unsigned char *buffer, unsigned int width, unsigned int height)
36  * Set image buffer.
37  * Set the image buffer that is to be considered next.
38  * @param buffer image buffer (YUV422 planar format assumed)
39  * @param width width of image in pixels
40  * @param height height of image in pixels
41  *
42  * @fn Colormap * ColormapGenerator::get_current()
43  * Get the current colormap.
44  * With this method you can access the current LUT. This is useful to display the
45  * current results as "what would happen if we'd use this LUT?".
46  * @return current colormap
47  *
48  * @fn void ColormapGenerator::consider()
49  * Considers the given buffer and extracts the needed information.
50  * @see set_buffer()
51  *
52  * @fn void ColormapGenerator::calc()
53  * Calculate LUT.
54  * Does the calculation of the lookup table without extracting any further information
55  * from the given buffer.
56  *
57  * @fn void ColormapGenerator::undo()
58  * Undo last calls to consider().
59  * This will eliminate all calls to consider() since the last call to
60  * resetUndo(), reset() or object generation.
61  *
62  * @fn void ColormapGenerator::reset()
63  * Reset the generator.
64  * This throws away all results accumulated up to now and starts from scratch
65  * with the generation process.
66  *
67  * @fn void ColormapGenerator::reset_undo()
68  * Reset undo buffer.
69  * This throws away all undo information and starts a new undo buffer.
70  *
71  * @fn bool ColormapGenerator::has_histograms()
72  * Check if this generator has histograms.
73  * @return true, if this generator has histograms, false otherwise
74  *
75  * @fn std::map< std::string, Histogram *> * ColormapGenerator::get_histograms()
76  * Get histograms.
77  * @return a map of histograms, if any.
78  *
79  */
80 
81 
82 /** Virtual empty destructor. */
84 {
85 }
86 
87 } // end namespace firevision
virtual ~ColormapGenerator()
Virtual empty destructor.
Definition: generator.cpp:83