digiKam
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Digikam::IccTransform Class Reference

Public Types

enum  RenderingIntent { Perceptual = 0 , RelativeColorimetric = 1 , Saturation = 2 , AbsoluteColorimetric = 3 }
 

Public Member Functions

bool apply (DImg &image, DImgLoaderObserver *const observer=nullptr)
 
bool apply (QImage &qimage)
 
QColor checkGamutMaskColor () const
 
void close ()
 
IccProfile effectiveInputProfile () const
 
IccProfile embeddedProfile () const
 
 IccTransform ()
 
 IccTransform (const IccTransform &other)
 
IccProfile inputProfile () const
 
RenderingIntent intent () const
 
bool isCheckingGamut () const
 
bool isUsingBlackPointCompensation () const
 
IccTransform & operator= (const IccTransform &other)
 
IccProfile outputProfile () const
 
RenderingIntent proofIntent () const
 
IccProfile proofProfile () const
 
void setCheckGamut (bool checkGamut)
 
void setCheckGamutMaskColor (const QColor &color)
 
void setDoNotEmbedOutputProfile (bool doNotEmbed)
 
void setEmbeddedProfile (const DImg &image)
 
void setInputProfile (const IccProfile &profile)
 
void setIntent (int intent)
 
void setIntent (RenderingIntent intent)
 
void setOutputProfile (const IccProfile &profile)
 
void setProofIntent (int intent)
 
void setProofIntent (RenderingIntent intent)
 
void setProofProfile (const IccProfile &profile)
 
void setUseBlackPointCompensation (bool useBPC)
 
bool willHaveEffect ()
 
 ~IccTransform ()
 

Static Public Member Functions

static void init ()
 

Member Enumeration Documentation

◆ RenderingIntent

enum Digikam::IccTransform::RenderingIntent
Enumerator
Perceptual 
RelativeColorimetric 
Saturation 
AbsoluteColorimetric 

Constructor & Destructor Documentation

◆ IccTransform() [1/2]

Digikam::IccTransform::IccTransform ( )
explicit

◆ ~IccTransform()

Digikam::IccTransform::~IccTransform ( )

◆ IccTransform() [2/2]

Digikam::IccTransform::IccTransform ( const IccTransform &  other)

Member Function Documentation

◆ apply() [1/2]

bool Digikam::IccTransform::apply ( DImg &  image,
DImgLoaderObserver *const  observer = nullptr 
)

Apply this transform with the set profiles and options to the image. Optionally pass an observer to get progress information.

References Digikam::DImgLoaderObserver::progressInfo(), Digikam::DImg::removeAttribute(), Digikam::DImg::setIccProfile(), and willHaveEffect().

