IccMatrixMath.h

Go to the documentation of this file.

/** @file
    File:       IccCmm.h
 
    Contains:   Header file for implementation of the CIccCmm class.
 
    Version:    V1
 
    Copyright:  (c) see ICC Software License
*/
 
/*
 * The ICC Software License, Version 0.2
 *
 *
 * Copyright (c) 2003-2012 The International Color Consortium. 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. In the absence of prior written permission, the names "ICC" and "The
 *    International Color Consortium" must not be used to imply that the
 *    ICC organization endorses or promotes products derived from this
 *    software.
 *
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 INTERNATIONAL COLOR CONSORTIUM OR
 * ITS CONTRIBUTING MEMBERS 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the The International Color Consortium. 
 *
 *
 * Membership in the ICC is encouraged when this software is used for
 * commercial purposes. 
 *
 *  
 * For more information on The International Color Consortium, please
 * see <http://www.color.org/>.
 *  
 * 
 */
 
////////////////////////////////////////////////////////////////////// 
// HISTORY:
//
// -Initial implementation by Max Derhak 5-15-2003
// -Added support for Monochrome ICC profile apply by Rohit Patil 12-03-2008
// -Integrate changes for PCS adjustment by George Pawle 12-09-2008
//
//////////////////////////////////////////////////////////////////////
 
#if !defined(_ICCMATRIXMATH_H)
#define _ICCMATRIXMATH_H
 
#include "IccProfile.h"
 
#ifdef USEREFICCMAXNAMESPACE
namespace refIccMAX {
#endif
 
#define icNearRange 0.000001
#define ICCMTXSTEPDUMPFMT " %.8f"
 
/**
**************************************************************************
* Type: Class
* 
* Purpose: 
*  Object for performing matrix/vector math
**************************************************************************
*/
class ICCPROFLIB_API CIccMatrixMath
{
public:
  CIccMatrixMath(icUInt16Number nRows, icUInt16Number nCols, bool bInitIdentity=false);
  CIccMatrixMath(const CIccMatrixMath &mat);
  virtual ~CIccMatrixMath();
 
  virtual void VectorMult(icFloatNumber *pDst, const icFloatNumber *pSrc) const;
  virtual icUInt16Number GetCols() const { return m_nCols; }
  virtual icUInt16Number GetRows() const { return m_nRows; }
 
  CIccMatrixMath *Mult(const CIccMatrixMath *matrix) const;
 
  icFloatNumber RowSum(icUInt16Number nRow) const;
 
  void VectorScale(const icFloatNumber *vec);
  void Scale(icFloatNumber v);
 
  icFloatNumber *entry(icUInt16Number nRow, icUInt16Number nCol=0) { return &m_vals[(int)nRow*m_nCols + nCol]; }
  const icFloatNumber *entry(icUInt16Number nRow, icUInt16Number nCol=0) const { return &m_vals[(int)nRow*m_nCols + nCol]; }
 
  virtual bool isIdentityMtx() const;
 
  virtual void dumpMtx(std::string &str) const;
 
  bool Invert();
 
  bool SetRange(const icSpectralRange &from, const icSpectralRange &to);
 
  static CIccMatrixMath* rangeMap(const icSpectralRange &from, const icSpectralRange &to);  //Caller is responsible for deleting returned matrix
 
protected:
  icUInt16Number m_nRows, m_nCols;
  icFloatNumber *m_vals;
};
 
#ifdef USEREFICCMAXNAMESPACE
}
#endif
 
 
#endif //_ICCMATRIXMATH_H