TIFFImageWriter (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- javax.imageio.ImageWriter
- - io.scif.media.imageioimpl.plugins.tiff.TIFFImageWriter

All Implemented Interfaces:: ImageTranscoder

public class TIFFImageWriter
extends ImageWriter

Field Summary

Fields
Modifier and Type	Field and Description
`static int[]`	`compressionNumbers` Compression tag values for known compression types.
`static String[]`	`compressionTypes` Known TIFF compression types.
`static int`	`DEFAULT_BYTES_PER_STRIP`
`static boolean[]`	`isCompressionLossless` Lossless flag for known compression types.
`static String[]`	`TIFFCompressionTypes` Supported TIFF compression types.

Fields inherited from class javax.imageio.ImageWriter
availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales

Constructor Summary

Constructors
Constructor and Description

TIFFImageWriter(ImageWriterSpi originatingProvider)

Constructors
Constructor and Description
`TIFFImageWriter(ImageWriterSpi originatingProvider)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canInsertEmpty(int imageIndex)`
`boolean`	`canInsertImage(int imageIndex)`
`boolean`	`canReplacePixels(int imageIndex)`
`boolean`	`canWriteEmpty()`
`boolean`	`canWriteSequence()`
`IIOMetadata`	`convertImageMetadata(IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param)`
`IIOMetadata`	`convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)`
`void`	`dispose()`
`void`	`endInsertEmpty()`
`void`	`endReplacePixels()`
`void`	`endWriteEmpty()`
`void`	`endWriteSequence()`
`IIOMetadata`	`getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)`
`IIOMetadata`	`getDefaultStreamMetadata(ImageWriteParam param)`
`ImageWriteParam`	`getDefaultWriteParam()`
`void`	`prepareInsertEmpty(int imageIndex, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List thumbnails, ImageWriteParam param)`
`void`	`prepareReplacePixels(int imageIndex, Rectangle region)`
`void`	`prepareWriteEmpty(IIOMetadata streamMetadata, ImageTypeSpecifier imageType, int width, int height, IIOMetadata imageMetadata, List thumbnails, ImageWriteParam param)`
`void`	`prepareWriteSequence(IIOMetadata streamMetadata)`
`void`	`replacePixels(Raster raster, ImageWriteParam param)`
`void`	`replacePixels(RenderedImage image, ImageWriteParam param)`
`void`	`reset()`
`void`	`setOutput(Object output)`
`void`	`write(IIOMetadata sm, IIOImage iioimage, ImageWriteParam p)`
`void`	`writeInsert(int imageIndex, IIOImage image, ImageWriteParam param)`
`void`	`writeToSequence(IIOImage image, ImageWriteParam param)`
`static int`	`XToTileX(int x, int tileGridXOffset, int tileWidth)` Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
`static int`	`YToTileY(int y, int tileGridYOffset, int tileHeight)` Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DEFAULT_BYTES_PER_STRIP
```
public static final int DEFAULT_BYTES_PER_STRIP
```
  See Also:
  
  Constant Field Values
- TIFFCompressionTypes
```
public static final String[] TIFFCompressionTypes
```
  Supported TIFF compression types.
- compressionTypes
```
public static final String[] compressionTypes
```
  Known TIFF compression types.
- isCompressionLossless
```
public static final boolean[] isCompressionLossless
```
  Lossless flag for known compression types.
- compressionNumbers
```
public static final int[] compressionNumbers
```
  Compression tag values for known compression types.

Constructor Detail

TIFFImageWriter

public TIFFImageWriter(ImageWriterSpi originatingProvider)

Method Detail

XToTileX
```
public static int XToTileX(int x,
                           int tileGridXOffset,
                           int tileWidth)
```
Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
If tileWidth < 0, the results of this method are undefined. If tileWidth == 0, an ArithmeticException will be thrown.

Throws:

ArithmeticException - If tileWidth == 0.

YToTileY
```
public static int YToTileY(int y,
                           int tileGridYOffset,
                           int tileHeight)
```
Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.
If tileHeight < 0, the results of this method are undefined. If tileHeight == 0, an ArithmeticException will be thrown.

Throws:

ArithmeticException - If tileHeight == 0.

getDefaultWriteParam
```
public ImageWriteParam getDefaultWriteParam()
```
Overrides:

getDefaultWriteParam in class ImageWriter

setOutput
```
public void setOutput(Object output)
```
Overrides:

setOutput in class ImageWriter

getDefaultStreamMetadata
```
public IIOMetadata getDefaultStreamMetadata(ImageWriteParam param)
```
Specified by:

getDefaultStreamMetadata in class ImageWriter

getDefaultImageMetadata

public IIOMetadata getDefaultImageMetadata(ImageTypeSpecifier imageType,
                                           ImageWriteParam param)

Specified by:: getDefaultImageMetadata in class ImageWriter

convertStreamMetadata

public IIOMetadata convertStreamMetadata(IIOMetadata inData,
                                         ImageWriteParam param)

Specified by:: convertStreamMetadata in interface ImageTranscoder
Specified by:: convertStreamMetadata in class ImageWriter

convertImageMetadata

public IIOMetadata convertImageMetadata(IIOMetadata inData,
                                        ImageTypeSpecifier imageType,
                                        ImageWriteParam param)

Specified by:: convertImageMetadata in interface ImageTranscoder
Specified by:: convertImageMetadata in class ImageWriter

write

public void write(IIOMetadata sm,
                  IIOImage iioimage,
                  ImageWriteParam p)
           throws IOException

Specified by:: write in class ImageWriter
Throws:: IOException

canWriteSequence
```
public boolean canWriteSequence()
```
Overrides:

canWriteSequence in class ImageWriter

prepareWriteSequence

public void prepareWriteSequence(IIOMetadata streamMetadata)
                          throws IOException

Overrides:: prepareWriteSequence in class ImageWriter
Throws:: IOException

writeToSequence

public void writeToSequence(IIOImage image,
                            ImageWriteParam param)
                     throws IOException

Overrides:: writeToSequence in class ImageWriter
Throws:: IOException

endWriteSequence
```
public void endWriteSequence()
                      throws IOException
```
Overrides:

endWriteSequence in class ImageWriter

Throws:

IOException

canInsertImage

public boolean canInsertImage(int imageIndex)
                       throws IOException

Overrides:: canInsertImage in class ImageWriter
Throws:: IOException

writeInsert

public void writeInsert(int imageIndex,
                        IIOImage image,
                        ImageWriteParam param)
                 throws IOException

Overrides:: writeInsert in class ImageWriter
Throws:: IOException

canInsertEmpty

public boolean canInsertEmpty(int imageIndex)
                       throws IOException

Overrides:: canInsertEmpty in class ImageWriter
Throws:: IOException

canWriteEmpty

public boolean canWriteEmpty()
                      throws IOException

Overrides:: canWriteEmpty in class ImageWriter
Throws:: IOException

prepareInsertEmpty

public void prepareInsertEmpty(int imageIndex,
                               ImageTypeSpecifier imageType,
                               int width,
                               int height,
                               IIOMetadata imageMetadata,
                               List thumbnails,
                               ImageWriteParam param)
                        throws IOException

Overrides:: prepareInsertEmpty in class ImageWriter
Throws:: IOException

prepareWriteEmpty

public void prepareWriteEmpty(IIOMetadata streamMetadata,
                              ImageTypeSpecifier imageType,
                              int width,
                              int height,
                              IIOMetadata imageMetadata,
                              List thumbnails,
                              ImageWriteParam param)
                       throws IOException

Overrides:: prepareWriteEmpty in class ImageWriter
Throws:: IOException

endInsertEmpty
```
public void endInsertEmpty()
                    throws IOException
```
Overrides:

endInsertEmpty in class ImageWriter

Throws:

IOException

endWriteEmpty
```
public void endWriteEmpty()
                   throws IOException
```
Overrides:

endWriteEmpty in class ImageWriter

Throws:

IOException

canReplacePixels

public boolean canReplacePixels(int imageIndex)
                         throws IOException

Overrides:: canReplacePixels in class ImageWriter
Throws:: IOException

prepareReplacePixels

public void prepareReplacePixels(int imageIndex,
                                 Rectangle region)
                          throws IOException

Overrides:: prepareReplacePixels in class ImageWriter
Throws:: IOException

replacePixels

public void replacePixels(RenderedImage image,
                          ImageWriteParam param)
                   throws IOException

Overrides:: replacePixels in class ImageWriter
Throws:: IOException

replacePixels

public void replacePixels(Raster raster,
                          ImageWriteParam param)
                   throws IOException

Overrides:: replacePixels in class ImageWriter
Throws:: IOException

endReplacePixels
```
public void endReplacePixels()
                      throws IOException
```
Overrides:

endReplacePixels in class ImageWriter

Throws:

IOException

reset
```
public void reset()
```
Overrides:

reset in class ImageWriter

dispose
```
public void dispose()
```
Overrides:

dispose in class ImageWriter

Class TIFFImageWriter

Field Summary

Fields inherited from class javax.imageio.ImageWriter

Constructor Summary

Method Summary

Methods inherited from class javax.imageio.ImageWriter

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BYTES_PER_STRIP

TIFFCompressionTypes

compressionTypes

isCompressionLossless

compressionNumbers

Constructor Detail

TIFFImageWriter

Method Detail

XToTileX

YToTileY

getDefaultWriteParam

setOutput

getDefaultStreamMetadata

getDefaultImageMetadata

convertStreamMetadata

convertImageMetadata

write

canWriteSequence

prepareWriteSequence

writeToSequence

endWriteSequence

canInsertImage

writeInsert

canInsertEmpty

canWriteEmpty

prepareInsertEmpty

prepareWriteEmpty

endInsertEmpty

endWriteEmpty

canReplacePixels

prepareReplacePixels

replacePixels

replacePixels

endReplacePixels

reset

dispose