#include <IccTagBasic.h>

Inheritance diagram for CIccTagChromaticity:

Collaboration diagram for CIccTagChromaticity:

Public Member Functions
	CIccTagChromaticity (const CIccTagChromaticity &ITCh)
	Name: CIccTagChromaticity::CIccTagChromaticity.

	CIccTagChromaticity (int nSize=3)
	Name: CIccTagChromaticity::CIccTagChromaticity.

virtual void	Describe (std::string &sDescription, int nVerboseness)
	Name: CIccTagChromaticity::Describe.

virtual const icChar *	GetClassName () const

icUInt32Number	GetSize () const

virtual icTagTypeSignature	GetType () const
	Function: GetType()

icChromaticityNumber *	Getxy (icUInt32Number index)

virtual bool	IsArrayType ()

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

CIccTagChromaticity &	operator= (const CIccTagChromaticity &ChromTag)
	Name: CIccTagChromaticity::operator=.

icChromaticityNumber &	operator[] (icUInt32Number index)

virtual bool	Read (icUInt32Number size, CIccIO *pIO)
	Name: CIccTagChromaticity::Read.

bool	SetSize (icUInt16Number nSize, bool bZeroNew=true)
	Name: CIccTagChromaticity::SetSize.

virtual icValidateStatus	Validate (std::string sigPath, std::string &sReport, const CIccProfile *pProfile=NULL) const
	Name: CIccTagChromaticity::Validate.

virtual bool	Write (CIccIO *pIO)
	Name: CIccTagChromaticity::Write.

virtual	~CIccTagChromaticity ()
	Name: CIccTagChromaticity::~CIccTagChromaticity.

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	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_nColorantType

Public Attributes inherited from CIccTag
icUInt32Number	m_nReserved

Protected Attributes
icUInt16Number	m_nChannels

icChromaticityNumber *	m_xy

Additional Inherited Members
Static Public Member Functions inherited from CIccTag
static CIccTag *	Create (icTagTypeSignature sig)
	Name: CIccTag::Create.

Detailed Description

Class: CIccTagChromaticity.

Purpose: the chromaticity tag - xy chromaticity values for each channel

Definition at line 704 of file IccTagBasic.h.

Constructor & Destructor Documentation

◆ CIccTagChromaticity() [1/2]

CIccTagChromaticity::CIccTagChromaticity ( int nSize = 3 )

Name: CIccTagChromaticity::CIccTagChromaticity.

Purpose: Constructor

Args: nSize = number of xy entries

Definition at line 3753 of file IccTagBasic.cpp.

{
  m_nChannels = nSize;
  if (m_nChannels <3)
    m_nChannels = 3;
  m_xy = (icChromaticityNumber*)calloc(nSize, sizeof(icChromaticityNumber));
}

◆ CIccTagChromaticity() [2/2]

CIccTagChromaticity::CIccTagChromaticity ( const CIccTagChromaticity & ITCh )

Name: CIccTagChromaticity::CIccTagChromaticity.

Purpose: Copy Constructor

Args: ITCh = The CIccTagChromaticity object to be copied

Definition at line 3772 of file IccTagBasic.cpp.

{
  m_nChannels = ITCh.m_nChannels;
 
  m_xy = (icChromaticityNumber*)calloc(m_nChannels, sizeof(icChromaticityNumber));
  memcpy(m_xy, ITCh.m_xy, sizeof(icChromaticityNumber)*m_nChannels);
}

References m_nChannels, and m_xy.

◆ ~CIccTagChromaticity()

CIccTagChromaticity::~CIccTagChromaticity ( )

virtual

Name: CIccTagChromaticity::~CIccTagChromaticity.

Purpose: Destructor

Definition at line 3815 of file IccTagBasic.cpp.

{
  if (m_xy)
    free(m_xy);
}

Member Function Documentation

◆ Describe()

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

virtual

Name: CIccTagChromaticity::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 3932 of file IccTagBasic.cpp.

