CIccTagParametricCurve Class Reference

Class: CIccTagParametricCurve. More...

#include <IccTagLut.h>

Inheritance diagram for CIccTagParametricCurve:

Collaboration diagram for CIccTagParametricCurve:

Public Member Functions
virtual icFloatNumber	Apply (icFloatNumber v) const
	Name: CIccTagParametricCurve::Apply.
	CIccTagParametricCurve ()
	Name: CIccTagParametricCurve::CIccTagParametricCurve.
	CIccTagParametricCurve (const CIccTagParametricCurve &ITPC)
	Name: CIccTagParametricCurve::CIccTagParametricCurve.
virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagParametricCurve::Describe.
virtual void	DumpLut (std::string &sDescription, const icChar *szName, icColorSpaceSignature csSig, int nIndex, int nVerboseness)
	Name: CIccTagParametricCurve::DumpLut.
virtual const icChar *	GetClassName () const
icUInt16Number	GetFunctionType () const
icUInt16Number	GetNumParam () const
icFloatNumber *	GetParams () const
virtual icTagTypeSignature	GetType () const
	Function: GetType()
virtual bool	IsIdentity ()
	Name: CIccTagParametricCurve::IsIdentity.
virtual CIccTag *	NewCopy () const
	Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.
CIccTagParametricCurve &	operator= (const CIccTagParametricCurve &ParamCurveTag)
	Name: CIccTagParametricCurve::operator=.
icFloatNumber &	operator[] (int index)
icFloatNumber	Param (int index) const
virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagParametricCurve::Read.
bool	SetFunctionType (icUInt16Number nFunctionType)
	Name: CIccTagParametricCurve::SetFunctionType.
virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagParametricCurve::Validate.
virtual bool	Write (CIccIO *pIO)
	Name: CIccTagParametricCurve::Write.
virtual	~CIccTagParametricCurve ()
	Name: CIccTagParametricCurve::~CIccTagParametricCurve.
Public Member Functions inherited from CIccCurve
virtual void	Begin ()
	CIccCurve ()
icFloatNumber	Find (icFloatNumber v)
virtual	~CIccCurve ()
Public Member Functions inherited from CIccTag
	CIccTag ()
	Name: CIccTag::CIccTag.
virtual void	DetachIO ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual IIccExtensionTag *	GetExtension ()
virtual icArraySignature	GetTagArrayType () const
virtual icStructSignature	GetTagStructType () const
virtual bool	IsArrayType ()
virtual bool	IsMBBType ()
virtual bool	IsNumArrayType () const
virtual bool	IsSupported ()
	Function: IsSupported(size, pIO) - Check if tag fully supported for apply purposes.
virtual bool	Read (icUInt32Number size, CIccIO *pIO, CIccProfile *pProfile)
	Function: Read(size, pIO) - Read tag from file.
virtual bool	ReadAll ()
	Function: ReadAll() - Read All sub data for tag from file.
virtual	~CIccTag ()
	Name: CIccTag::CIccTag.

Public Attributes
icUInt16Number	m_nReserved2
Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Protected Attributes
icFloatNumber *	m_dParam
icUInt16Number	m_nFunctionType
icUInt16Number	m_nNumParam

Additional Inherited Members
Static Public Member Functions inherited from CIccTag
static CIccTag *	Create (icTagTypeSignature sig)
	Name: CIccTag::Create.
Protected Member Functions inherited from CIccCurve
icFloatNumber	Find (icFloatNumber v, icFloatNumber p0, icFloatNumber v0, icFloatNumber p1, icFloatNumber v1)
	Name: CIccCurve::Find.

Detailed Description

Class: CIccTagParametricCurve.

Purpose: The parametric curve type tag

Definition at line 170 of file IccTagLut.h.

Constructor & Destructor Documentation

CIccTagParametricCurve() [1/2]

CIccTagParametricCurve::CIccTagParametricCurve

(

)

Name: CIccTagParametricCurve::CIccTagParametricCurve.

Purpose: Constructor

Definition at line 646 of file IccTagLut.cpp.

{
  m_nFunctionType = 0xffff;
  m_nNumParam = 0;
  m_dParam = NULL;
  m_nReserved2 = 0;
}

CIccTagParametricCurve() [2/2]

CIccTagParametricCurve::CIccTagParametricCurve

(

const CIccTagParametricCurve &

ITPC

)

Name: CIccTagParametricCurve::CIccTagParametricCurve.

Purpose: Copy Constructor

Args: ITPC = The CIccTagParametricCurve object to be copied

