Class TiffImagingParameters
java.lang.Object
org.apache.commons.imaging.ImagingParameters<E>
org.apache.commons.imaging.common.XmpImagingParameters<TiffImagingParameters>
org.apache.commons.imaging.formats.tiff.TiffImagingParameters
TIFF format parameters.
- Since:
- 1.0-alpha3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears settings for sub-image.Gets the TIFF output set for writing TIFF files.int
Gets the height for a sub-image setting.int
Gets the width for a sub-image setting.int
Gets the X coordinate of a sub-image.int
Gets the Y coordinate of a sub-image.boolean
boolean
Indicates whether the application has set sub-image parameters.setCompression
(Integer compression) setCustomPhotometricInterpreter
(PhotometricInterpreter 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.XmpImagingParameters
getXmpXml, setXmpXml
Methods inherited from class org.apache.commons.imaging.ImagingParameters
asThis, getBufferedImageFactory, getFileName, getPixelDensity, isStrict, setBufferedImageFactory, setFileName, setPixelDensity, setStrict
-
Constructor Details
-
TiffImagingParameters
public TiffImagingParameters()
-
-
Method Details
-
clearSubImage
Clears settings for sub-image. Subsequent read operations will retrieve the entire image. -
getCompression
-
getCustomPhotometricInterpreter
-
getLzwCompressionBlockSize
-
getOutputSet
Gets the TIFF output set for writing TIFF files.- Returns:
- if set, a valid instance; otherwise, a null reference.
-
getSubImageHeight
Gets 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.
-
getSubImageWidth
Gets 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.
-
getSubImageX
Gets the X coordinate of a sub-image. This setting is meaningful only if a sub-image is set.- Returns:
- a positive integer
-
getSubImageY
Gets 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
-
isSubImageSet
Indicates whether the application has set sub-image parameters.- Returns:
- true if the sub-image parameters are set; otherwise, false.
-
setCompression
-
setCustomPhotometricInterpreter
public TiffImagingParameters setCustomPhotometricInterpreter(PhotometricInterpreter customPhotometricInterpreter) -
setLzwCompressionBlockSize
-
setOutputSet
Sets 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:
- this
-
setReadThumbnails
-
setSubImage
Sets 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:
- this
-
setT4Options
-
setT6Options
-