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

Class TiffImageParser

    • Field Detail

      • DEFAULT_EXTENSION

        private static final java.lang.String DEFAULT_EXTENSION

      • ACCEPTED_EXTENSIONS

        private static final java.lang.String[] ACCEPTED_EXTENSIONS

    • Constructor Detail

      • TiffImageParser

        public TiffImageParser()
        Constructs a new instance with the big-endian byte order.

    • Method Detail

      • dumpImageFile

        public boolean dumpImageFile​(java.io.PrintWriter pw,
                             ByteSource byteSource)
                      throws ImagingException,
                             java.io.IOException
        Description copied from class: AbstractImageParser
        Writes the ImageInfo and format-specific information for the image content of the specified byte source to a PrintWriter
        Overrides:
        dumpImageFile in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        pw - print writer used for writing the ImageInfo
        byteSource - A valid byte source.
        Returns:
        A valid PrintWriter.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • getAllBufferedImages

        public java.util.List<java.awt.image.BufferedImage> getAllBufferedImages​(ByteSource byteSource)
                                                                  throws ImagingException,
                                                                         java.io.IOException
        Description copied from class: AbstractImageParser
        Gets all images specified by the byte source (some formats may include multiple images within a single data source).
        Overrides:
        getAllBufferedImages in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid instance of ByteSource.
        Returns:
        A valid (potentially empty) list of BufferedImage objects.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • getBufferedImage

        public java.awt.image.BufferedImage getBufferedImage​(ByteSource byteSource,
                                                     TiffImagingParameters params)
                                              throws ImagingException,
                                                     java.io.IOException

        Gets a buffered image specified by the byte source. The TiffImageParser class features support for a number of options that are unique to the TIFF format. These options can be specified by supplying the appropriate parameters using the keys from the TiffConstants class and the params argument for this method.

        Loading Partial Images

        The TIFF parser includes support for loading partial images without committing significantly more memory resources than are necessary to store the image. This feature is useful for conserving memory in applications that require a relatively small sub image from a very large TIFF file. The specifications for partial images are as follows: 

         TiffImagingParameters params = new TiffImagingParameters();
 params.setSubImageX(x);
 params.setSubImageY(y);
 params.setSubImageWidth(width);
 params.setSubImageHeight(height);

        Note that the arguments x, y, width, and height must specify a valid rectangular region that is fully contained within the source TIFF image.

        Specified by:
        getBufferedImage in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid instance of ByteSource
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid instance of BufferedImage.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • getDefaultExtension

        public java.lang.String getDefaultExtension()
        Description copied from class: AbstractImageParser
        Gets the default extension for the format specified by an implementation of ImageParser. Some parsers can support more than one extension (i.e. .JPEG, .JPG; .TIF, .TIFF, etc.).
        Specified by:
        getDefaultExtension in class AbstractImageParser<TiffImagingParameters>
        Returns:
        A valid string.

      • getIccProfileBytes

        public byte[] getIccProfileBytes​(ByteSource byteSource,
                                 TiffImagingParameters params)
                          throws ImagingException,
                                 java.io.IOException
        Description copied from class: AbstractImageParser
        Gets an array of bytes describing the International Color Consortium (ICC) specification for the color space of the image contained in the input byteSource. Not all formats support ICC profiles.
        Specified by:
        getIccProfileBytes in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid ByteSource.
        params - Optional instructions for special-handling or interpretation of the input data.
        Returns:
        If available, a valid array of bytes; otherwise, a null
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • getImageInfo

        public ImageInfo getImageInfo​(ByteSource byteSource,
                              TiffImagingParameters params)
                       throws ImagingException,
                              java.io.IOException
        Description copied from class: AbstractImageParser
        Gets image information from the specified ByteSource. Format-specific ImageParser implementations are expected to return a valid ImageInfo object or to throw an ImageReadException if unable to process the specified data.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

        Specified by:
        getImageInfo in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid ByteSource object
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid image information object describing the content extracted from the specified data.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful data access operation.

      • getImageSize

        public java.awt.Dimension getImageSize​(ByteSource byteSource,
                                       TiffImagingParameters params)
                                throws ImagingException,
                                       java.io.IOException
        Description copied from class: AbstractImageParser
        Gets the size of the image described by the specified ByteSource.
        Specified by:
        getImageSize in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid reference to a ByteSource.
        params - Optional instructions for special-handling or interpretation of the input data.
        Returns:
        A valid instance of Dimension.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • getMetadata

        public ImageMetadata getMetadata​(ByteSource byteSource,
                                 TiffImagingParameters params)
                          throws ImagingException,
                                 java.io.IOException
        Description copied from class: AbstractImageParser
        Gets image metadata from the specified byte source. Format-specific ImageParser implementations are expected to return a valid IImageMetadata object or to throw an ImageReadException if unable to process the specified byte source.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will require this capability. Because the base class may call this method with a null params argument, implementations should always include logic for ignoring null input.

        Specified by:
        getMetadata in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        byteSource - A valid byte source.
        params - Optional instructions for special-handling or interpretation of the input data (null objects are permitted and must be supported by implementations).
        Returns:
        A valid, potentially subject-matter-specific implementation of the IImageMetadata interface describing the content extracted from the source content.
        Throws:
        ImagingException - In the event that the ByteSource content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful data read operation.

      • getRasterData

        AbstractTiffRasterData getRasterData​(TiffDirectory directory,
                                     java.nio.ByteOrder byteOrder,
                                     TiffImagingParameters params)
                              throws ImagingException,
                                     java.io.IOException
        Reads the content of a TIFF file that contains numerical data samples rather than image-related pixels.

        If desired, sub-image data can be read from the file by using a Java TiffImagingParameters 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

 TiffImagingParameters params = new TiffImagingParameters();
 params.setSubImageX(x);
 params.setSubImageY(y);
 params.setSubImageWidth(width);
 params.setSubImageHeight(height);
 TiffRasterData raster = readFloatingPointRasterData(directory, byteOrder, params);
        Parameters:
        directory - the TIFF directory pointing to the data to be extracted (TIFF files may contain multiple directories)
        byteOrder - the byte order of the data to be extracted
        params - an optional parameter object 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

      • getXmpXml

        public java.lang.String getXmpXml​(ByteSource byteSource,
                                  XmpImagingParameters<TiffImagingParameters> params)
                           throws ImagingException,
                                  java.io.IOException
        Description copied from interface: XmpEmbeddable
        Gets a string containing XML conforming to the Extensible Metadata Platform (XMP) standard for representing information about image content. Not all image formats support XMP information and even for those that do, there is no guarantee that such information will be present in an image.
        Specified by:
        getXmpXml in interface XmpEmbeddable<TiffImagingParameters>
        Parameters:
        byteSource - A valid reference to a ByteSource.
        params - Optional instructions for special-handling or interpretation of the input data.
        Returns:
        If XMP metadata is present, a valid string; if it is not present, a null.
        Throws:
        ImagingException - In the event that the specified content does not conform to the format of the specific parser implementation.
        java.io.IOException - In the event of unsuccessful read or access operation.

      • writeImage

        public void writeImage​(java.awt.image.BufferedImage src,
                       java.io.OutputStream os,
                       TiffImagingParameters params)
                throws ImagingException,
                       java.io.IOException
        Description copied from class: AbstractImageParser
        Writes the content of a BufferedImage to the specified output stream.

        The params argument provides a mechanism for individual implementations to pass optional information into the parser. Not all formats will support this capability. Currently, some of the parsers do not check for null arguments.

        Overrides:
        writeImage in class AbstractImageParser<TiffImagingParameters>
        Parameters:
        src - An image giving the source content for output
        os - A valid output stream for storing the formatted image
        params - optional parameters, defining format-specific instructions for output (such as selections for data compression, color models, etc.)
        Throws:
        ImagingException - In the event that the output format cannot handle the input image or invalid params are specified.
        java.io.IOException - In the event of an write error from the output stream.