{
  icChar buf[128];
  CIccInfo Fmt;
 
  icUInt32Number i;
  //sDescription.reserve(sDescription.size() + m_nChannels*79);
  sprintf(buf, "Number of Channels : %u\n", m_nChannels);
  sDescription += buf;
 
  sprintf(buf, "Colorant Encoding : %s\n", Fmt.GetColorantEncoding((icColorantEncoding)m_nColorantType));
  sDescription += buf;
 
  for (i=0; i<m_nChannels; i++) {
    sprintf(buf, "value[%u]: x=%.3lf, y=%.3lf\n", i, icUFtoD(m_xy[i].x), icUFtoD(m_xy[i].y));
    sDescription += buf;
  }
 
}

References CIccInfo::GetColorantEncoding(), and icUFtoD().

Here is the call graph for this function:

◆ GetClassName()

virtual const icChar * CIccTagChromaticity::GetClassName ( ) const

inlinevirtual

Reimplemented from CIccTag.

Reimplemented in CIccTagXmlChromaticity.

Definition at line 716 of file IccTagBasic.h.

716{ return "CIccTagChromaticity"; }

◆ GetSize()

icUInt32Number CIccTagChromaticity::GetSize ( ) const

inline

Definition at line 725 of file IccTagBasic.h.

725{ return m_nChannels; }

◆ GetType()

virtual icTagTypeSignature CIccTagChromaticity::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 715 of file IccTagBasic.h.

715{ return icSigChromaticityType; }

icSigChromaticityType

@ icSigChromaticityType

Definition icProfileHeader.h:528

References icSigChromaticityType.

◆ Getxy()

icChromaticityNumber * CIccTagChromaticity::Getxy ( icUInt32Number index )

inline

Definition at line 724 of file IccTagBasic.h.

724{return &m_xy[index];}

◆ IsArrayType()

virtual bool CIccTagChromaticity::IsArrayType ( )

inlinevirtual

Reimplemented from CIccTag.

Definition at line 713 of file IccTagBasic.h.

713{ return m_nChannels > 1; }

◆ NewCopy()

virtual CIccTag * CIccTagChromaticity::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 CIccTag.

Definition at line 710 of file IccTagBasic.h.

710{return new CIccTagChromaticity(*this);}

CIccTagChromaticity::CIccTagChromaticity

CIccTagChromaticity(int nSize=3)

Name: CIccTagChromaticity::CIccTagChromaticity.

Definition IccTagBasic.cpp:3753

◆ operator=()

CIccTagChromaticity & CIccTagChromaticity::operator= ( const CIccTagChromaticity & ChromTag )

Name: CIccTagChromaticity::operator=.

Purpose: Copy Operator

Args: ChromTag = The CIccTagChromaticity object to be copied

Definition at line 3791 of file IccTagBasic.cpp.

{
  if (&ChromTag == this)
    return *this;
 
  m_nChannels = ChromTag.m_nChannels;
 
  if (m_xy)
    free(m_xy);
  m_xy = (icChromaticityNumber*)calloc(m_nChannels, sizeof(icChromaticityNumber));
  memcpy(m_xy, ChromTag.m_xy, sizeof(icChromaticityNumber)*m_nChannels);
 
  return *this;  
}

References m_nChannels, and m_xy.

◆ operator[]()

icChromaticityNumber & CIccTagChromaticity::operator[] ( icUInt32Number index )

inline

Definition at line 723 of file IccTagBasic.h.

723{return m_xy[index];}

◆ Read()

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

virtual

