Fawkes API Fawkes Development Version
|
00001 00002 /************************************************************************** 00003 * lookuptable_generator.cpp - interface for generating arbitrary color 00004 * lookup tables 00005 * 00006 * Generated: Tue Mar 27 17:07:15 2006 00007 * Copyright 2005-2007 Tim Niemueller [www.niemueller.de] 00008 * 00009 ***************************************************************************/ 00010 00011 /* This program is free software; you can redistribute it and/or modify 00012 * it under the terms of the GNU General Public License as published by 00013 * the Free Software Foundation; either version 2 of the License, or 00014 * (at your option) any later version. A runtime exception applies to 00015 * this software (see LICENSE.GPL_WRE file mentioned below for details). 00016 * 00017 * This program is distributed in the hope that it will be useful, 00018 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00019 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00020 * GNU Library General Public License for more details. 00021 * 00022 * Read the full text in the LICENSE.GPL_WRE file in the doc directory. 00023 */ 00024 00025 #include <fvutils/colormap/generator.h> 00026 00027 namespace firevision { 00028 #if 0 /* just to make Emacs auto-indent happy */ 00029 } 00030 #endif 00031 00032 /** @class ColormapGenerator <fvutils/colormap/generator.h> 00033 * Interface for colormap generators. 00034 * 00035 * @fn void ColormapGenerator::set_buffer(unsigned char *buffer, unsigned int width, unsigned int height) 00036 * Set image buffer. 00037 * Set the image buffer that is to be considered next. 00038 * @param buffer image buffer (YUV422 planar format assumed) 00039 * @param width width of image in pixels 00040 * @param height height of image in pixels 00041 * 00042 * @fn Colormap * ColormapGenerator::get_current() 00043 * Get the current colormap. 00044 * With this method you can access the current LUT. This is useful to display the 00045 * current results as "what would happen if we'd use this LUT?". 00046 * @return current colormap 00047 * 00048 * @fn void ColormapGenerator::consider() 00049 * Considers the given buffer and extracts the needed information. 00050 * @see set_buffer() 00051 * 00052 * @fn void ColormapGenerator::calc() 00053 * Calculate LUT. 00054 * Does the calculation of the lookup table without extracting any further information 00055 * from the given buffer. 00056 * 00057 * @fn void ColormapGenerator::undo() 00058 * Undo last calls to consider(). 00059 * This will eliminate all calls to consider() since the last call to 00060 * resetUndo(), reset() or object generation. 00061 * 00062 * @fn void ColormapGenerator::reset() 00063 * Reset the generator. 00064 * This throws away all results accumulated up to now and starts from scratch 00065 * with the generation process. 00066 * 00067 * @fn void ColormapGenerator::reset_undo() 00068 * Reset undo buffer. 00069 * This throws away all undo information and starts a new undo buffer. 00070 * 00071 * @fn bool ColormapGenerator::has_histograms() 00072 * Check if this generator has histograms. 00073 * @return true, if this generator has histograms, false otherwise 00074 * 00075 * @fn std::map< std::string, Histogram *> * ColormapGenerator::get_histograms() 00076 * Get histograms. 00077 * @return a map of histograms, if any. 00078 * 00079 */ 00080 00081 00082 /** Virtual empty destructor. */ 00083 ColormapGenerator::~ColormapGenerator() 00084 { 00085 } 00086 00087 } // end namespace firevision