J2KReadState (Bio-Formats API)

java.lang.Object
- com.sun.media.imageioimpl.plugins.jpeg2000.J2KReadState

public class J2KReadState
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`private int[]`	`bandOffsets`
`private BitstreamReaderAgent`	`breader`
`private byte[]`	`bytebuf`
`private int[]`	`channelMap`
`private ColorModel`	`colorModel`
`private ImgDataConverter`	`converter`
`private ImgDataConverter`	`converter2`
`private DataBlkInt[]`	`dataBlocks`
`private DecoderSpecs`	`decSpec`
`private Dequantizer`	`deq`
`private BufferedImage`	`destImage`
`private int[]`	`destinationBands`
`private Rectangle`	`destinationRegion`
`private EntropyDecoder`	`entdec`
`private FileFormatReader`	`ff`
`private int[]`	`fracBits`
`private HeaderDecoder`	`hd`
`private int`	`height`
`private HeaderInfo`	`hi`
`private InvCompTransf`	`ictransf`
`private ImageInputStream`	`iis` The input stream we read from
`private RandomAccessIO`	`in`
`private InverseWT`	`invWT`
`private boolean`	`isSigned`
`private J2KImageReadParamJava`	`j2krparam`
`private int[]`	`levelShift`
`private int`	`maxDepth`
`private int[]`	`maxValues`
`private J2KMetadata`	`metadata`
`private int[]`	`minValues`
`private int`	`nComp`
`private boolean`	`noTransform`
`private int[]`	`pixbuf`
`private J2KImageReader`	`reader` Cache the `J2KImageReader` which creates this object.
`private int`	`resolution` The resolution level requested.
`private ROIDeScaler`	`roids`
`private SampleModel`	`sampleModel`
`private int`	`scaleX` Source to destination transform
`private int`	`scaleY` Source to destination transform
`private int[]`	`sourceBands`
`private Point`	`sourceOrigin`
`private int`	`stepX` The subsampling step sizes.
`private int`	`stepY` The subsampling step sizes.
`private int`	`tileHeight`
`private int`	`tileStepX` Tile step sizes.
`private int`	`tileStepY` Tile step sizes.
`private int`	`tileWidth`
`private int`	`tileXOffset` Tile grid offsets of the source, also used for destination.
`private int`	`tileYOffset` Tile grid offsets of the source, also used for destination.
`private int`	`width`
`private int`	`xOffset` Source to destination transform
`private int`	`yOffset` Source to destination transform

Constructor Summary

Constructors
Constructor and Description
`J2KReadState(ImageInputStream iis, J2KImageReadParamJava param, J2KImageReader reader)` Constructs `J2KReadState`.
`J2KReadState(ImageInputStream iis, J2KImageReadParamJava param, J2KMetadata metadata, J2KImageReader reader)` Constructs `J2KReadState`.

Method Summary

Methods
Modifier and Type	Method and Description
`private int`	`clip(int value, int min, int max)`
`private void`	`clipDestination(Rectangle dest)`
`ColorModel`	`getColorModel()`
`Rectangle`	`getDestinationRegion()`
`HeaderDecoder`	`getHeader()`
`int`	`getHeight()`
`ImageTypeSpecifier`	`getImageType()`
`SampleModel`	`getSampleModel()`
`Raster`	`getTile(int tileX, int tileY, WritableRaster raster)`
`(package private) Rectangle`	`getTile0Rect()` Returns the bounding rectangle of the upper left tile at the current resolution level.
`int`	`getWidth()`
`private void`	`initializeRead(int imageIndex, J2KImageReadParamJava param, J2KMetadata metadata)`
`Raster`	`readAsRaster()`
`BufferedImage`	`readBufferedImage()`
`private Raster`	`readSubsampledRaster(WritableRaster raster)`

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

Field Detail

iis
```
private ImageInputStream iis
```
The input stream we read from

ff
```
private FileFormatReader ff
```

hi
```
private HeaderInfo hi
```

hd
```
private HeaderDecoder hd
```

in
```
private RandomAccessIO in
```

breader
```
private BitstreamReaderAgent breader
```

entdec
```
private EntropyDecoder entdec
```

roids
```
private ROIDeScaler roids
```

deq
```
private Dequantizer deq
```

invWT
```
private InverseWT invWT
```

ictransf
```
private InvCompTransf ictransf
```

converter
```
private ImgDataConverter converter
```

converter2
```
private ImgDataConverter converter2
```

decSpec
```
private DecoderSpecs decSpec
```

j2krparam

private J2KImageReadParamJava j2krparam

destinationBands
```
private int[] destinationBands
```

sourceBands
```
private int[] sourceBands
```

levelShift
```
private int[] levelShift
```

minValues
```
private int[] minValues
```

maxValues
```
private int[] maxValues
```

fracBits
```
private int[] fracBits
```

dataBlocks
```
private DataBlkInt[] dataBlocks
```

bandOffsets
```
private int[] bandOffsets
```

