RawImageReader (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- javax.imageio.ImageReader
- - io.scif.media.imageioimpl.plugins.raw.RawImageReader

```
public class RawImageReader
extends ImageReader
```
This class is the Java Image IO plugin reader for Raw images. It may subsample the image, clip the image, select sub-bands, and shift the decoded image origin if the proper decoding parameter are set in the provided PNMImageReadParam.

Field Summary
- Fields inherited from class javax.imageio.ImageReader
  availableLocales, ignoreMetadata, input, locale, minIndex, originatingProvider, progressListeners, seekForwardOnly, updateListeners, warningListeners, warningLocales

Constructor Summary

Constructors
Constructor and Description

RawImageReader(ImageReaderSpi originator)
Constructs RawImageReader from the provided ImageReaderSpi.

Constructors
Constructor and Description
`RawImageReader(ImageReaderSpi originator)` Constructs `RawImageReader` from the provided `ImageReaderSpi`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canReadRaster()`
`static void`	`computeRegionsWrapper(ImageReadParam param, int srcWidth, int srcHeight, BufferedImage image, Rectangle srcRegion, Rectangle destRegion)` Wrapper for the protected method `computeRegions`.
`boolean`	`getAbortRequest()` This method wraps the protected method `abortRequested` to allow the abortions be monitored by `J2KReadState`.
`ImageReadParam`	`getDefaultReadParam()`
`int`	`getHeight(int imageIndex)`
`IIOMetadata`	`getImageMetadata(int imageIndex)`
`Iterator`	`getImageTypes(int imageIndex)`
`int`	`getNumImages(boolean allowSearch)` Overrides the method defined in the superclass.
`IIOMetadata`	`getStreamMetadata()`
`int`	`getTileHeight(int imageIndex)`
`int`	`getTileWidth(int imageIndex)`
`int`	`getWidth(int imageIndex)`
`boolean`	`isRandomAccessEasy(int imageIndex)`
`void`	`processImageProgressWrapper(float percentageDone)` Wrapper for the protected method `processImageProgress` So it can be access from the classes which are not in `ImageReader` hierachy.
`void`	`processImageUpdateWrapper(BufferedImage theImage, int minX, int minY, int width, int height, int periodX, int periodY, int[] bands)` Wrapper for the protected method `processImageUpdate` So it can be access from the classes which are not in `ImageReader` hierachy.
`BufferedImage`	`read(int imageIndex, ImageReadParam param)`
`RenderedImage`	`readAsRenderedImage(int imageIndex, ImageReadParam param)`
`Raster`	`readRaster(int imageIndex, ImageReadParam param)`
`void`	`reset()`
`void`	`setInput(Object input, boolean seekForwardOnly, boolean ignoreMetadata)` Overrides the method defined in the superclass.

Methods inherited from class javax.imageio.ImageReader
abort, abortRequested, addIIOReadProgressListener, addIIOReadUpdateListener, addIIOReadWarningListener, checkReadParamBandSettings, clearAbortRequest, computeRegions, dispose, getAspectRatio, getAvailableLocales, getDestination, getFormatName, getImageMetadata, getInput, getLocale, getMinIndex, getNumThumbnails, getOriginatingProvider, getRawImageType, getSourceRegion, getStreamMetadata, getThumbnailHeight, getThumbnailWidth, getTileGridXOffset, getTileGridYOffset, hasThumbnails, isIgnoringMetadata, isImageTiled, isSeekForwardOnly, processImageComplete, processImageProgress, processImageStarted, processImageUpdate, processPassComplete, processPassStarted, processReadAborted, processSequenceComplete, processSequenceStarted, processThumbnailComplete, processThumbnailPassComplete, processThumbnailPassStarted, processThumbnailProgress, processThumbnailStarted, processThumbnailUpdate, processWarningOccurred, processWarningOccurred, read, readAll, readAll, readerSupportsThumbnails, readThumbnail, readTile, readTileRaster, removeAllIIOReadProgressListeners, removeAllIIOReadUpdateListeners, removeAllIIOReadWarningListeners, removeIIOReadProgressListener, removeIIOReadUpdateListener, removeIIOReadWarningListener, setInput, setInput, setLocale

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

Constructor Detail
- RawImageReader
```
public RawImageReader(ImageReaderSpi originator)
```
  Constructs RawImageReader from the provided ImageReaderSpi.

Method Detail

computeRegionsWrapper

public static void computeRegionsWrapper(ImageReadParam param,
                                         int srcWidth,
                                         int srcHeight,
                                         BufferedImage image,
                                         Rectangle srcRegion,
                                         Rectangle destRegion)

Wrapper for the protected method computeRegions. So it can be access from the classes which are not in ImageReader hierachy.

setInput

public void setInput(Object input,
                     boolean seekForwardOnly,
                     boolean ignoreMetadata)

Overrides the method defined in the superclass.

Overrides:: setInput in class ImageReader

getNumImages
```
public int getNumImages(boolean allowSearch)
                 throws IOException
```
Overrides the method defined in the superclass.

Specified by:

getNumImages in class ImageReader

Throws:

IOException

getWidth

public int getWidth(int imageIndex)
             throws IOException

Specified by:: getWidth in class ImageReader
Throws:: IOException

getHeight

public int getHeight(int imageIndex)
              throws IOException

Specified by:: getHeight in class ImageReader
Throws:: IOException

getTileWidth

public int getTileWidth(int imageIndex)
                 throws IOException

Overrides:: getTileWidth in class ImageReader
Throws:: IOException

getTileHeight

public int getTileHeight(int imageIndex)
                  throws IOException

Overrides:: getTileHeight in class ImageReader
Throws:: IOException

getImageTypes

public Iterator getImageTypes(int imageIndex)
                       throws IOException

Specified by:: getImageTypes in class ImageReader
Throws:: IOException

getDefaultReadParam
```
public ImageReadParam getDefaultReadParam()
```
Overrides:

getDefaultReadParam in class ImageReader

getImageMetadata

public IIOMetadata getImageMetadata(int imageIndex)
                             throws IOException

Specified by:: getImageMetadata in class ImageReader
Throws:: IOException

getStreamMetadata

public IIOMetadata getStreamMetadata()
                              throws IOException

Specified by:: getStreamMetadata in class ImageReader
Throws:: IOException

isRandomAccessEasy

public boolean isRandomAccessEasy(int imageIndex)
                           throws IOException

Overrides:: isRandomAccessEasy in class ImageReader
Throws:: IOException

read

public BufferedImage read(int imageIndex,
                          ImageReadParam param)
                   throws IOException

Specified by:: read in class ImageReader
Throws:: IOException

readAsRenderedImage

public RenderedImage readAsRenderedImage(int imageIndex,
                                         ImageReadParam param)
                                  throws IOException

Overrides:: readAsRenderedImage in class ImageReader
Throws:: IOException

readRaster

public Raster readRaster(int imageIndex,
                         ImageReadParam param)
                  throws IOException

Overrides:: readRaster in class ImageReader
Throws:: IOException

canReadRaster
```
public boolean canReadRaster()
```
Overrides:

canReadRaster in class ImageReader

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

reset in class ImageReader

processImageUpdateWrapper

public void processImageUpdateWrapper(BufferedImage theImage,
                                      int minX,
                                      int minY,
                                      int width,
                                      int height,
                                      int periodX,
                                      int periodY,
                                      int[] bands)

Wrapper for the protected method processImageUpdate So it can be access from the classes which are not in ImageReader hierachy.

processImageProgressWrapper
```
public void processImageProgressWrapper(float percentageDone)
```
Wrapper for the protected method processImageProgress So it can be access from the classes which are not in ImageReader hierachy.

getAbortRequest
```
public boolean getAbortRequest()
```
This method wraps the protected method abortRequested to allow the abortions be monitored by J2KReadState.

Class RawImageReader

Field Summary

Fields inherited from class javax.imageio.ImageReader

Constructor Summary

Method Summary

Methods inherited from class javax.imageio.ImageReader

Methods inherited from class java.lang.Object

Constructor Detail

RawImageReader