Class TiffImagingParameters
java.lang.Object
org.apache.commons.imaging.ImagingParameters<TiffImagingParameters>
org.apache.commons.imaging.common.XmpImagingParameters<TiffImagingParameters>
org.apache.commons.imaging.formats.tiff.TiffImagingParameters
TIFF format parameters.
- Since:
- 1.0-alpha3
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidClears settings for sub-image.Gets the TIFF output set for writing TIFF files.intGets the height for a sub-image setting.intGets the width for a sub-image setting.intGets the X coordinate of a sub-image.intGets the Y coordinate of a sub-image.booleanbooleanIndicates whether the application has set sub-image parameters.setCompression(Integer compression) setCustomPhotometricInterpreter(AbstractPhotometricInterpreter customPhotometricInterpreter) setLzwCompressionBlockSize(Integer lzwCompressionBlockSize) setOutputSet(TiffOutputSet tiffOutputSet) Sets the TIFF output set for writing TIFF files.setReadThumbnails(boolean readThumbnails) setSubImage(int x, int y, int width, int height) Sets parameters for performing a partial read operation on an image.setT4Options(Integer t4Options) setT6Options(Integer t6Options) Methods inherited from class org.apache.commons.imaging.common.XmpImagingParametersgetXmpXml, setXmpXmlMethods inherited from class org.apache.commons.imaging.ImagingParametersasThis, getBufferedImageFactory, getFileName, getPixelDensity, isStrict, setBufferedImageFactory, setFileName, setPixelDensity, setStrict
- 
Constructor Details- 
TiffImagingParameterspublic TiffImagingParameters()
 
- 
- 
Method Details- 
clearSubImageClears settings for sub-image. Subsequent read operations will retrieve the entire image.
- 
getCompression
- 
getCustomPhotometricInterpreter
- 
getLzwCompressionBlockSize
- 
getOutputSetGets the TIFF output set for writing TIFF files.- Returns:
- if set, a valid instance; otherwise, a null reference.
 
- 
getSubImageHeightGets the height for a sub-image setting. For a sub-image setting to be meaningful, both the width and height must be set.- Returns:
- if the sub-image feature is enabled, a value greater than zero; otherwise, zero.
 
- 
getSubImageWidthGets the width for a sub-image setting. For a sub-image setting to be meaningful, both the width and height must be set.- Returns:
- if the sub-image feature is enabled, a value greater than zero; otherwise, zero.
 
- 
getSubImageXGets the X coordinate of a sub-image. This setting is meaningful only if a sub-image is set.- Returns:
- a positive integer
 
- 
getSubImageYGets the Y coordinate of a sub-image. This setting is meaningful only if a sub-image is set.- Returns:
- a positive integer
 
- 
getT4Options
- 
getT6Options
- 
isReadThumbnails
- 
isSubImageSetIndicates whether the application has set sub-image parameters.- Returns:
- true if the sub-image parameters are set; otherwise, false.
 
- 
setCompression
- 
setCustomPhotometricInterpreterpublic TiffImagingParameters setCustomPhotometricInterpreter(AbstractPhotometricInterpreter customPhotometricInterpreter) 
- 
setLzwCompressionBlockSize
- 
setOutputSetSets the TIFF output set for writing TIFF files. An output set may contain various types of TiffDirectories including image directories, EXIF directories, GPS-related directories, etc.- Parameters:
- tiffOutputSet- A valid instance.
- Returns:
- thisinstance.
 
- 
setReadThumbnails
- 
setSubImageSets parameters for performing a partial read operation on an image. This method is useful for reducing memory and run-time overhead when accessing large source images.Note that the corner x and y coordinates must be positive integers (zero or greater). The width and height must be greater than zero. - Parameters:
- x- pixel coordinate of the upper-left corner of the source image, must be zero or greater.
- y- pixel coordinate of the upper-left corner of the source image, must be zero or greater.
- width- width of the image subset to be read, must be greater than zero.
- height- height of the image subset to be read, must be greater than zero.
- Returns:
- thisinstance.
 
- 
setT4Options
- 
setT6Options
 
-