Definition at line 665 of file IccTagLut.cpp.

{
  m_nFunctionType = ITPC.m_nFunctionType;
  m_nNumParam = ITPC.m_nNumParam;
  m_nReserved2 = 0;
 
  m_dParam = new icFloatNumber[m_nNumParam];
  memcpy(m_dParam, ITPC.m_dParam, m_nNumParam*sizeof(icFloatNumber));  
}

References m_dParam, m_nFunctionType, and m_nNumParam.

~CIccTagParametricCurve()

CIccTagParametricCurve::~CIccTagParametricCurve ( )

virtual

Name: CIccTagParametricCurve::~CIccTagParametricCurve.

Purpose: Destructor

Definition at line 711 of file IccTagLut.cpp.

{
  if (m_dParam)
    delete [] m_dParam;
}

Member Function Documentation

Apply()

icFloatNumber CIccTagParametricCurve::Apply ( icFloatNumber X ) const

virtual

Name: CIccTagParametricCurve::Apply.

Purpose: Applies the curve to the value passed.

Args: x = value to be passed through the curve.

Return: The value modified by the curve.

Reimplemented from CIccCurve.

Definition at line 1024 of file IccTagLut.cpp.

{
  double a, b;
 
  switch(m_nFunctionType) {
    case 0x0000:
      return (icFloatNumber)pow(X, m_dParam[0]);
 
    case 0x0001:
      a=m_dParam[1];
      b=m_dParam[2];
 
      if (X >= -b/a) {
        return (icFloatNumber)pow((double)a*X + b, (double)m_dParam[0]);
      }
      else {
        return 0;
      }
 
    case 0x0002:
      a=m_dParam[1];
      b=m_dParam[2];
 
      if (X >= -b/a) {
        return (icFloatNumber)pow((double)a*X + b, (double)m_dParam[0]) + m_dParam[3];
      }
      else {
        return m_dParam[3];
      }
 
    case 0x0003:
      if (X >= m_dParam[4]) {
        return (icFloatNumber)pow((double)m_dParam[1]*X + m_dParam[2], (double)m_dParam[0]);
      }
      else {
        return m_dParam[3]*X;
      }
 
    case 0x0004:
      if (X >= m_dParam[4]) {
        return (icFloatNumber)pow((double)m_dParam[1]*X + m_dParam[2], (double)m_dParam[0]) + m_dParam[5];
      }
      else {
        return m_dParam[3]*X + m_dParam[6];
      }
 
    default:
      return X;
  }
}

Describe()

void CIccTagParametricCurve::Describe ( std::string & sDescription, int nVerboseness )

virtual

Name: CIccTagParametricCurve::Describe.

Purpose: Dump data associated with the tag to a string

Args: sDescription - string to concatenate tag dump to

Reimplemented from CIccTag.

Definition at line 833 of file IccTagLut.cpp.

{
  icChar buf[128];
 
  sprintf(buf, "FunctionType: %04Xh\n", m_nFunctionType);
  sDescription += buf;
 
  switch(m_nFunctionType) {
case 0x0000:
  sprintf(buf, "Y = X ^ %.4lf\n", m_dParam[0]);
  sDescription += buf;
  return;
 
case 0x0001:
  sprintf(buf, "Y = 0 when (X < %.4lf / %.4lf)\n",
    -m_dParam[2], m_dParam[1]);
  sDescription += buf;
 
  sprintf(buf, "Y = (%.4lf * X + %.4lf) ^ %.4lf   when (X >= %.4lf / %.4lf)\n",
    m_dParam[1], m_dParam[2], m_dParam[0],
    m_dParam[2], m_dParam[1]);
  sDescription += buf;
  return;
 
case 0x0002:
  sprintf(buf, "Y = %.4lf   when (X < %.4lf / %.4lf)\n", m_dParam[3],
    -m_dParam[2], m_dParam[1]);
  sDescription += buf;
 
  sprintf(buf, "Y = (%.4lf * X + %.4lf) ^ %.4lf + %.4lf   when (X >= %.4lf / %.4lf)\n",
    m_dParam[1], m_dParam[2], m_dParam[0],
    m_dParam[3],
    -m_dParam[2], m_dParam[1]);
  sDescription += buf;
  return;
 
case 0x0003:
  sprintf(buf, "Y = %lf * X   when (X < %.4lf)\n",
    m_dParam[3], m_dParam[4]);
  sDescription += buf;
 
  sprintf(buf, "Y = (%.4lf * X + %.4lf) ^ %.4lf   when (X >= %.4lf)\n",
    m_dParam[1], m_dParam[2], m_dParam[0],
    m_dParam[4]);
  sDescription += buf;
  return;
 
case 0x0004:
  sprintf(buf, "Y = %lf * X + %.4lf  when (X < %.4lf)\n",
    m_dParam[3], m_dParam[6], m_dParam[4]);
  sDescription += buf;
 
  sprintf(buf, "Y = (%.4lf * X + %.4lf) ^ %.4lf + %.4lf  when (X >= %.4lf)\n",
    m_dParam[1], m_dParam[2], m_dParam[0],
    m_dParam[5], m_dParam[4]);
  sDescription += buf;
  return;
 
default:
  int i;
  sprintf(buf, "Unknown Function with %d parameters:\n", m_nNumParam);
  sDescription += buf;
 
  for (i=0; i<m_nNumParam; i++) {
    sprintf(buf, "Param[%d] = %.4lf\n", i, m_dParam[i]);
    sDescription += buf;
  }
  }
}