Referenced by Digikam::DImg::convertToPixmap(), Digikam::IccTransformFilter::filterImage(), Digikam::RawProcessingFilter::filterImage(), Digikam::SharedLoadingTask::postProcess(), Digikam::IccManager::transform(), Digikam::IccManager::transformForDisplay(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ apply() [2/2]

bool Digikam::IccTransform::apply ( QImage &  qimage)

Apply this transform to the QImage. This has only basic functionality.

References willHaveEffect().

◆ checkGamutMaskColor()

QColor Digikam::IccTransform::checkGamutMaskColor ( ) const

◆ close()

void Digikam::IccTransform::close ( )

Closes the transform, not the profiles. Called at destruction.

Referenced by setCheckGamut(), setEmbeddedProfile(), setInputProfile(), setIntent(), setOutputProfile(), setProofIntent(), setProofProfile(), and setUseBlackPointCompensation().

◆ effectiveInputProfile()

IccProfile Digikam::IccTransform::effectiveInputProfile ( ) const

Returns the embedded profile; if none is set, the input profile; if none is set, sRGB.

Referenced by Digikam::IccTransformFilter::filterAction().

◆ embeddedProfile()

IccProfile Digikam::IccTransform::embeddedProfile ( ) const

Returns the contained profiles

◆ init()

void Digikam::IccTransform::init ( )
static

Initialize LittleCMS library

References dkCmsErrorAction(), and LCMS_ERROR_SHOW.

◆ inputProfile()

IccProfile Digikam::IccTransform::inputProfile ( ) const

Referenced by Digikam::IccTransformFilter::parametersSuccessfullyRead(), and Digikam::IccTransformFilter::readParametersError().

◆ intent()

IccTransform::RenderingIntent Digikam::IccTransform::intent ( ) const

Referenced by Digikam::IccTransformFilter::filterAction(), setIntent(), and setProofIntent().

◆ isCheckingGamut()

bool Digikam::IccTransform::isCheckingGamut ( ) const

◆ isUsingBlackPointCompensation()

bool Digikam::IccTransform::isUsingBlackPointCompensation ( ) const

Referenced by Digikam::IccTransformFilter::filterAction().

◆ operator=()

IccTransform & Digikam::IccTransform::operator= ( const IccTransform &  other)

◆ outputProfile()

IccProfile Digikam::IccTransform::outputProfile ( ) const

Referenced by Digikam::DImg::convertToPixmap(), Digikam::IccTransformFilter::filterAction(), Digikam::IccTransformFilter::filterImage(), Digikam::IccTransformFilter::parametersSuccessfullyRead(), Digikam::SharedLoadingTask::postProcess(), Digikam::IccTransformFilter::readParametersError(), Digikam::IccManager::transform(), Digikam::IccManager::transformForDisplay(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ proofIntent()

IccTransform::RenderingIntent Digikam::IccTransform::proofIntent ( ) const

◆ proofProfile()

IccProfile Digikam::IccTransform::proofProfile ( ) const

◆ setCheckGamut()

void Digikam::IccTransform::setCheckGamut ( bool  checkGamut)

References close().

◆ setCheckGamutMaskColor()

void Digikam::IccTransform::setCheckGamutMaskColor ( const QColor &  color)

◆ setDoNotEmbedOutputProfile()

void Digikam::IccTransform::setDoNotEmbedOutputProfile ( bool  doNotEmbed)

Call this with 'true' if you do not want the output profile to be set as embedded profile after apply() did a transformation. Default is to set the output profile as embedded profile (false).

◆ setEmbeddedProfile()

void Digikam::IccTransform::setEmbeddedProfile ( const DImg &  image)

Sets the input profiles of this transform. You can call both setEmbeddedProfile and setInputProfile. If the image contains an embedded profile this profile is used and takes precedence over the set input profile, which is used without an embedded profile. If none is set, sRGB is used.

References close(), and Digikam::DImg::getIccProfile().

Referenced by Digikam::RawProcessingFilter::filterImage().

◆ setInputProfile()

void Digikam::IccTransform::setInputProfile ( const IccProfile &  profile)

References close().

Referenced by Digikam::IccManager::displayTransform(), Digikam::IccManager::getTransform(), Digikam::IccTransformFilter::readParameters(), Digikam::IccManager::transformForDisplay(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ setIntent() [1/2]

void Digikam::IccTransform::setIntent ( int  intent)
inline

◆ setIntent() [2/2]

void Digikam::IccTransform::setIntent ( RenderingIntent  intent)

Set options

References close(), and intent().

Referenced by Digikam::IccManager::displayTransform(), Digikam::RawProcessingFilter::filterImage(), Digikam::IccManager::getTransform(), Digikam::IccTransformFilter::readParameters(), Digikam::IccManager::transformForDisplay(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ setOutputProfile()

void Digikam::IccTransform::setOutputProfile ( const IccProfile &  profile)

Sets the output transform

References close().

Referenced by Digikam::IccManager::displayTransform(), Digikam::RawProcessingFilter::filterImage(), Digikam::IccManager::getTransform(), Digikam::IccTransformFilter::readParameters(), Digikam::IccManager::transformForDisplay(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ setProofIntent() [1/2]

void Digikam::IccTransform::setProofIntent ( int  intent)
inline

◆ setProofIntent() [2/2]

void Digikam::IccTransform::setProofIntent ( RenderingIntent  intent)

References close(), and intent().

◆ setProofProfile()

void Digikam::IccTransform::setProofProfile ( const IccProfile &  profile)

Makes this transform a proofing transform, if profile is not null

References close().

◆ setUseBlackPointCompensation()

void Digikam::IccTransform::setUseBlackPointCompensation ( bool  useBPC)

References close().

Referenced by Digikam::IccManager::displayTransform(), Digikam::IccManager::getTransform(), Digikam::IccTransformFilter::readParameters(), Digikam::IccManager::transformForOutput(), and Digikam::IccManager::transformToSRGB().

◆ willHaveEffect()

bool Digikam::IccTransform::willHaveEffect ( )

Returns if this transformation will have an effect, i.e. if effective input profile and output profile are different.

Referenced by apply(), Digikam::Canvas::applyTransform(), Digikam::IccManager::transform(), and Digikam::IccManager::transformForDisplay().

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