Package org.apache.commons.imaging.formats.tiff

Class TiffDirectory

java.lang.Object

org.apache.commons.imaging.formats.tiff.AbstractTiffElement

org.apache.commons.imaging.formats.tiff.TiffDirectory

All Implemented Interfaces:

java.lang.Iterable<TiffField>

public class TiffDirectory
extends AbstractTiffElement
implements java.lang.Iterable<TiffField>

Provides methods and elements for accessing an Image File Directory (IFD) from a TIFF file. In the TIFF specification, the IFD is the main container for individual images or sets of metadata. While not all Directories contain images, images are always stored in a Directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TiffDirectory.ImageDataElement

Nested classes/interfaces inherited from class org.apache.commons.imaging.formats.tiff.AbstractTiffElement

AbstractTiffElement.DataElement, AbstractTiffElement.Stub

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractTiffImageData	abstractTiffImageData
private java.util.List<TiffField>	entries
private java.nio.ByteOrder	headerByteOrder	Preserves the byte order derived from the TIFF file header.
private JpegImageData	jpegImageData
private long	nextDirectoryOffset
int	type

Fields inherited from class org.apache.commons.imaging.formats.tiff.AbstractTiffElement

COMPARATOR, length, offset

Constructor Summary

Constructors

Constructor	Description
TiffDirectory(int type, java.util.List<TiffField> entries, long offset, long nextDirectoryOffset, java.nio.ByteOrder byteOrder)

Method Summary

Modifier and Type	Method	Description
java.lang.String	description()
static java.lang.String	description(int type)
void	dump()
TiffField	findField(TagInfo tag)
TiffField	findField(TagInfo tag, boolean failIfMissing)
java.nio.ByteOrder	getByteOrder()	Gets the byte order used by the source file for storing this directory and its content.
java.util.List<TiffField>	getDirectoryEntries()
java.lang.String	getElementDescription()
java.lang.Object	getFieldValue(TagInfo tag)
java.lang.String[]	getFieldValue(TagInfoAscii tag, boolean mustExist)
byte	getFieldValue(TagInfoByte tag)
byte[]	getFieldValue(TagInfoBytes tag, boolean mustExist)
double	getFieldValue(TagInfoDouble tag)
double[]	getFieldValue(TagInfoDoubles tag, boolean mustExist)
float	getFieldValue(TagInfoFloat tag)
float[]	getFieldValue(TagInfoFloats tag, boolean mustExist)
java.lang.String	getFieldValue(TagInfoGpsText tag, boolean mustExist)
int	getFieldValue(TagInfoLong tag)
int[]	getFieldValue(TagInfoLongs tag, boolean mustExist)
RationalNumber	getFieldValue(TagInfoRational tag)
RationalNumber[]	getFieldValue(TagInfoRationals tag, boolean mustExist)
byte	getFieldValue(TagInfoSByte tag)
byte[]	getFieldValue(TagInfoSBytes tag, boolean mustExist)
short	getFieldValue(TagInfoShort tag)
int[]	getFieldValue(TagInfoShortOrLong tag, boolean mustExist)
short[]	getFieldValue(TagInfoShorts tag, boolean mustExist)
int	getFieldValue(TagInfoSLong tag)
int[]	getFieldValue(TagInfoSLongs tag, boolean mustExist)
RationalNumber	getFieldValue(TagInfoSRational tag)
RationalNumber[]	getFieldValue(TagInfoSRationals tag, boolean mustExist)
short	getFieldValue(TagInfoSShort tag)
short[]	getFieldValue(TagInfoSShorts tag, boolean mustExist)
java.lang.String	getFieldValue(TagInfoXpString tag, boolean mustExist)
JpegImageData	getJpegImageData()
TiffDirectory.ImageDataElement	getJpegRawImageDataElement()
long	getNextDirectoryOffset()
AbstractTiffRasterData	getRasterData(TiffImagingParameters params)	Reads the numerical data stored in this TIFF directory, if available.
private java.util.List<TiffDirectory.ImageDataElement>	getRawImageDataElements(TiffField offsetsField, TiffField byteCountsField)
java.lang.String	getSingleFieldValue(TagInfoAscii tag)
int	getSingleFieldValue(TagInfoShortOrLong tag)
java.awt.image.BufferedImage	getTiffImage()	Gets the image associated with the directory, if any.
java.awt.image.BufferedImage	getTiffImage(java.nio.ByteOrder byteOrder)	Gets the image associated with the directory, if any.
java.awt.image.BufferedImage	getTiffImage(java.nio.ByteOrder byteOrder, TiffImagingParameters params)	Gets the image associated with the directory, if any.
java.awt.image.BufferedImage	getTiffImage(TiffImagingParameters params)	Gets the image associated with the directory, if any.
AbstractTiffImageData	getTiffImageData()
java.util.List<TiffDirectory.ImageDataElement>	getTiffRawImageDataElements()
boolean	hasJpegImageData()
boolean	hasTiffFloatingPointRasterData()	Indicates whether the directory definition specifies a float-point data format.
boolean	hasTiffImageData()
boolean	hasTiffRasterData()	Indicates whether the content associated with the directory is given in a supported numerical-data format.
boolean	imageDataInStrips()
java.util.Iterator<TiffField>	iterator()
void	setJpegImageData(JpegImageData value)
void	setTiffImageData(AbstractTiffImageData rawImageData)
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

