Class RawImageWriter

java.lang.Object

javax.imageio.ImageWriter

com.github.jaiimageio.impl.plugins.raw.RawImageWriter

All Implemented Interfaces:

ImageTranscoder

public class RawImageWriter
extends ImageWriter

The Java Image IO plugin writer for encoding a binary RenderedImage into a Raw format.

The encoding process may clip, subsample or select bands using the parameters specified in the ImageWriteParam. Thus, when read this raw image the proper image data type should be provided.

See Also:

• invalid reference

  com.github.jaiimageio.plugins.RawImageWriteParam

Field Summary

Fields

Modifier and Type	Field	Description
private int	bandStride	The strides for pixel, band, and scanline.
private Rectangle	destinationRegion
private int	imageIndex	The image index in this stream.
private RenderedImage	input	The source raster if write raster.
private Raster	inputRaster	The input source raster.
private int	lineStride	The strides for pixel, band, and scanline.
private boolean	noSubband
private boolean	noTransform	Coordinate transform or sub selection is needed before encoding.
private int	numBands	The number of components in the image
private boolean	optimal	Whether can write optimally.
private int	pxlStride	The strides for pixel, band, and scanline.
private SampleModel	sampleModel
private int	scaleX	The source -> destination transformation
private int	scaleY	The source -> destination transformation
private int[]	sourceBands	The source bands to be encoded.
private ImageOutputStream	stream	The output stream to write into
private int	tileHeight	The tile height for encoding
private int	tileWidth	The tile width for encoding
private int	tileXOffset	The tile grid offset for encoding
private int	tileYOffset	The tile grid offset for encoding
private boolean	writeRaster	Indicates a raster rather than a RenderedImage to be encoded.
private int	xOffset	The source -> destination transformation
private int	yOffset	The source -> destination transformation

Fields inherited from class ImageWriter

availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales

Constructor Summary

Constructors

Constructor	Description
RawImageWriter(ImageWriterSpi originator)	Constructs RawImageWriter based on the provided ImageWriterSpi.

Method Summary

Modifier and Type	Method	Description
boolean	canWriteRasters()
IIOMetadata	convertImageMetadata(IIOMetadata metadata, ImageTypeSpecifier type, ImageWriteParam param)
IIOMetadata	convertStreamMetadata(IIOMetadata inData, ImageWriteParam param)
IIOMetadata	getDefaultImageMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)
IIOMetadata	getDefaultStreamMetadata(ImageWriteParam param)
ImageWriteParam	getDefaultWriteParam()
int	getHeight()
private int	getMaxTileX()
private int	getMaxTileY()
private int	getMinTileX()
private int	getMinTileY()
private Raster	getTile(int tileX, int tileY)
int	getWidth()
private int	mapToSourceX(int x)
private int	mapToSourceY(int y)
void	reset()
void	setOutput(Object output)
private static int	ToTile(int pos, int tileOffset, int tileSize)
void	write(IIOMetadata streamMetadata, IIOImage image, ImageWriteParam param)
private void	writeRaster(Raster raster)

Methods inherited from class ImageWriter

abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canInsertEmpty, canInsertImage, canRemoveImage, canReplaceImageMetadata, canReplacePixels, canReplaceStreamMetadata, canWriteEmpty, canWriteSequence, clearAbortRequest, dispose, endInsertEmpty, endReplacePixels, endWriteEmpty, endWriteSequence, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, prepareInsertEmpty, prepareReplacePixels, prepareWriteEmpty, prepareWriteSequence, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replacePixels, replacePixels, replaceStreamMetadata, setLocale, write, write, writeInsert, writeToSequence

Methods inherited from class Object

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

Field Details

stream

private ImageOutputStream stream

The output stream to write into

imageIndex

private int imageIndex

The image index in this stream.

tileWidth

private int tileWidth

The tile width for encoding

tileHeight

private int tileHeight

The tile height for encoding

tileXOffset

private int tileXOffset

The tile grid offset for encoding

tileYOffset

private int tileYOffset

The tile grid offset for encoding

scaleX

private int scaleX

The source -> destination transformation

scaleY

private int scaleY

The source -> destination transformation

xOffset

private int xOffset

The source -> destination transformation

yOffset

private int yOffset

The source -> destination transformation

sourceBands

private int[] sourceBands

The source bands to be encoded.

numBands

private int numBands

The number of components in the image

input

private RenderedImage input

The source raster if write raster.

inputRaster

private Raster inputRaster

The input source raster.

destinationRegion

private Rectangle destinationRegion

sampleModel

private SampleModel sampleModel

noTransform

private boolean noTransform

Coordinate transform or sub selection is needed before encoding.

noSubband

private boolean noSubband

writeRaster

private boolean writeRaster

Indicates a raster rather than a RenderedImage to be encoded.

optimal

private boolean optimal

Whether can write optimally.

pxlStride

private int pxlStride

The strides for pixel, band, and scanline.

lineStride

private int lineStride

The strides for pixel, band, and scanline.

bandStride

private int bandStride

The strides for pixel, band, and scanline.

Constructor Details

RawImageWriter

public RawImageWriter(ImageWriterSpi originator)

Constructs RawImageWriter based on the provided ImageWriterSpi.

Method Details

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 metadata,
 ImageTypeSpecifier type,
 ImageWriteParam param)

Specified by:

convertImageMetadata in interface ImageTranscoder

Specified by:

convertImageMetadata in class ImageWriter

canWriteRasters

public boolean canWriteRasters()

Overrides:

canWriteRasters in class ImageWriter

getDefaultWriteParam

public ImageWriteParam getDefaultWriteParam()

Overrides:

getDefaultWriteParam in class ImageWriter

write

public void write(IIOMetadata streamMetadata,
 IIOImage image,
 ImageWriteParam param)
           throws IOException

Specified by:

write in class ImageWriter

Throws:

IOException

getWidth

public int getWidth()

getHeight

public int getHeight()

writeRaster

private void writeRaster(Raster raster)
                  throws IOException

Throws:

IOException

getTile

private Raster getTile(int tileX,
 int tileY)

mapToSourceX

private int mapToSourceX(int x)

mapToSourceY

private int mapToSourceY(int y)

getMinTileX

private int getMinTileX()

getMaxTileX

private int getMaxTileX()

getMinTileY

private int getMinTileY()

getMaxTileY

private int getMaxTileY()

ToTile

private static int ToTile(int pos,
 int tileOffset,
 int tileSize)

reset

public void reset()

Overrides:

reset in class ImageWriter