com.esri.arcgis.datasourcesraster
Interface IPixelBlock2

All Superinterfaces:
Serializable
All Known Implementing Classes:
IPixelBlock2Proxy, PixelBlock

public interface IPixelBlock2
extends Serializable

Provides access to members that control a PixelBlock.

Superseded By

IPixelBlock3

Remarks

Recomment to use IPixelBlock3 interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 int getBytesPerPixel()
          The number of bytes per pixel for the PixelBlock.
 int getHeight()
          The height of the PixelBlock in pixels.
 int getPixelType(int plane)
          The pixel type of the PixelBlock.
 int getPlanes()
          The number of pixel arrays contained in the PixelBlock.
 Object getSafeArrayByRef(int plane)
          A variant SafeArray of pixels for a specified plane.
 Object getVal(int plane, int x, int y)
          The value for a specified pixel.
 int getWidth()
          The width of the PixelBlock in pixels.
 void setPixelType(int plane, int pVal)
          The pixel type of the PixelBlock.
 

Method Detail

getPlanes

int getPlanes()
              throws IOException,
                     AutomationException
The number of pixel arrays contained in the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getWidth

int getWidth()
             throws IOException,
                    AutomationException
The width of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHeight

int getHeight()
              throws IOException,
                     AutomationException
The height of the PixelBlock in pixels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getPixelType

int getPixelType(int plane)
                 throws IOException,
                        AutomationException
The pixel type of the PixelBlock.

Product Availability

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

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

setPixelType

void setPixelType(int plane,
                  int pVal)
                  throws IOException,
                         AutomationException
The pixel type of the PixelBlock.

Product Availability

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

Parameters:
plane - The plane (in)
pVal - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBytesPerPixel

int getBytesPerPixel()
                     throws IOException,
                            AutomationException
The number of bytes per pixel for the PixelBlock.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSafeArrayByRef

Object getSafeArrayByRef(int plane)
                         throws IOException,
                                AutomationException
A variant SafeArray of pixels for a specified plane.

Product Availability

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

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

getVal

Object getVal(int plane,
              int x,
              int y)
              throws IOException,
                     AutomationException
The value for a specified pixel.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
plane - The plane (in)
x - The x (in)
y - The y (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.