maxDepth
```
private int maxDepth
```

isSigned
```
private boolean isSigned
```

colorModel
```
private ColorModel colorModel
```

sampleModel
```
private SampleModel sampleModel
```

nComp
```
private int nComp
```

tileWidth
```
private int tileWidth
```

tileHeight
```
private int tileHeight
```

scaleX
```
private int scaleX
```
Source to destination transform

scaleY
```
private int scaleY
```
Source to destination transform

xOffset
```
private int xOffset
```
Source to destination transform

yOffset
```
private int yOffset
```
Source to destination transform

destinationRegion
```
private Rectangle destinationRegion
```

sourceOrigin
```
private Point sourceOrigin
```

tileXOffset
```
private int tileXOffset
```
Tile grid offsets of the source, also used for destination.

tileYOffset
```
private int tileYOffset
```
Tile grid offsets of the source, also used for destination.

width
```
private int width
```

height
```
private int height
```

pixbuf
```
private int[] pixbuf
```

bytebuf
```
private byte[] bytebuf
```

channelMap
```
private int[] channelMap
```

noTransform
```
private boolean noTransform
```

resolution
```
private int resolution
```
The resolution level requested.

stepX
```
private int stepX
```
The subsampling step sizes.

stepY
```
private int stepY
```
The subsampling step sizes.

tileStepX
```
private int tileStepX
```
Tile step sizes.

tileStepY
```
private int tileStepY
```
Tile step sizes.

metadata
```
private J2KMetadata metadata
```

destImage
```
private BufferedImage destImage
```

reader
```
private J2KImageReader reader
```
Cache the J2KImageReader which creates this object. This variable is used to monitor the abortion.

Constructor Detail
- J2KReadState
```
public J2KReadState(ImageInputStream iis,
            J2KImageReadParamJava param,
            J2KMetadata metadata,
            J2KImageReader reader)
```
  Constructs J2KReadState.
  
  Parameters:
  iis - The input stream.
  param - The reading parameters.
  metadata - The J2KMetadata to cache the metadata read from the input stream.
  reader - The J2KImageReader which holds this state. It is necessary for processing abortion.
  
  Throws:
  
  IllegalArgumentException - If the provided iis, param or metadata is null.
- J2KReadState
```
public J2KReadState(ImageInputStream iis,
            J2KImageReadParamJava param,
            J2KImageReader reader)
```
  Constructs J2KReadState.
  
  Parameters:
  iis - The input stream.
  param - The reading parameters.
  reader - The J2KImageReader which holds this state. It is necessary for processing abortion.
  
  Throws:
  
  IllegalArgumentException - If the provided iis, or param is null.

Method Detail

getWidth

public int getWidth()
             throws IOException

Throws:: IOException

getHeight

public int getHeight()
              throws IOException

Throws:: IOException

getHeader
```
public HeaderDecoder getHeader()
```

getTile

public Raster getTile(int tileX,
             int tileY,
             WritableRaster raster)
               throws IOException

Throws:: IOException

getDestinationRegion

public Rectangle getDestinationRegion()

readBufferedImage

public BufferedImage readBufferedImage()
                                throws IOException

Throws:: IOException

readAsRaster

public Raster readAsRaster()
                    throws IOException

Throws:: IOException

initializeRead

private void initializeRead(int imageIndex,
                  J2KImageReadParamJava param,
                  J2KMetadata metadata)

readSubsampledRaster

private Raster readSubsampledRaster(WritableRaster raster)
                             throws IOException

Throws:: IOException

getImageType

public ImageTypeSpecifier getImageType()
                                throws IOException

Throws:: IOException

getSampleModel
```
public SampleModel getSampleModel()
```

getColorModel
```
public ColorModel getColorModel()
```

getTile0Rect
```
Rectangle getTile0Rect()
```
Returns the bounding rectangle of the upper left tile at the current resolution level.

clip

private int clip(int value,
       int min,
       int max)

clipDestination

private void clipDestination(Rectangle dest)

Class J2KReadState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

iis

ff

hi

hd

in

breader

entdec

roids

deq

invWT

ictransf

converter

converter2

decSpec

j2krparam

destinationBands

sourceBands

levelShift

minValues

maxValues

fracBits

dataBlocks

bandOffsets

maxDepth

isSigned

colorModel

sampleModel

nComp

tileWidth

tileHeight

scaleX

scaleY

xOffset

yOffset

destinationRegion

sourceOrigin

tileXOffset

tileYOffset

width

height

pixbuf

bytebuf

channelMap

noTransform

resolution

stepX

stepY

tileStepX

tileStepY

metadata

destImage

reader

Constructor Detail

J2KReadState

J2KReadState

Method Detail

getWidth

getHeight

getHeader

getTile

getDestinationRegion

readBufferedImage

readAsRaster

initializeRead

readSubsampledRaster

getImageType

getSampleModel

getColorModel

getTile0Rect

clip

clipDestination