Mako 7.3.0 API
IDOMImageSpotMergerFilter Class Reference

An image filter that merges selected spot components into the process components of an image. This is conceptually similar to IDOMImageDeviceNToBaseFilter, but: More...

#include <idomimageresource.h>

Inherits IDOMImageFilter.

Classes

class  Data
 Initialization data. More...
 

Static Public Member Functions

static EDL_API IDOMImageSpotMergerFilterPtr create (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &inProcessSpace=IDOMColorSpacePtr(), const IDOMColorSpacePtr &outProcessSpace=IDOMColorSpacePtr(), bool mergeSpots=true, const IDOMColorSpaceDeviceN::CColorantInfoVect &spotsToMerge=IDOMColorSpaceDeviceN::CColorantInfoVect(), const JawsMako::CSpotColorNames &spotsToRetain=JawsMako::CSpotColorNames(), const JawsMako::CSpotColorNames &spotsToDrop=JawsMako::CSpotColorNames(), eRenderingIntent intent=eRelativeColorimetric, eBlackPointCompensation bpc=eBPCDefault)
 Simplified creator for a spot merging filter. Currently the result is always an 8bpc image. More...
 
static EDL_API IDOMImageSpotMergerFilterPtr create (IEDLClassFactory *pFactory, const IDOMColorSpacePtr &inProcessSpace, bool mergeSpots, const IDOMColorSpaceDeviceN::CColorantInfoVect &spotsToMerge, const JawsMako::CSpotColorNames &spotsToRetain, const JawsMako::CSpotColorNames &spotsToDrop, const CProcessConversionVect &processConversions=CProcessConversionVect())
 Simplified creator for a spot merging filter, allowing multiple process color transformations to be performed. Currently the result is always an 8bpc image. More...
 
static const CClassIDclassID ()
 Retrieves class id of IDOMImageSpotMergerFilter. More...
 

Detailed Description

An image filter that merges selected spot components into the process components of an image. This is conceptually similar to IDOMImageDeviceNToBaseFilter, but:

  • It allows only some components to be merged into the process components, and does not apply a tint transform. Instead, the spot colorants are merged into the process based on the color information provided via a kind of transparency blending.
  • It allows some spot colorants to be dropped entirely.
  • It provides a convenient method for dropping a single colorant while preserving all other spot components. While this is not merging per se, it can be useful.
  • It optionally will convert process components to another color space.

Member Function Documentation

◆ classID()

static const CClassID& IDOMImageSpotMergerFilter::classID ( )
inlinestatic

Retrieves class id of IDOMImageSpotMergerFilter.

Returns
CClassID Class id of the element

◆ create() [1/2]

static EDL_API IDOMImageSpotMergerFilterPtr IDOMImageSpotMergerFilter::create ( IEDLClassFactory pFactory,
const IDOMColorSpacePtr &  inProcessSpace,
bool  mergeSpots,
const IDOMColorSpaceDeviceN::CColorantInfoVect &  spotsToMerge,
const JawsMako::CSpotColorNames &  spotsToRetain,
const JawsMako::CSpotColorNames &  spotsToDrop,
const CProcessConversionVect &  processConversions = CProcessConversionVect() 
)
static

Simplified creator for a spot merging filter, allowing multiple process color transformations to be performed. Currently the result is always an 8bpc image.

Parameters
pFactoryThe EDL Class Factory.
inProcessSpaceThe process color space to be used when interpreting any process components in the source color space. If not provided, any process color information in the DeviceN space will be used (see IDOMColorSpaceDeviceN::getProcessColorSpace()) or failing that, DviceCMYK will be used. Please note that at this time only CMYK process components will be consulted, and as such, this must be a CMYK color space.
mergeSpotsIf false, no spots will be merged (and #spotsToMerge is ignored).
spotsToMergeThe spots to merge. Consulted only if #mergeSpots is true. If empty, all spots will be merged, and the color of each component will be determined using a best effort method from the DeviceN color space of the source image. If non-empty, then the given spots are merged into the process components. The components in the info structures must use the same color space as the final output color space.
spotsToRetainThe names of colorants to retain, even if subject to mergeSpots or spotsToMerge. Useful in cases where it is known up front which spots to retain, but it is not known which spots to merge in order to achieve that aim. Otherwise, this can be left empty.
spotsToDropThe names of colorants to drop entirely. If not provided, no spot components will be dropped. Please note that if all spots are dropped, and there are no process components, an error will result when the resulting frame is accessed.
processConversionsThe series of conversions that will be performed on any process components in the image. This allows for process components to be converted through color spaces other than CMYK. However, the last outProcessSpace must be a CMYK color space. If there is more than one process conversion, then all must specify an outProcessSpace.
Returns
IDOMImageSpotMergerFilterPtr The new filter.

◆ create() [2/2]

static EDL_API IDOMImageSpotMergerFilterPtr IDOMImageSpotMergerFilter::create ( IEDLClassFactory pFactory,
const IDOMColorSpacePtr &  inProcessSpace = IDOMColorSpacePtr(),
const IDOMColorSpacePtr &  outProcessSpace = IDOMColorSpacePtr(),
bool  mergeSpots = true,
const IDOMColorSpaceDeviceN::CColorantInfoVect &  spotsToMerge = IDOMColorSpaceDeviceN::CColorantInfoVect(),
const JawsMako::CSpotColorNames &  spotsToRetain = JawsMako::CSpotColorNames(),
const JawsMako::CSpotColorNames &  spotsToDrop = JawsMako::CSpotColorNames(),
eRenderingIntent  intent = eRelativeColorimetric,
eBlackPointCompensation  bpc = eBPCDefault 
)
static

Simplified creator for a spot merging filter. Currently the result is always an 8bpc image.

Parameters
pFactoryThe EDL Class Factory.
inProcessSpaceThe process color space to be used when interpreting any process components in the source color space. If not provided, any process color information in the DeviceN space will be used (see IDOMColorSpaceDeviceN::getProcessColorSpace()) or failing that, DviceCMYK will be used. Please note that at this time only CMYK process components will be consulted, and as such, this must be a CMYK color space.
outProcessSpaceThe process color space to generate. If not provided, the alternate color space of the image will be used. Currently, this color space must be subtractive - that is, it must be a CMYK color space. If the inProcessSpace does not match outProcessSpace, then process components will be converted from the inProcessSpace to the outProcessSpace before any spot merging takes place.
mergeSpotsIf false, no spots will be merged (and #spotsToMerge is ignored).
spotsToMergeThe spots to merge. Consulted only if #mergeSpots is true. If empty, all spots will be merged, and the color of each component will be determined using a best effort method from the DeviceN color space of the source image. If non-empty, then the given spots are merged into the process components. The components in the info structures must use the same color space as the outProcessSpace.
spotsToRetainThe names of colorants to retain, even if subject to mergeSpots or spotsToMerge. Useful in cases where it is known up front which spots to retain, but it is not known which spots to merge in order to achieve that aim. Otherwise, this can be left empty.
spotsToDropThe names of colorants to drop entirely. If not provided, no spot components will be dropped. Please note that if all spots are dropped, and there are no process components, an error will result when the resulting frame is accessed.
intentThe rendering intent to use if process components require color conversion.
bpcThe black-point compensation method to be used if process components require color conversion.
Returns
IDOMImageSpotMergerFilterPtr The new filter.

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