PCL
pcl::ICCProofingTransformation Class Reference

A soft proofing ICC profile transformation. More...

#include <ICCProfileTransformation.h>

+ Inheritance diagram for pcl::ICCProofingTransformation:

Public Member Functions

 ICCProofingTransformation ()
 
 ICCProofingTransformation (ICCProofingTransformation &&)=default
 
 ~ICCProofingTransformation () override
 
void DisableGamutCheck (bool disable=true)
 
void EnableGamutCheck (bool enable=true)
 
bool IsGamutCheckEnabled () const
 
ICCProofingTransformationoperator= (ICCProofingTransformation &&)=default
 
rendering_intent ProofingIntent () const
 
void SetProofingIntent (rendering_intent i)
 
void SetProofingProfile (const ICCProfile &profile)
 
void SetProofingProfile (const ICCProfile::handle profileHandle)
 
void SetProofingProfile (const String &profilePath)
 
void SetSourceProfile (const ICCProfile &profile)
 
void SetSourceProfile (const ICCProfile::handle profileHandle)
 
void SetSourceProfile (const String &profilePath)
 
void SetTargetProfile (const ICCProfile &profile)
 
void SetTargetProfile (const ICCProfile::handle profileHandle)
 
void SetTargetProfile (const String &profilePath)
 
- Public Member Functions inherited from pcl::ICCProfileTransformation
 ICCProfileTransformation ()=default
 
 ICCProfileTransformation (const ICCProfileTransformation &)=delete
 
 ICCProfileTransformation (ICCProfileTransformation &&x)
 
 ~ICCProfileTransformation () override
 
void Add (const ICCProfile &profile)
 
void Add (const ICCProfile::handle profileHandle)
 
void Add (const String &profilePath)
 
void Clear ()
 
void Create ()
 
void DisableBlackPointCompensation (bool disable=true)
 
void DisableHighResolutionCLUT (bool disable=true)
 
void DisableLowResolutionCLUT (bool disable=true)
 
void EnableBlackPointCompensation (bool enable=true)
 
void EnableHighResolutionCLUT (bool enable=true)
 
void EnableLowResolutionCLUT (bool enable=true)
 
void ForceFloatingPointTransformation (bool force=true)
 
bool ForcesFloatingPointTransformation () const
 
bool IsProofingTransformation () const
 
bool IsSourceRGBProfile () const
 
bool IsTargetRGBProfile () const
 
bool IsValid () const
 
ICCProfileTransformationoperator= (const ICCProfileTransformation &)=delete
 
ICCProfileTransformationoperator= (ICCProfileTransformation &&x)
 
const profile_listProfiles () const
 
void RelaxFloatingPointTransformation (bool relax=true)
 
rendering_intent RenderingIntent () const
 
void SetRenderingIntent (rendering_intent i)
 
bool UsingBlackPointCompensation () const
 
bool UsingHighResolutionCLUT () const
 
bool UsingLowResolutionCLUT () const
 
- Public Member Functions inherited from pcl::ImageTransformation
 ImageTransformation ()=default
 
 ImageTransformation (const ImageTransformation &)=default
 
virtual ~ImageTransformation ()
 
template<class P >
GenericImage< P > & operator>> (GenericImage< P > &image) const
 
ImageVariantoperator>> (ImageVariant &image) const
 
- Public Member Functions inherited from pcl::ParallelProcess
 ParallelProcess ()=default
 
 ParallelProcess (const ParallelProcess &)=default
 
virtual ~ParallelProcess ()
 
void DisableParallelProcessing (bool disable=true) noexcept
 
void EnableParallelProcessing (bool enable=true, int maxProcessors=0) noexcept
 
bool IsParallelProcessingEnabled () const noexcept
 
int MaxProcessors () const noexcept
 
ParallelProcessoperator= (const ParallelProcess &)=default
 
void SetMaxProcessors (int maxProcessors) noexcept
 
void Swap (ParallelProcess &process) noexcept
 

Static Public Member Functions

static RGBA GamutWarningColor ()
 
static void SetGamutWarningColor (RGBA color)
 

Additional Inherited Members

- Public Types inherited from pcl::ICCProfileTransformation
using profile_list = Array< ICCProfile::handle >
 
using rendering_intent = ICCRenderingIntent::value_type
 
using transformation_handle = void *
 
- Protected Member Functions inherited from pcl::ICCProfileTransformation
void Apply (pcl::DImage &) const override
 
void Apply (pcl::Image &) const override
 
void Apply (pcl::UInt16Image &) const override
 
void Apply (pcl::UInt32Image &) const override
 
void Apply (pcl::UInt8Image &) const override
 
- Protected Member Functions inherited from pcl::ImageTransformation
virtual void Apply (pcl::ComplexImage &image) const
 
virtual void Apply (pcl::DComplexImage &image) const
 

Detailed Description

ICCProofingTransformation implements a device proofing transformation. This kind of color transformation allows previewing of the final results that would be obtained on a specific proofing device without actually performing any rendition on physical media.

A device proofing transformation uses three ICC profiles: a source profile, a proofing profile, and a target profile. In a typical scenario, the proofing device is a printer and we want to proof it on a display monitor. In this common case we have:

Source profile = The ICC profile describing the color space to which source pixel values are referred.

Proofing profile = The ICC profile describing the device where the final result will be obtained (usually a printer).