DumpLut()

void CIccTagParametricCurve::DumpLut ( std::string & sDescription, const icChar * szName, icColorSpaceSignature csSig, int nIndex, int nVerboseness )

virtual

Name: CIccTagParametricCurve::DumpLut.

Purpose: Dump data associated with the tag to a string. Basically has the same function as Describe()

Args: sDescription = string to concatenate tag dump to, szName = name of the curve to be printed, csSig = color space signature of the curve data, nIndex = the channel number of color space

Reimplemented from CIccCurve.

Definition at line 917 of file IccTagLut.cpp.

{
  icChar buf[128];
 
  sprintf(buf, "BEGIN_CURVE %s\n", szName);
  sDescription += buf;
  Describe(sDescription, nVerboseness);
}

References szName.

GetClassName()

virtual const icChar * CIccTagParametricCurve::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlParametricCurve.

Definition at line 180 of file IccTagLut.h.

{ return "CIccTagParametricCurve"; }

GetFunctionType()

icUInt16Number CIccTagParametricCurve::GetFunctionType ( ) const

inline

Definition at line 191 of file IccTagLut.h.

{return m_nFunctionType; }

GetNumParam()

icUInt16Number CIccTagParametricCurve::GetNumParam ( ) const

inline

Definition at line 193 of file IccTagLut.h.

{ return m_nNumParam; }

GetParams()

icFloatNumber * CIccTagParametricCurve::GetParams ( ) const

inline

Definition at line 194 of file IccTagLut.h.

{ return m_dParam; }

GetType()

virtual icTagTypeSignature CIccTagParametricCurve::GetType ( ) const

inlinevirtual

Function: GetType()

Purpose: Get Tag Type. Each derived tag will implement it's own GetType() function.

Reimplemented from CIccTag.

Definition at line 179 of file IccTagLut.h.

{ return icSigParametricCurveType; }

References icSigParametricCurveType.

IsIdentity()

bool CIccTagParametricCurve::IsIdentity ( )

virtual

Name: CIccTagParametricCurve::IsIdentity.

Purpose: Checks if this is an identity curve.

Return: true if the curve is an identity

Reimplemented from CIccCurve.

Definition at line 994 of file IccTagLut.cpp.

{
  switch(m_nFunctionType) {
    case 0x0000:
      return IsUnity(m_dParam[0]);
 
    case 0x0001:
    case 0x0002:
    case 0x0003:
    case 0x0004:
      return false;
 
    default:
      return true;
  }
}

References IsUnity().

Here is the call graph for this function:

NewCopy()

virtual CIccTag * CIccTagParametricCurve::NewCopy ( ) const

inlinevirtual

Function: NewCopy(sDescription) Each derived tag will implement it's own NewCopy() function.

Parameter(s): none

Returns a new CIccTag object that is a copy of this object.

Reimplemented from CIccCurve.

Definition at line 176 of file IccTagLut.h.

{ return new CIccTagParametricCurve(*this);}

operator=()

CIccTagParametricCurve & CIccTagParametricCurve::operator=

(

const CIccTagParametricCurve &

ParamCurveTag

)

Name: CIccTagParametricCurve::operator=.

Purpose: Copy Operator

Args: ParamCurveTag = The CIccTagParametricCurve object to be copied

Definition at line 686 of file IccTagLut.cpp.

