cvrSplitImageTorgI.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998-2006
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 * Electronics Engineering School, ITCR, Costa Rica
 *
 *
 * 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   cvrSplitImageTorgI.h
 *         Contains the functor splitImageTorgI which splits images into
 *         chromaticity and intensity channels.
 * \author Pablo Alvarado
 * \author Stefan Syberichs
 * \author Thomas Rusert
 * \date   19.04.1999 (CVR-Lib 1)
 * \date   11.01.2006 (CVR-Lib )
 *
 * $Id: cvrSplitImageTorgI.h,v 1.1 2006/01/11 20:07:01 alvarado Exp $
 */

#ifndef _CVR_SPLIT_IMAGE_TO_RGI_H_
#define _CVR_SPLIT_IMAGE_TO_RGI_H_

#include "cvrSplitImage.h"

namespace cvr {

  /**
   * Split image in its chromaticity channels.
   *
   * The chromaticity channels are defined as follows:
   * - intensity channel \f$ I = \frac{R+G+B}{3} \f$
   * - chromacity red    \f$ r = \frac{R}{R+G+B} \f$
   * - chromacity green  \f$ g = \frac{G}{R+G+B} \f$
   *
   * You can get all channels at the same time using apply() or just
   * get one using the shortcut methods getR(), getG() or getIntensity().
   *
   * @ingroup gColor
   */
  class splitImageTorgI : public splitImage {
  public:
    /**
     * Constructor
     */
    splitImageTorgI();

    /**
     * Copy Constructor
     */
    splitImageTorgI(const splitImageTorgI& other);

    /**
     * Destructor
     */
    virtual ~splitImageTorgI();

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

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

    /**
     * Returns the name of this class
     */
    virtual const std::string& name() const;

    /**
     * Returns a pointer to a clone of the functor.
     */
    virtual splitImageTorgI* clone() const;

    /**
     * Returns a pointer to a new instance of the functor.
     */
    virtual splitImageTorgI* newInstance() const;

    /**
     * Split the image in chromacity channels r and g and intensity channel.
     * The values of each pixel will be between 0.0f and 1.0f
     * @param img the image to be splitted
     * @param r the chromacity channel
     * @param g the chromacity channel
     * @param I the intensity channel
     */
    virtual bool apply(const matrix<image::value_type>& img,
                       matrix<channel::value_type>& r,
                       matrix<channel::value_type>& g,
                       matrix<channel::value_type>& I) const;

    /**
     * Split the image in chromacity channels r and g and intensity channel.
     * The values of each pixel will be between 0 and 255
     * @param img the image to be splitted
     * @param r the chromacity channel
     * @param g the chromacity channel
     * @param I the intensity channel
     */
    virtual bool apply(const matrix<image::value_type>& img,
                       matrix<channel8::value_type>& r,
                       matrix<channel8::value_type>& g,
                       matrix<channel8::value_type>& I) const;

    /**
     * Split the pixel in chromacity values r and g and intensity value.
     * The values of each pixel will be between 0.0f and 1.0f
     * @param pixel the pixel to be splitted
     * @param r the chromacity value
     * @param g the chromacity value
     * @param I the intensity value
     */
    virtual bool apply(const rgbaPixel& pixel,
                       float& r,
                       float& g,
                       float& I) const;

    /**
     * Split the pixel in chromacity values r and g and intensity value.
     * The values of each pixel will be between 0 and 255
     * @param pixel the pixel to be splitted
     * @param r the chromacity value
     * @param g the chromacity value
     * @param I the intensity value
     */
    virtual bool apply(const rgbaPixel& pixel,
                       ubyte& r,
                       ubyte& g,
                       ubyte& I) const;

    /**
     * Shortcut to get the red channel only.
     * The values of each pixel will be between 0.0f and 1.0f
     * @param img the image to be splitted
     * @param r the chromacity red channel
     */
    bool getR(const matrix<image::value_type>& img,
              matrix<channel::value_type>& r) const;


    /**
     * Shortcut to get the red channel only.
     * The values of each pixel will be between 0 and 255
     * @param img the image to be splitted
     * @param r the chromacity red channel
     */
    bool getR(const matrix<image::value_type>& img,
              matrix<channel8::value_type>& r) const;

    /**
     * Shortcut to get the red channel only.
     * The values of each pixel will be between 0.0f and 1.0f
     * @param img the image to be splitted
     * @param g the chromacity green channel
     */
    bool getG(const matrix<image::value_type>& img,
              matrix<channel::value_type>& g) const;

    /**
     * Shortcut to get the green channel only.
     * The values of each pixel will be between 0 and 255
     * @param img the image to be splitted
     * @param g the chromacity green channel
     */
    bool getG(const matrix<image::value_type>& img,
              matrix<channel8::value_type>& g) const;

    /**
     * Shortcut to get the red channel only.
     * The values of each pixel will be between 0.0f and 1.0f
     * @param img the image to be splitted
     * @param I the intensity channel
     */
    bool getIntensity(const matrix<image::value_type>& img,
                      matrix<channel::value_type>& I) const;


    /**
     * Shortcut to get the red channel only.
     * The values of each pixel will be between 0 and 255
     * @param img the image to be splitted
     * @param I the intensity channel
     */
    bool getIntensity(const matrix<image::value_type>& img,
                      matrix<channel8::value_type>& I) 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 getFirst(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 getFirst(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 getSecond(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 getSecond(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 getThird(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 getThird(const matrix<image::value_type>& img,
                                matrix<channel8::value_type>& c3) const;

  };

} // namespace cvr
#endif