Target profile = The ICC profile describing the display device where we'll preview the result (usually a monitor).

See also
ICCProfileTransformation, ICCProfile

Definition at line 530 of file ICCProfileTransformation.h.

Constructor & Destructor Documentation

◆ ICCProofingTransformation() [1/2]

pcl::ICCProofingTransformation::ICCProofingTransformation ( )
inline

Constructs a default ICCProofingTransformation object.

Definition at line 537 of file ICCProfileTransformation.h.

◆ ICCProofingTransformation() [2/2]

pcl::ICCProofingTransformation::ICCProofingTransformation ( ICCProofingTransformation &&  )
default

Move constructor.

◆ ~ICCProofingTransformation()

pcl::ICCProofingTransformation::~ICCProofingTransformation ( )
inlineoverride

Destroys an ICCProofingTransformation object.

Definition at line 551 of file ICCProfileTransformation.h.

Member Function Documentation

◆ DisableGamutCheck()

void pcl::ICCProofingTransformation::DisableGamutCheck ( bool  disable = true)
inline

Disables or enables gamut check for this color transformation.

Definition at line 658 of file ICCProfileTransformation.h.

◆ EnableGamutCheck()

void pcl::ICCProofingTransformation::EnableGamutCheck ( bool  enable = true)
inline

Enables or disables gamut check for this color transformation.

Definition at line 649 of file ICCProfileTransformation.h.

◆ GamutWarningColor()

static RGBA pcl::ICCProofingTransformation::GamutWarningColor ( )
static

Returns the current gamut warning color used to represent out-of-gamut pixel values in final proofing renditions. The returned value is a 32-bit RGBA pixel value.

◆ IsGamutCheckEnabled()

bool pcl::ICCProofingTransformation::IsGamutCheckEnabled ( ) const
inline

Returns true iff gamut checking has been enabled for this color transformation. When gamut check is enabled, out-of-gamut colors in the final rendition are automatically replaced by the current gamut warning color (see the SetGamutWarningColor() member function).

Definition at line 641 of file ICCProfileTransformation.h.

◆ operator=()

ICCProofingTransformation& pcl::ICCProofingTransformation::operator= ( ICCProofingTransformation &&  )
default

Move assignment operator. Returns a reference to this object.

◆ ProofingIntent()

rendering_intent pcl::ICCProofingTransformation::ProofingIntent ( ) const
inline

Returns the proofing rendering intent for this ICC proofing transformation.

Definition at line 619 of file ICCProfileTransformation.h.

◆ SetGamutWarningColor()

static void pcl::ICCProofingTransformation::SetGamutWarningColor ( RGBA  color)
static

Specifies the special RGB color used to represent out-of-gamut pixel values in final proofing renditions. Only used for proofing transformations with gamut check enabled.

Parameters
colorGamut warning color encoded as a 32-bit RGBA pixel value.

Note that since this is a static member function, the current gamut warning color is a global setting that affects all proofing transformations performed by the calling module.

◆ SetProofingIntent()

void pcl::ICCProofingTransformation::SetProofingIntent ( rendering_intent  i)
inline

Sets the proofing rendering intent for this ICC proofing transformation.

The default proofing intent is ICCRenderingIntent::AbsoluteColorimetric.

Definition at line 629 of file ICCProfileTransformation.h.

◆ SetProofingProfile() [1/3]

void pcl::ICCProofingTransformation::SetProofingProfile ( const ICCProfile profile)

Selects the specified ICC profile as the profile describing the proofing device in this transformation.

◆ SetProofingProfile() [2/3]

void pcl::ICCProofingTransformation::SetProofingProfile ( const ICCProfile::handle  profileHandle)

Selects an already open ICC profile profileHandle as the profile describing the proofing device in this transformation.

◆ SetProofingProfile() [3/3]

void pcl::ICCProofingTransformation::SetProofingProfile ( const String profilePath)

Loads an ICC profile from a file at profilePath and selects it as the profile describing the proofing device in this transformation.

◆ SetSourceProfile() [1/3]

void pcl::ICCProofingTransformation::SetSourceProfile ( const ICCProfile profile)

Selects the specified ICC profile as the profile describing the source color space in this transformation.

◆ SetSourceProfile() [2/3]

void pcl::ICCProofingTransformation::SetSourceProfile ( const ICCProfile::handle  profileHandle)

Selects an already open ICC profile profileHandle as the profile describing the source color space in this transformation.

◆ SetSourceProfile() [3/3]

void pcl::ICCProofingTransformation::SetSourceProfile ( const String profilePath)

Loads an ICC profile from a file at profilePath and selects it as the profile describing the source color space in this transformation.

◆ SetTargetProfile() [1/3]

void pcl::ICCProofingTransformation::SetTargetProfile ( const ICCProfile profile)

Selects the specified ICC profile as the profile describing the target (output) color space in this transformation.

◆ SetTargetProfile() [2/3]

void pcl::ICCProofingTransformation::SetTargetProfile ( const ICCProfile::handle  profileHandle)

Selects an already open ICC profile profileHandle as the profile describing the target (output) color space in this transformation.

◆ SetTargetProfile() [3/3]

void pcl::ICCProofingTransformation::SetTargetProfile ( const String profilePath)

Loads an ICC profile from a file at profilePath and selects it as the profile describing the target (output) color space in this transformation.


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