{
  if (&ParamCurveTag == this)
    return *this;
 
  m_nFunctionType = ParamCurveTag.m_nFunctionType;
  m_nNumParam = ParamCurveTag.m_nNumParam;
 
  if (m_dParam)
    delete [] m_dParam;
    m_dParam = new icFloatNumber[m_nNumParam];
    memcpy(m_dParam, ParamCurveTag.m_dParam, m_nNumParam*sizeof(icFloatNumber));
 
  return *this;
}

References m_dParam, m_nFunctionType, and m_nNumParam.

operator[]()

icFloatNumber & CIccTagParametricCurve::operator[] ( int index )

inline

Definition at line 196 of file IccTagLut.h.

{ return m_dParam[index]; }

Param()

icFloatNumber CIccTagParametricCurve::Param ( int index ) const

inline

Definition at line 195 of file IccTagLut.h.

{ return m_dParam[index]; }

Read()

bool CIccTagParametricCurve::Read ( icUInt32Number size, CIccIO * pIO )

virtual

Name: CIccTagParametricCurve::Read.

Purpose: Read in the tag contents into a data block

Args: size - # of bytes in tag, pIO - IO object to read tag from

Return: true = successful, false = failure

Reimplemented from CIccTag.

Definition at line 732 of file IccTagLut.cpp.

{
  icTagTypeSignature sig;
  icUInt16Number nFunctionType;
 
  icUInt32Number nHdrSize = sizeof(icTagTypeSignature) + 
    sizeof(icUInt32Number) + 
    2*sizeof(icUInt16Number);
 
  if ( nHdrSize > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig) ||
    !pIO->Read32(&m_nReserved) ||
    !pIO->Read16(&nFunctionType) ||
    !pIO->Read16(&m_nReserved2))
    return false;
 
  SetFunctionType(nFunctionType);
 
  if (!m_nNumParam) {
    m_nNumParam = (icUInt16Number)((size-nHdrSize) / sizeof(icS15Fixed16Number));
    m_dParam = new icFloatNumber[m_nNumParam];
  }
 
  if (m_nNumParam) {
    int i;
    if (nHdrSize + m_nNumParam*sizeof(icS15Fixed16Number) > size)
      return false;
 
    for (i=0; i<m_nNumParam; i++) {
      icS15Fixed16Number num;
      if (!pIO->Read32(&num, 1))
        return false;
      m_dParam[i]=icFtoD(num);
    }
  }
 
  return true;
}

References icFtoD(), CIccIO::Read16(), CIccIO::Read32(), and sig.

Here is the call graph for this function:

SetFunctionType()

bool CIccTagParametricCurve::SetFunctionType

(

icUInt16Number

nFunctionType

)

Name: CIccTagParametricCurve::SetFunctionType.

Purpose: Sets the type of the function the Parametric curve represents

Args: nFunctionType = the type of the function encoded as 0-4

Return: always true!!

Definition at line 941 of file IccTagLut.cpp.

{
  icUInt16Number nNumParam;
 
  switch(nFunctionType) {
    case 0x0000:
      nNumParam = 1;
      break;
 
    case 0x0001:
      nNumParam = 3;
      break;
 
    case 0x0002:
      nNumParam = 4;
      break;
 
    case 0x0003:
      nNumParam = 5;
      break;
 
    case 0x0004:
      nNumParam = 7;
      break;
 
    default:
      nNumParam = 0;
  }
 
  if (m_dParam)
    delete m_dParam;
  m_nNumParam = nNumParam;
  m_nFunctionType = nFunctionType;
 
  if (m_nNumParam)
    m_dParam = new icFloatNumber[m_nNumParam];
  else
    m_dParam = NULL;
 
  return true;
}

Validate()

icValidateStatus CIccTagParametricCurve::Validate ( std::string sigPath, std::string & sReport, const CIccProfile * pProfile = NULL ) const

virtual

Name: CIccTagParametricCurve::Validate.

Purpose: Check tag data validity.

Args: sig = signature of tag being validated, sReport = String to add report information to

Return: icValidateStatusOK if valid, or other error status.

Reimplemented from CIccTag.

