cvrSplitImage.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2005
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */



/**
 * \file   cvrSplitImage.h
 *         Definition of cvr::splitImage which is the base class of
 *         all functors that split an image into three different color
 *         channels of some color space.
 * \author Pablo Alvarado
 * \author Stefan Syberichs
 * \author Thomas Rusert
 * \date   19.04.1999
 *
 * $Id: cvrSplitImage.h,v 1.7 2006/06/07 13:02:42 doerfler Exp $
 */

#ifndef _CVR_SPLIT_IMAGE_H_
#define _CVR_SPLIT_IMAGE_H_

#include "cvrFunctor.h"
#include "cvrImage.h"
#include "cvrChannel.h"
#include "cvrChannel8.h"

namespace cvr {

  /**
   * Abstract parent class for all classes that split an image into
   * different color spaces components (color channels).
   *
   * @ingroup gColor
   */
  class splitImage : public functor {
  public:
    /**
     * default constructor
     */
    splitImage();

    /**
     * copy constructor
     */
    splitImage(const splitImage& other);

    /**
     * destructor
     */
    virtual ~splitImage();

    /**
     * returns a pointer to a clone of the functor.
     */
    virtual splitImage* clone() const = 0;

    /**
     * returns a pointer to a new instance of the functor.
     */
    virtual splitImage* newInstance() const = 0;

    /**
     * Copy data of "other" functor.
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    splitImage& copy(const splitImage& other);

    /**
     * Alias for copy member
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    splitImage& operator=(const splitImage& other);

    /**
     * Returns used parameters
     */
    const parameters& getParameters() const;

    /**
     * Splits the image \c img into three color channels \c c1, \c c2,
     * and \c c3
     */
    virtual bool apply(const matrix<image::value_type>& img,
                       matrix<channel::value_type>& c1,
                       matrix<channel::value_type>& c2,
                       matrix<channel::value_type>& c3) const = 0;
    /**
     * Splits the image \c img into three color channel8s \c c1, \c c2,
     * and \c c3
     */
    virtual bool apply(const matrix<image::value_type>& img,
                       matrix<channel8::value_type>& c1,
                       matrix<channel8::value_type>& c2,
                       matrix<channel8::value_type>& c3) const = 0;

    /**
     * Splits the rgbPixel \c pixel into three color values \c c1, \c c2,
     * and \c c3
     */
    virtual bool apply(const rgbaPixel& pixel,
                       float& c1,
                       float& c2,
                       float& c3) const = 0;

    /**
     * Splits the rgbPixel \c pixel into three color values \c c1, \c c2,
     * and \c c3
     */
    virtual bool apply(const rgbaPixel& pixel,
                       ubyte& c1,
                       ubyte& c2,
                       ubyte& c3) const = 0;

    /**
     * Returns the first of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c1 the extracted channel
     */
    virtual bool extractFirst(const matrix<image::value_type>& img,
                              matrix<channel::value_type>& c1) const;

    /**
     * Returns the first of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c1 the extracted channel
     */
    virtual bool extractFirst(const matrix<image::value_type>& img,
                              matrix<channel8::value_type>& c1) const;

    /**
     * Returns the second of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c2 the extracted channel
     */
    virtual bool extractSecond(const matrix<image::value_type>& img,
                               matrix<channel::value_type>& c2) const;

    /**
     * Returns the second of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c2 the extracted channel
     */
    virtual bool extractSecond(const matrix<image::value_type>& img,
                               matrix<channel8::value_type>& c2) const;

    /**
     * Returns the third of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c3 the extracted channel
     */
    virtual bool extractThird(const matrix<image::value_type>& img,
                              matrix<channel::value_type>& c3) const;

    /**
     * Returns the third of the three channels into which the image is split.
     * If you need only one channel, this might be faster than calling apply().
     * @param img the source image
     * @param c3 the extracted channel
     */
    virtual bool extractThird(const matrix<image::value_type>& img,
                              matrix<channel8::value_type>& c3) const;

  protected:

    /**
     * return the minimum of three values
     */
    template <typename T>
    inline T maximum(const T a, const T b, const T c) const;

    /**
     * return the maximum of three value
     */
    template <typename T>
    inline T minimum(const T a, const T b, const T c) const;

  };

} // namespace cvr

#include "cvrSplitImage_inline.h"

#endif