entries

private final java.util.List<TiffField> entries

headerByteOrder

private final java.nio.ByteOrder headerByteOrder

Preserves the byte order derived from the TIFF file header. Some of the legacy methods in this class require byte order as an argument, though that use could be phased out eventually.

jpegImageData

private JpegImageData jpegImageData

nextDirectoryOffset

private final long nextDirectoryOffset

abstractTiffImageData

private AbstractTiffImageData abstractTiffImageData

type

public final int type

Constructor Detail

TiffDirectory

public TiffDirectory(int type,
                     java.util.List<TiffField> entries,
                     long offset,
                     long nextDirectoryOffset,
                     java.nio.ByteOrder byteOrder)

Method Detail

description

public static java.lang.String description(int type)

description

public java.lang.String description()

dump

public void dump()

findField

public TiffField findField(TagInfo tag)
                    throws ImagingException

Throws:

ImagingException

findField

public TiffField findField(TagInfo tag,
                           boolean failIfMissing)
                    throws ImagingException

Throws:

ImagingException

getByteOrder

public java.nio.ByteOrder getByteOrder()

Gets the byte order used by the source file for storing this directory and its content.

Returns:

A valid byte order instance.

getDirectoryEntries

public java.util.List<TiffField> getDirectoryEntries()

getElementDescription

public java.lang.String getElementDescription()

Specified by:

getElementDescription in class AbstractTiffElement

getFieldValue

public java.lang.Object getFieldValue(TagInfo tag)
                               throws ImagingException

Throws:

ImagingException

getFieldValue

public java.lang.String[] getFieldValue(TagInfoAscii tag,
                                        boolean mustExist)
                                 throws ImagingException

Throws:

ImagingException

getFieldValue

public byte getFieldValue(TagInfoByte tag)
                   throws ImagingException

Throws:

ImagingException

getFieldValue

public byte[] getFieldValue(TagInfoBytes tag,
                            boolean mustExist)
                     throws ImagingException

Throws:

ImagingException

getFieldValue

public double getFieldValue(TagInfoDouble tag)
                     throws ImagingException

Throws:

ImagingException

getFieldValue

public double[] getFieldValue(TagInfoDoubles tag,
                              boolean mustExist)
                       throws ImagingException

Throws:

ImagingException

getFieldValue

public float getFieldValue(TagInfoFloat tag)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public float[] getFieldValue(TagInfoFloats tag,
                             boolean mustExist)
                      throws ImagingException

Throws:

ImagingException

getFieldValue

public java.lang.String getFieldValue(TagInfoGpsText tag,
                                      boolean mustExist)
                               throws ImagingException

Throws:

ImagingException

getFieldValue

public int getFieldValue(TagInfoLong tag)
                  throws ImagingException

Throws:

ImagingException

getFieldValue

