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 /** @class ColormapGenerator <fvutils/colormap/generator.h>
00028  * Interface for colormap generators.
00029  *
00030  * @fn void ColormapGenerator::set_buffer(unsigned char *buffer, unsigned int width, unsigned int height)
00031  * Set image buffer.
00032  * Set the image buffer that is to be considered next.
00033  * @param buffer image buffer (YUV422 planar format assumed)
00034  * @param width width of image in pixels
00035  * @param height height of image in pixels
00036  *
00037  * @fn Colormap *  ColormapGenerator::get_current()
00038  * Get the current colormap.
00039  * With this method you can access the current LUT. This is useful to display the
00040  * current results as "what would happen if we'd use this LUT?".
00041  * @return current colormap
00042  *
00043  * @fn void ColormapGenerator::consider()
00044  * Considers the given buffer and extracts the needed information.
00045  * @see set_buffer()
00046  *
00047  * @fn void ColormapGenerator::calc()
00048  * Calculate LUT.
00049  * Does the calculation of the lookup table without extracting any further information
00050  * from the given buffer.
00051  *
00052  * @fn void ColormapGenerator::undo()
00053  * Undo last calls to consider().
00054  * This will eliminate all calls to consider() since the last call to
00055  * resetUndo(), reset() or object generation.
00056  *
00057  * @fn void ColormapGenerator::reset()
00058  * Reset the generator.
00059  * This throws away all results accumulated up to now and starts from scratch
00060  * with the generation process.
00061  *
00062  * @fn void ColormapGenerator::reset_undo()
00063  * Reset undo buffer.
00064  * This throws away all undo information and starts a new undo buffer.
00065  *
00066  * @fn bool ColormapGenerator::has_histograms()
00067  * Check if this generator has histograms.
00068  * @return true, if this generator has histograms, false otherwise
00069  * 
00070  * @fn std::map< std::string, Histogram *> *  ColormapGenerator::get_histograms()
00071  * Get histograms.
00072  * @return a map of histograms, if any.
00073  *
00074  */
00075
00076 
00077 /** Virtual empty destructor. */
00078 ColormapGenerator::~ColormapGenerator()
00079 {
00080 }