Definition at line 1090 of file IccTagLut.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
  icSignature sig = icGetFirstSigPathSig(sigPath);
 
  if (m_nReserved2!=0) {
    sReport += icMsgValidateNonCompliant;
    sReport += sSigPathName;
    sReport += " - Reserved Value must be zero.\n";
 
    rv = icMaxStatus(rv, icValidateNonCompliant);
  }
 
  switch(m_nFunctionType) {
case 0x0000:
  if (m_nNumParam!=1) {
    sReport += icMsgValidateCriticalError;
    sReport += sSigPathName;
    sReport += " - Number of parameters inconsistent with function type.\n";
    rv = icMaxStatus(rv, icValidateCriticalError);
  }
  break;
 
case 0x0001:
  if (m_nNumParam!=3) {
    sReport += icMsgValidateCriticalError;
    sReport += sSigPathName;
    sReport += " - Number of parameters inconsistent with function type.\n";
    rv = icMaxStatus(rv, icValidateCriticalError);
  }
  break;
 
case 0x0002:
  if (m_nNumParam!=4) {
    sReport += icMsgValidateCriticalError;
    sReport += sSigPathName;
    sReport += " - Number of parameters inconsistent with function type.\n";
    rv = icMaxStatus(rv, icValidateCriticalError);
  }
  break;
 
case 0x0003:
  if (m_nNumParam!=5) {
    sReport += icMsgValidateCriticalError;
    sReport += sSigPathName;
    sReport += " - Number of parameters inconsistent with function type.\n";
    rv = icMaxStatus(rv, icValidateCriticalError);
  }
  break;
 
case 0x0004:
  if (m_nNumParam!=7) {
    sReport += icMsgValidateCriticalError;
    sReport += sSigPathName;
    sReport += " - Number of parameters inconsistent with function type.\n";
    rv = icMaxStatus(rv, icValidateCriticalError);
  }
  break;
 
default:
  sReport += icMsgValidateCriticalError;
  sReport += sSigPathName;
  sReport += " - Unknown function type.\n";
  rv = icMaxStatus(rv, icValidateCriticalError);
  }
 
  if (sig==icSigBlueTRCTag || sig==icSigRedTRCTag || sig==icSigGreenTRCTag || sig==icSigGrayTRCTag) {
    icFloatNumber lval = Apply(0.0);
    icFloatNumber uval = Apply(1.0);
    if (lval>0.0 || uval<1.0) {
      sReport += icMsgValidateWarning;
      sReport += sSigPathName;
      sReport += " - Curve cannot be accurately inverted.\n";
      rv = icMaxStatus(rv, icValidateWarning);
    }
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icGetFirstSigPathSig(), icMaxStatus(), icMsgValidateCriticalError, icMsgValidateNonCompliant, icMsgValidateWarning, icSigBlueTRCTag, icSigGrayTRCTag, icSigGreenTRCTag, icSigRedTRCTag, icValidateCriticalError, icValidateNonCompliant, icValidateWarning, sig, and CIccTag::Validate().

Here is the call graph for this function:

Write()

bool CIccTagParametricCurve::Write ( CIccIO * pIO )

virtual

Name: CIccTagParametricCurve::Write.

Purpose: Write the tag to a file

Args: pIO - The IO object to write tag to.

Return: true = succesful, false = failure

Reimplemented from CIccTag.

Definition at line 791 of file IccTagLut.cpp.

{
  icTagTypeSignature sig;
 
  if (!pIO) {
    return false;
  }
 
  sig = GetType();
 
  if (!pIO->Write32(&sig) ||
    !pIO->Write32(&m_nReserved) ||
    !pIO->Write16(&m_nFunctionType) ||
    !pIO->Write16(&m_nReserved2))
    return false;
 
  if (m_nNumParam) {
    int i;
    for (i=0; i<m_nNumParam; i++) {
      icS15Fixed16Number num = icDtoF(m_dParam[i]);
      if (!pIO->Write32(&num, 1))
        return false;
    }
  }
 
  if (!pIO->Align32())
    return false;
 
  return true;
}

References CIccIO::Align32(), icDtoF(), sig, CIccIO::Write16(), and CIccIO::Write32().

Here is the call graph for this function:

Member Data Documentation

m_dParam

icFloatNumber* CIccTagParametricCurve::m_dParam

protected

Definition at line 208 of file IccTagLut.h.

Referenced by CIccTagParametricCurve(), and operator=().

m_nFunctionType

icUInt16Number CIccTagParametricCurve::m_nFunctionType

protected

Definition at line 204 of file IccTagLut.h.

Referenced by CIccTagParametricCurve(), and operator=().

m_nNumParam

icUInt16Number CIccTagParametricCurve::m_nNumParam

protected

Definition at line 205 of file IccTagLut.h.

Referenced by CIccTagParametricCurve(), and operator=().

m_nReserved2

icUInt16Number CIccTagParametricCurve::m_nReserved2

Definition at line 202 of file IccTagLut.h.

---

The documentation for this class was generated from the following files:

• IccProfLib/IccTagLut.h
• IccProfLib/IccTagLut.cpp