com.esri.arcgis.datasourcesraster
Interface IPixelBlock3

All Superinterfaces:

Serializable

All Known Implementing Classes:

IPixelBlock3Proxy, PixelBlock

public interface IPixelBlock3
extends Serializable

Provides access to members that control a PixelBlock.

Description

The IPixelBlock3 interface provides all the functionality of IPixelBlock interface, plus more properties on mask based NoData and SafeArray handling.

Basically, there are two ways to work with NoData mask and pixel values. They are by value (PixelData and NoDataMask properties) and by reference (PixelDataByRef and NoDataMaskByRef). Normally passing pixel values by reference is recommented since it saves memory. However for Java and .Net, passing by value (PixelData) should be used.

Product Availability

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

Method Summary

void	clear(int plane) Clears a given plane (sets to NoData).
int	getBytesPerPixel() The number of bytes per pixel for the PixelBlock.
int	getHeight() The height of the PixelBlock in pixels.
Object	getNoDataMask(int plane) The NoData mask for a specified plane.
Object	getNoDataMaskByRef(int plane) The NoData mask for a specified plane.
Object	getNoDataMaskVal(int plane, int x, int y) Gets the NoData mask value for a specified pixel.
Object	getPixelData(int plane) An array of pixels for a specified plane.
Object	getPixelDataByRef(int plane) A pointer to an array of pixels for a specified plane.
int	getPixelType(int plane) The pixel type of the PixelBlock.
int	getPlanes() The number of pixel arrays contained in the PixelBlock.
Object	getVal(int plane, int x, int y) The value for a specified pixel.
int	getWidth() The width of the PixelBlock in pixels.
boolean	hasNoData(int plane) Checks if this PixelBlock contains NoData.
void	mask(Object noData) Generates NoData Mask using a given NoData value.
void	setNoDataMask(int plane, Object pVal) The NoData mask for a specified plane.
void	setPixelData(int plane, Object pVal) An array of pixels for a specified plane.
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.

Remarks

The Planes property returns the number of bands 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.

getPixelData

Object getPixelData(int plane)
                    throws IOException,
                           AutomationException

An array 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.

setPixelData

void setPixelData(int plane,
                  Object pVal)
                  throws IOException,
                         AutomationException

An array of pixels for a specified plane.

Product Availability

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

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelDataByRef

Object getPixelDataByRef(int plane)
                         throws IOException,
                                AutomationException

A pointer to an array 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.

Description

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

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.

setNoDataMask

void setNoDataMask(int plane,
                   Object pVal)
                   throws IOException,
                          AutomationException

The NoData mask for a specified plane.

Product Availability

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

Parameters:

plane - The plane (in)

pVal - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNoDataMask

Object getNoDataMask(int plane)
                     throws IOException,
                            AutomationException

The NoData mask 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.

getNoDataMaskByRef

Object getNoDataMaskByRef(int plane)
                          throws IOException,
                                 AutomationException

The NoData mask 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.

getNoDataMaskVal

Object getNoDataMaskVal(int plane,
                        int x,
                        int y)
                        throws IOException,
                               AutomationException

Gets the NoData mask value for a specified pixel.

Description

The GetNoDataMaskVal property allows you to identify whether a specific pixel is NoData or not. Value 1 means this corresponding pixel has a value and 0 means this corresponding pixel is NoData

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.

hasNoData

boolean hasNoData(int plane)
                  throws IOException,
                         AutomationException

Checks if this PixelBlock contains NoData.

Description

The HasNoData property indicates whether the PixelBlock has NoData or not. True means it has NoData.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

plane - The plane (in)

Returns:

The hasNoData

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear(int plane)
           throws IOException,
                  AutomationException

Clears a given plane (sets to NoData).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

plane - The plane (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

mask

void mask(Object noData)
          throws IOException,
                 AutomationException

Generates NoData Mask using a given NoData value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

noData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.