com.esri.arcgis.geodatabase
Interface IPixelBlock

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

public interface IPixelBlock
extends Serializable

Provides access to members that control a PixelBlock.

Remarks

The Height and Width properties return the number of rows and columns in the PixelBlock.

The Planes argument returns the number of bands in the PixelBlock.

The PixelType property specifies the data type and bit depth of the pixels in the specified band.The SafeArray property specifies the variant SafeArray for the specified band. At ArcGIS 9.0, this property returns SafeArray by value, not by reference like it does in ArcGIS 8.x. Your application, if only reads pixel values from SafeArray, will not be affected by this change. However, if your application involves modifying and writing pixel block to the band, you might experience a different behavior. The recommended fix is to use IPixelBlock3::PixelDataByRef method.

The GetVal method returns an individual value for the pixel specified by the band and pixel location input.

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 getSafeArray(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 val)
          The pixel type of the PixelBlock.
 void setSafeArray(int plane, Object val)
          A variant SafeArray of pixels for a specified plane.
 

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 val
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 val
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 val
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 val)
                  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)
val - 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 val
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSafeArray

Object getSafeArray(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.

setSafeArray

void setSafeArray(int plane,
                  Object val)
                  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)
val - A Variant (in)
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.