public int[] getFieldValue(TagInfoLongs tag,
                           boolean mustExist)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public RationalNumber getFieldValue(TagInfoRational tag)
                             throws ImagingException

Throws:

ImagingException

getFieldValue

public RationalNumber[] getFieldValue(TagInfoRationals tag,
                                      boolean mustExist)
                               throws ImagingException

Throws:

ImagingException

getFieldValue

public byte getFieldValue(TagInfoSByte tag)
                   throws ImagingException

Throws:

ImagingException

getFieldValue

public byte[] getFieldValue(TagInfoSBytes tag,
                            boolean mustExist)
                     throws ImagingException

Throws:

ImagingException

getFieldValue

public short getFieldValue(TagInfoShort tag)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public int[] getFieldValue(TagInfoShortOrLong tag,
                           boolean mustExist)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public short[] getFieldValue(TagInfoShorts tag,
                             boolean mustExist)
                      throws ImagingException

Throws:

ImagingException

getFieldValue

public int getFieldValue(TagInfoSLong tag)
                  throws ImagingException

Throws:

ImagingException

getFieldValue

public int[] getFieldValue(TagInfoSLongs tag,
                           boolean mustExist)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public RationalNumber getFieldValue(TagInfoSRational tag)
                             throws ImagingException

Throws:

ImagingException

getFieldValue

public RationalNumber[] getFieldValue(TagInfoSRationals tag,
                                      boolean mustExist)
                               throws ImagingException

Throws:

ImagingException

getFieldValue

public short getFieldValue(TagInfoSShort tag)
                    throws ImagingException

Throws:

ImagingException

getFieldValue

public short[] getFieldValue(TagInfoSShorts tag,
                             boolean mustExist)
                      throws ImagingException

Throws:

ImagingException

getFieldValue

public java.lang.String getFieldValue(TagInfoXpString tag,
                                      boolean mustExist)
                               throws ImagingException

Throws:

ImagingException

getJpegImageData

public JpegImageData getJpegImageData()

getJpegRawImageDataElement

public TiffDirectory.ImageDataElement getJpegRawImageDataElement()
                                                          throws ImagingException

Throws:

ImagingException

getNextDirectoryOffset

public long getNextDirectoryOffset()

getRasterData

public AbstractTiffRasterData getRasterData(TiffImagingParameters params)
                                     throws ImagingException,
                                            java.io.IOException

Reads the numerical data stored in this TIFF directory, if available. Note that this method is defined only for TIFF directories that contain floating-point data or two-byte signed integer data.

TIFF directories that provide numerical data do not directly specify images, though it is possible to interpret the data as an image using this library. TIFF files may contain multiple directories which are allowed to have different formats. Thus it is possible for a TIFF file to contain a mix of image and floating-point raster data.

If desired, sub-image data can be read from the file by using a Java Map instance to specify the subsection of the image that is required. The following code illustrates the approach:

 int x; // coordinate (column) of corner of sub-image
 int y; // coordinate (row) of corner of sub-image
 int width; // width of sub-image
 int height; // height of sub-image

 Map<String, Object> params = new HashMap<>();
 params.put(TiffConstants.PARAM_KEY_SUBIMAGE_X, x);
 params.put(TiffConstants.PARAM_KEY_SUBIMAGE_Y, y);
 params.put(TiffConstants.PARAM_KEY_SUBIMAGE_WIDTH, width);
 params.put(TiffConstants.PARAM_KEY_SUBIMAGE_HEIGHT, height);
 TiffRasterData raster = directory.readFloatingPointRasterData(params);
 

Parameters:

params - an optional parameter map instance

Returns:

a valid instance

Throws:

ImagingException - in the event of incompatible or malformed data

java.io.IOException - in the event of an I/O error

getRawImageDataElements

private java.util.List<TiffDirectory.ImageDataElement> getRawImageDataElements(TiffField offsetsField,
                                                                               TiffField byteCountsField)
                                                                        throws ImagingException

Throws:

ImagingException

getSingleFieldValue

public java.lang.String getSingleFieldValue(TagInfoAscii tag)
                                     throws ImagingException

Throws:

ImagingException

