org.geotools.image.io
Class RawBinaryImageReadParam

java.lang.Object
  javax.imageio.IIOParam
      javax.imageio.ImageReadParam
          org.geotools.image.io.RawBinaryImageReadParam

Deprecated. Use Sun's RAW decoder provided with "Java Advanced Imaging Image I/O Tools" instead. Download at http://java.sun.com/products/java-media/jai/.

public class RawBinaryImageReadParam

extends javax.imageio.ImageReadParam

A class describing how a raw binary stream is to be decoded. In the context of RawBinaryImageReader, the stream may not contains enough information for an optimal decoding. For example the stream may not contains image's width and height. The RawBinaryImageReadParam gives a chance to specify those missing informations.

Version:

$Id: RawBinaryImageReadParam.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

Field Summary

Fields inherited from class javax.imageio.ImageReadParam

canSetSourceRenderSize, destination, destinationBands, minProgressivePass, numProgressivePasses, sourceRenderSize

Fields inherited from class javax.imageio.IIOParam

controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset

Constructor Summary

RawBinaryImageReadParam()
Deprecated. Construct a new RawBinaryImageReadParam with default parameters.

Method Summary

double	getPadValue() Deprecated. Returns the pad value, or Double.NaN if there is none
int	getStreamDataType() Deprecated. Returns the data type in input stream, or DataBuffer.TYPE_UNDEFINED if unknow.
java.awt.Dimension	getStreamImageSize() Deprecated. Returns the image size in the input stream, or null if unknow.
java.awt.image.SampleModel	getStreamSampleModel() Deprecated. Returns a sample model indicating the data layout in the input stream.
void	setDestinationType(int destType) Deprecated. Sets the desired image type for the destination image, using one of DataBuffer enumeration constant.
void	setPadValue(double padValue) Deprecated. Set the pad value.
void	setStreamDataType(int dataType) Deprecated. Specify the data type in input stream.
void	setStreamImageSize(java.awt.Dimension size) Deprecated. Specify the image size in the input stream.
void	setStreamSampleModel(java.awt.image.SampleModel model) Deprecated. Set a sample model indicating the data layout in the input stream.

Methods inherited from class javax.imageio.ImageReadParam

canSetSourceRenderSize, getDestination, getDestinationBands, getSourceMaxProgressivePass, getSourceMinProgressivePass, getSourceNumProgressivePasses, getSourceRenderSize, setDestination, setDestinationBands, setDestinationType, setSourceProgressivePasses, setSourceRenderSize

Methods inherited from class javax.imageio.IIOParam

activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setSourceBands, setSourceRegion, setSourceSubsampling

Methods inherited from class java.lang.Object

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

Constructor Detail

RawBinaryImageReadParam

public RawBinaryImageReadParam()

Deprecated.

Construct a new RawBinaryImageReadParam with default parameters.

Method Detail

setStreamImageSize

public void setStreamImageSize(java.awt.Dimension size)

Deprecated.

Specify the image size in the input stream. Setting the size to null reset the default size, which is reader dependent. Most readers will thrown an exception at reading time if the image size is unspecified.

Parameters:

size - The expected image size, or null if unknow.

getStreamImageSize

public java.awt.Dimension getStreamImageSize()

Deprecated.

Returns the image size in the input stream, or null if unknow. Image size is specified by the last call to setStreamImageSize(java.awt.Dimension) or setStreamSampleModel(java.awt.image.SampleModel).

setStreamDataType

public void setStreamDataType(int dataType)

Deprecated.

Specify the data type in input stream. Setting data type to DataBuffer.TYPE_UNDEFINED reset the default value, which is reader dependent.

Parameters:

dataType - The data type, or DataBuffer.TYPE_UNDEFINED if unknow. Know data type should be a constant from DataBuffer. Common types are DataBuffer.TYPE_INT, DataBuffer.TYPE_FLOAT and DataBuffer.TYPE_DOUBLE.

getStreamDataType

public int getStreamDataType()

Deprecated.

Returns the data type in input stream, or DataBuffer.TYPE_UNDEFINED if unknow. Data type is specified by the last call to setStreamDataType(int) or setStreamSampleModel(java.awt.image.SampleModel).

setDestinationType

public void setDestinationType(int destType)

Deprecated.

Sets the desired image type for the destination image, using one of DataBuffer enumeration constant. This setting will override any previous setting made with ImageReadParam.setDestinationType(ImageTypeSpecifier) or this setDestinationType(int) method.

Parameters:

destType - The data type. This should be a constant from DataBuffer. Common types are DataBuffer.TYPE_INT, DataBuffer.TYPE_FLOAT and DataBuffer.TYPE_DOUBLE.

setPadValue

public void setPadValue(double padValue)

Deprecated.

Set the pad value.

Parameters:

padValue - The pad value, or Double.NaN if there is none.

getPadValue

public double getPadValue()

Deprecated.

Returns the pad value, or Double.NaN if there is none

setStreamSampleModel

public void setStreamSampleModel(java.awt.image.SampleModel model)

Deprecated.

Set a sample model indicating the data layout in the input stream. Indications comprise image size and data type, i.e. calling this method with a non-null value is equivalent to calling also the following methods:

 setStreamImageSize(model.getWidth(), model.getHeight());
 setStreamDataType(model.getDataType());
 

Setting the sample model to null reset the default model, which is reader dependent.

getStreamSampleModel

public java.awt.image.SampleModel getStreamSampleModel()

Deprecated.

Returns a sample model indicating the data layout in the input stream. The SampleModel's width and height should matches the image size in the input stream.

Returns:

A sample model indicating the data layout in the input stream, or null if unknow.