Name: CIccTagChromaticity::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 3836 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig;
  icUInt16Number nChannels;
 
  if (sizeof(icTagTypeSignature) + 
      sizeof(icUInt32Number) + 
      sizeof(icUInt32Number) +
      sizeof(icChromaticityNumber) > size)
    return false;
 
  if (!pIO) {
    return false;
  }
 
  if (!pIO->Read32(&sig))
    return false;
 
  if (!pIO->Read32(&m_nReserved))
    return false;
 
  if (!pIO->Read16(&nChannels) ||
      !pIO->Read16(&m_nColorantType))
    return false;
 
  icUInt32Number nNum = (size-3*sizeof(icUInt32Number)) / sizeof(icChromaticityNumber);
  icUInt32Number nNum32 = (nNum*sizeof(icChromaticityNumber)) / sizeof(icU16Fixed16Number);
 
  if (nNum < nChannels)
    return false;
 
  // SetSize casts from icUInt32Number down to icUInt16Number. Check for overflow
  if (nNum > (icUInt16Number)nNum)
    return false;
 
  if (!SetSize((icUInt16Number)nNum))
    return false;
 
  if (pIO->Read32(&m_xy[0], nNum32) != (icInt32Number)nNum32 )
    return false;
 
  return true;
}

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

Here is the call graph for this function:

◆ SetSize()

bool CIccTagChromaticity::SetSize	(	icUInt16Number	nSize,
		bool	bZeroNew = true )

Name: CIccTagChromaticity::SetSize.

Purpose: Sets the size of the xy chromaticity array.

Args: nSize - number of xy entries, bZeroNew - flag to zero newly formed values

Definition at line 3963 of file IccTagBasic.cpp.

{
  if (m_nChannels == nSize)
    return true;
 
  m_xy = (icChromaticityNumber*)icRealloc(m_xy, nSize*sizeof(icChromaticityNumber));
 
  if (!m_xy) {
    m_nChannels = 0;
    return false;
  }
 
  if (bZeroNew && nSize > m_nChannels) {
    memset(&m_xy[m_nChannels], 0, (nSize - m_nChannels)*sizeof(icChromaticityNumber));
  }
 
  m_nChannels = nSize;
  return true;
}

References icRealloc().

Here is the call graph for this function:

◆ Validate()

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

virtual

Name: CIccTagChromaticity::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 3998 of file IccTagBasic.cpp.

{
  icValidateStatus rv = CIccTag::Validate(sigPath, sReport, pProfile);
 
  CIccInfo Info;
  std::string sSigPathName = Info.GetSigPathName(sigPath);
 
  if (m_nColorantType) {
 
    if (m_nChannels!=3) {
      sReport += icMsgValidateCriticalError;
      sReport += sSigPathName;
      sReport += " - Number of device channels must be three.\n";
      rv = icMaxStatus(rv, icValidateCriticalError);
    }
 
    switch(m_nColorantType) {
      case icColorantITU:
        {
          if ( (m_xy[0].x != icDtoUF((icFloatNumber)0.640)) || (m_xy[0].y != icDtoUF((icFloatNumber)0.330)) ||
               (m_xy[1].x != icDtoUF((icFloatNumber)0.300)) || (m_xy[1].y != icDtoUF((icFloatNumber)0.600)) ||
               (m_xy[2].x != icDtoUF((icFloatNumber)0.150)) || (m_xy[2].y != icDtoUF((icFloatNumber)0.060)) ) {
                sReport += icMsgValidateNonCompliant;
                sReport += sSigPathName;
                sReport += " - Chromaticity data does not match specification.\n";
                rv = icMaxStatus(rv, icValidateNonCompliant);
              }
          break;
        }
 
      case icColorantSMPTE:
        {
          if ( (m_xy[0].x != icDtoUF((icFloatNumber)0.630)) || (m_xy[0].y != icDtoUF((icFloatNumber)0.340)) ||
               (m_xy[1].x != icDtoUF((icFloatNumber)0.310)) || (m_xy[1].y != icDtoUF((icFloatNumber)0.595)) ||
               (m_xy[2].x != icDtoUF((icFloatNumber)0.155)) || (m_xy[2].y != icDtoUF((icFloatNumber)0.070)) ) {
              sReport += icMsgValidateNonCompliant;
              sReport += sSigPathName;
              sReport += " - Chromaticity data does not match specification.\n";
              rv = icMaxStatus(rv, icValidateNonCompliant);
            }
            break;
        }
 
      case icColorantEBU:
        {
          if ( (m_xy[0].x != icDtoUF((icFloatNumber)0.64)) || (m_xy[0].y != icDtoUF((icFloatNumber)0.33)) ||
               (m_xy[1].x != icDtoUF((icFloatNumber)0.29)) || (m_xy[1].y != icDtoUF((icFloatNumber)0.60)) ||
               (m_xy[2].x != icDtoUF((icFloatNumber)0.15)) || (m_xy[2].y != icDtoUF((icFloatNumber)0.06)) ) {
              sReport += icMsgValidateNonCompliant;
              sReport += sSigPathName;
              sReport += " - Chromaticity data does not match specification.\n";
              rv = icMaxStatus(rv, icValidateNonCompliant);
            }
            break;
        }
 
      case icColorantP22:
        {
          if ( (m_xy[0].x != icDtoUF((icFloatNumber)0.625)) || (m_xy[0].y != icDtoUF((icFloatNumber)0.340)) ||
               (m_xy[1].x != icDtoUF((icFloatNumber)0.280)) || (m_xy[1].y != icDtoUF((icFloatNumber)0.605)) ||
               (m_xy[2].x != icDtoUF((icFloatNumber)0.155)) || (m_xy[2].y != icDtoUF((icFloatNumber)0.070)) ) {
              sReport += icMsgValidateNonCompliant;
              sReport += sSigPathName;
              sReport += " - Chromaticity data does not match specification.\n";
              rv = icMaxStatus(rv, icValidateNonCompliant);
            }
            break;
        }
 
      default:
        {
          sReport += icMsgValidateNonCompliant;
          sReport += sSigPathName;
          sReport += " - Invalid colorant type encoding.\n";
          rv = icMaxStatus(rv, icValidateNonCompliant);
        }
    }
  }
 
  return rv;
}