getSingleFieldValue

public int getSingleFieldValue(TagInfoShortOrLong tag)
                        throws ImagingException

Throws:

ImagingException

getTiffImage

public java.awt.image.BufferedImage getTiffImage()
                                          throws ImagingException,
                                                 java.io.IOException

Gets the image associated with the directory, if any. Note that not all directories contain images.

Returns:

if successful, a valid BufferedImage instance.

Throws:

ImagingException - in the event of an invalid or incompatible data format.

java.io.IOException - in the event of an I/O error.

getTiffImage

public java.awt.image.BufferedImage getTiffImage(java.nio.ByteOrder byteOrder)
                                          throws ImagingException,
                                                 java.io.IOException

Gets the image associated with the directory, if any. Note that not all directories contain images.

This method comes from an older version of this class in which byte order was required from an external source. Developers are encouraged to use the simpler version of getTiffImage that does not require the byte-order argument.

Parameters:

byteOrder - byte-order obtained from the containing TIFF file

Returns:

if successful, a valid BufferedImage instance.

Throws:

ImagingException - in the event of an invalid or incompatible data format.

java.io.IOException - in the event of an I/O error.

getTiffImage

public java.awt.image.BufferedImage getTiffImage(java.nio.ByteOrder byteOrder,
                                                 TiffImagingParameters params)
                                          throws ImagingException,
                                                 java.io.IOException

Gets the image associated with the directory, if any. Note that not all directories contain images.

This method comes from an older version of this class in which byte order was required from an external source. Developers are encouraged to use the simpler version of getTiffImage that does not require the byte-order argument.

Parameters:

byteOrder - byte-order obtained from the containing TIFF file

params - an object containing optional parameters to be applied to the read operation.

Returns:

if successful, a valid BufferedImage instance.

Throws:

ImagingException - in the event of an invalid or incompatible data format.

java.io.IOException - in the event of an I/O error.

getTiffImage

public java.awt.image.BufferedImage getTiffImage(TiffImagingParameters params)
                                          throws ImagingException,
                                                 java.io.IOException

Gets the image associated with the directory, if any. Note that not all directories contain images.

The optional parameters object can be used to specify image access or rendering options such as reading only a part of the overall image (i.e. reading a sub-image) or applying a custom photometric interpreter.

Parameters:

params - an object containing optional parameters to be applied to the read operation.

Returns:

if successful, a valid BufferedImage instance.

Throws:

ImagingException - in the event of an invalid or incompatible data format.

java.io.IOException - in the event of an I/O error.

getTiffImageData

public AbstractTiffImageData getTiffImageData()

getTiffRawImageDataElements

public java.util.List<TiffDirectory.ImageDataElement> getTiffRawImageDataElements()
                                                                           throws ImagingException

Throws:

ImagingException

hasJpegImageData

public boolean hasJpegImageData()
                         throws ImagingException

Throws:

ImagingException

hasTiffFloatingPointRasterData

public boolean hasTiffFloatingPointRasterData()
                                       throws ImagingException

Indicates whether the directory definition specifies a float-point data format.

Returns:

true if the directory contains floating point data; otherwise, false

Throws:

ImagingException - in the event of an invalid or malformed specification.

hasTiffImageData

public boolean hasTiffImageData()
                         throws ImagingException

Throws:

ImagingException

hasTiffRasterData

public boolean hasTiffRasterData()
                          throws ImagingException

Indicates whether the content associated with the directory is given in a supported numerical-data format. If this method returns true, the Imaging API will be able to extract a TiffRasterData instance from the associated TIFF file using this directory.

Returns:

true if the directory contains a supported raster data format; otherwise, false.

Throws:

ImagingException - in the event of an invalid or malformed specification.

imageDataInStrips

public boolean imageDataInStrips()
                          throws ImagingException

Throws:

ImagingException

iterator

public java.util.Iterator<TiffField> iterator()

Specified by:

iterator in interface java.lang.Iterable<TiffField>

setJpegImageData

public void setJpegImageData(JpegImageData value)

setTiffImageData

public void setTiffImageData(AbstractTiffImageData rawImageData)

size

public int size()