com.adobe.cq.dam.dm.process.api

Interface PTiffManager

public interface PTiffManager

Convert image content to PTIFF renditions. PTIFF rendition creation options: - usmAmount (double): Filter strength factor (0 - 5, defaults to 1.75) - usmRadius (double): Filter kernel radius in pixels (0 - 250, defaults to 0.2) - usmThreshold (int): Filter threshold level (0 - 255, defaults to 2) - usmMonochrome (boolean): False will apply the filter to each color component separately, True will only apply it to the image brightness (defaults to false) - dam.internal.OldPTiffRendition (boolean): True will write old style PTIFF renditions (defaults to false) - xmpEmbed (boolean): True will embed the XMP data in the PTIFF rendition, False will not (default behavior). - colorProfileEmbed (boolean) : If true, will embed the color profile (default behavior), false will not. - maintainPixelType (boolean) : If true, will maintain the pixel information (default behavior), false will not.

Method Summary

Modifier and Type	Method and Description
PTiffRendition	createPTiffRendition(java.io.File file, Asset asset, ValueMap options) Convert an image file to a PTIFF rendition of the given asset.
PTiffRendition	createPTiffRendition(Rendition rendition, Asset asset, ValueMap options) Convert an image rendition to a PTIFF rendition of the given asset.
PTiffRendition	createPTiffRendition(Rendition rendition, Asset asset, ValueMap options, java.io.File inputFile, java.io.File outputFile) Convert an image rendition to a PTIFF rendition of the given asset.
PTiffRendition	getPTiffRendition(Asset asset) Find the PTIFF rendition for the given asset.
boolean	isEnabled()
void	removePTiffRendition(Asset asset) Remove PTIFF rendition from the asset

Method Detail

isEnabled

boolean isEnabled()

Returns:

True if image processor is enabled

getPTiffRendition

PTiffRendition getPTiffRendition(Asset asset)

Find the PTIFF rendition for the given asset.

Parameters:

asset - Asset instance

Returns:

PTIFF rendition or null if not available

createPTiffRendition

PTiffRendition createPTiffRendition(Rendition rendition,
                                    Asset asset,
                                    ValueMap options)
                             throws java.io.IOException

Convert an image rendition to a PTIFF rendition of the given asset. Existing PTIFF rendition is not affected when createPTiffRendition returns null.

Parameters:

rendition - Image rendition

asset - Asset where to write the PTIFF rendition and properties to

options - PTIFF generation options

Returns:

PTIFF rendition or null if the stream is not supported

Throws:

java.io.IOException - when failing to access intermediary files, or the JCR

createPTiffRendition

PTiffRendition createPTiffRendition(java.io.File file,
                                    Asset asset,
                                    ValueMap options)
                             throws java.io.IOException

Convert an image file to a PTIFF rendition of the given asset. Existing PTIFF rendition is not affected when createPTiffRendition returns null.

Parameters:

file - Image file

asset - Asset where to write the PTIFF rendition and properties to

options - PTIFF generation options

Returns:

PTIFF rendition or null if the file is not supported

Throws:

java.io.IOException - when failing to access the file, intermediary files, or the JCR

createPTiffRendition

PTiffRendition createPTiffRendition(Rendition rendition,
                                    Asset asset,
                                    ValueMap options,
                                    java.io.File inputFile,
                                    java.io.File outputFile)
                             throws java.io.IOException

Convert an image rendition to a PTIFF rendition of the given asset. Existing PTIFF rendition is not affected when createPTiffRendition returns null.

Parameters:

rendition - Image rendition

asset - Asset where to write the PTIFF rendition and properties to

options - PTIFF generation options

inputFile - File to write the rendition contents to

outputFile - File to write the PTIFF result to

Returns:

PTIFF rendition or null if the stream is not supported

Throws:

java.io.IOException - when failing to access intermediary files, or the JCR

removePTiffRendition

void removePTiffRendition(Asset asset)

Remove PTIFF rendition from the asset

Parameters:

asset - Asset from which to remove the PTIFF rendition.