com.esri.arcgis.datasourcesraster
Interface IPixelReader

All Superinterfaces:
Serializable
All Known Subinterfaces:
IPixelReader2, ISimplePixelReader
All Known Implementing Classes:
IPixelReader2Proxy, IPixelReaderProxy, SimplePixelReader

public interface IPixelReader
extends Serializable

Provides access to members that control a pixel reader.

Superseded By

IPixelReader2

Remarks

IPixelReader is a generic interface that is supported by any pixel reader, which provides pixel reading for RasterXformer.

The concrete pixel reader used in ArcGIS is SimplePixelReader. User can create a custom pixel reader by implementing this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 int getBandCount()
          The number of source bands.
 IPnt getCellSize()
          The source original cell size.
 IEnvelope getExtent()
          The source full extent.
 int getFirstPyramidLevel()
          The first available source pyramid level.
 int getMaximumPyramidLevel()
          The maximum available source pyramid level.
 int getPixelType()
          The source pixel type.
 int getPyramidLevel()
          The current source pyramid level.
 void getResolution(int level, double[] pXResolution, double[] pYResolution)
          Gets X and Y resolution (cellsize) at a given level.
 void read(IPnt tlc, IPixelBlock pPixelBlock)
          Reads a pixel block.
 void setPyramidLevel(int pLevel)
          The current source pyramid level.
 int snap(double dx, double dy)
          Snaps a given cellsize to a proper pyramid level.
 

Method Detail

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException
The source pixel type.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.geodatabase.rstPixelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandCount

int getBandCount()
                 throws IOException,
                        AutomationException
The number of source bands.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pBandCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The source full extent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

IPnt getCellSize()
                 throws IOException,
                        AutomationException
The source original cell size.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geodatabase.IPnt
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumPyramidLevel

int getMaximumPyramidLevel()
                           throws IOException,
                                  AutomationException
The maximum available source pyramid level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pMaxLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFirstPyramidLevel

int getFirstPyramidLevel()
                         throws IOException,
                                AutomationException
The first available source pyramid level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pFirstLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPyramidLevel

int getPyramidLevel()
                    throws IOException,
                           AutomationException
The current source pyramid level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPyramidLevel

void setPyramidLevel(int pLevel)
                     throws IOException,
                            AutomationException
The current source pyramid level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pLevel - The pLevel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

read

void read(IPnt tlc,
          IPixelBlock pPixelBlock)
          throws IOException,
                 AutomationException
Reads a pixel block.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
tlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)
pPixelBlock - A reference to a com.esri.arcgis.geodatabase.IPixelBlock (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

snap

int snap(double dx,
         double dy)
         throws IOException,
                AutomationException
Snaps a given cellsize to a proper pyramid level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
dx - The dx (in)
dy - The dy (in)
Returns:
The pLevel
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResolution

void getResolution(int level,
                   double[] pXResolution,
                   double[] pYResolution)
                   throws IOException,
                          AutomationException
Gets X and Y resolution (cellsize) at a given level.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
level - The level (in)
pXResolution - The pXResolution (out: use single element array)
pYResolution - The pYResolution (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.