cvrMergeYIQToImage.h

Go to the documentation of this file.

/*
 * Copyright (C) 1999
 * 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   cvrMergeYIQToImage.h
 *         Merge YIQ channels into a color image
 * \author Pablo Alvarado
 * \author Stefan Syberichs
 * \author Thomas Rusert
 * \date   19.04.1999
 *
 * $Id: cvrMergeYIQToImage.h,v 1.1 2007/04/05 22:56:36 alvarado Exp $
 */


#ifndef _CVR_MERGE_YIQ_TO_IMAGE_H_
#define _CVR_MERGE_YIQ_TO_IMAGE_H_

#include "cvrMergeImage.h"

namespace cvr {

  /**
   * Merge YIQ channels (Luminance, Inphase, Quadrature)
   *
   * This is an almost forgotten color space, as the standards use now
   * the YCbCr, YPbPr or YUV spaces.
   *
   * @see cvr::mergeYUVToImage, cvr::mergeYCbCrToImage, cvr::mergeYPbPrToImage
   * @see cvr::splitImageToYIQ
   *
   * @ingroup gColor
   */
  class mergeYIQToImage : public mergeImage  {
  public:

    /**
     * returns the name of this type
     */
    const std::string& name() const;

    /**
     * returns a poinbter to a clone of the functor
     */
    virtual mergeYIQToImage* clone() const;

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

    /**
     * merge the Y,I,Q channel to an image
     * YIQ merging requires unnormalized channels !
     * @param Y the perceived luminance
     * @param I color information and some luminance
     * @param Q color information and some luminance
     * @param img the merged image
     */
    virtual bool apply(const matrix<float>& Y,
                       const matrix<float>& I,
                       const matrix<float>& Q,
                       image& img) const;

    /**
     * merge the Y,I,Q channel to an image
     * YIQ merging requires unnormalized channels !
     * @param Y the perceived luminance
     * @param I color information and some luminance
     * @param Q color information and some luminance
     * @param img the merged image
     */
    virtual bool apply(const matrix<ubyte>& Y,
                       const matrix<ubyte>& I,
                       const matrix<ubyte>& Q,
                       image& img) const;

    /**
     * merge the Y,I,Q values to a pixel
     * YIQ merging requires unnormalized values !
     * @param Y the perceived luminance
     * @param I color information and some luminance
     * @param Q color information and some luminance
     * @param pixel the merged pixel
     */
    virtual bool apply(const float& Y,
                       const float& I,
                       const float& Q,
                       rgbaPixel& pixel) const;

    /**
     * merge the Y,I,Q values to a pixel
     * YIQ merging requires unnormalized values !
     * @param Y the perceived luminance
     * @param I color information and some luminance
     * @param Q color information and some luminance
     * @param pixel the merged pixel
     */
    virtual bool apply(const ubyte& Y,
                       const ubyte& I,
                       const ubyte& Q,
                       rgbaPixel& pixel) const;
  };
}

#endif