References CIccInfo::GetSigPathName(), icColorantEBU, icColorantITU, icColorantP22, icColorantSMPTE, icDtoUF(), icMaxStatus(), icMsgValidateCriticalError, icMsgValidateNonCompliant, icValidateCriticalError, icValidateNonCompliant, and CIccTag::Validate().

Here is the call graph for this function:

◆ Write()

bool CIccTagChromaticity::Write ( CIccIO * pIO )

virtual

Name: CIccTagChromaticity::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 3894 of file IccTagBasic.cpp.

{
  icTagTypeSignature sig = GetType();
 
  if (!pIO)
   return false;
 
  if (!pIO->Write32(&sig))
   return false;
 
  if (!pIO->Write32(&m_nReserved))
    return false;
 
  if (!pIO->Write16(&m_nChannels))
    return false;
 
  if (!pIO->Write16(&m_nColorantType))
    return false;
 
  icUInt32Number nNum32 = m_nChannels*sizeof(icChromaticityNumber)/sizeof(icU16Fixed16Number);
 
  if (pIO->Write32(&m_xy[0], nNum32) != (icInt32Number)nNum32)
    return false;
 
  return true;
}

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

Here is the call graph for this function:

Member Data Documentation

◆ m_nChannels

icUInt16Number CIccTagChromaticity::m_nChannels

protected

Definition at line 733 of file IccTagBasic.h.

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

◆ m_nColorantType

icUInt16Number CIccTagChromaticity::m_nColorantType

Definition at line 728 of file IccTagBasic.h.

◆ m_xy

icChromaticityNumber* CIccTagChromaticity::m_xy

protected

Definition at line 734 of file IccTagBasic.h.

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

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

IccProfLib/IccTagBasic.h
IccProfLib/IccTagBasic.cpp

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CIccTagChromaticity() [1/2]

◆ CIccTagChromaticity() [2/2]

◆ ~CIccTagChromaticity()

Member Function Documentation

◆ Describe()

◆ GetClassName()

◆ GetSize()

◆ GetType()

◆ Getxy()

◆ IsArrayType()

◆ NewCopy()

◆ operator=()

◆ operator[]()

◆ Read()

◆ SetSize()

◆ Validate()

◆ Write()

Member Data Documentation

◆ m_nChannels

◆ m_nColorantType

◆ m_xy