com.esri.arcgis.datasourcesraster
Interface IRasterFunctionHelper

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRasterFunctionHelperProxy, RasterFunctionHelper

public interface IRasterFunctionHelper
extends Serializable

Provides access to members that control a raster function helper.

Product Availability

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

Method Summary

void	bind(Object pArguments) Binds function arguments to the associated raster function.
void	createRaster(IRaster pRaster, IRaster pReferenceRaster, ILongArray[] ppBandIDs, IRaster[] ppNewRaster) Creates a new raster using a given reference raster.
IRaster	getRaster() The current source raster.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
int	getReferenceProperties() The properties to be used in reference raster.
boolean	isResampling() Indicates if this raster source wants to perform resampling.
boolean	isSupportBandSelection() Indicates if this function supports band selection.
void	read(IPnt pTlc, IRaster pRaster, IRaster pReferenceRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	setReferenceProperties(int pReferenceProperties) The properties to be used in reference raster.
void	setResampling(boolean pResampling) Indicates if this raster source wants to perform resampling.
void	setSupportBandSelection(boolean pSupportBandSelection) Indicates if this function supports band selection.

Method Detail

bind

void bind(Object pArguments)
          throws IOException,
                 AutomationException

Binds function arguments to the associated raster function.

Product Availability

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

Parameters:

pArguments - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo()
                          throws IOException,
                                 AutomationException

The raster information after this function is applied to an object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

read

void read(IPnt pTlc,
          IRaster pRaster,
          IRaster pReferenceRaster,
          IPixelBlock pPixelBlock)
          throws IOException,
                 AutomationException

Reads a pixel block starting from the top left corner.

Product Availability

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

Parameters:

pTlc - A reference to a com.esri.arcgis.geodatabase.IPnt (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pReferenceRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (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.

isResampling

boolean isResampling()
                     throws IOException,
                            AutomationException

Indicates if this raster source wants to perform resampling.

Product Availability

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

Returns:

The pResampling

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResampling

void setResampling(boolean pResampling)
                   throws IOException,
                          AutomationException

Indicates if this raster source wants to perform resampling.

Product Availability

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

Parameters:

pResampling - The pResampling (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceProperties

int getReferenceProperties()
                           throws IOException,
                                  AutomationException

The properties to be used in reference raster.

Product Availability

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

Returns:

The pReferenceProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceProperties

void setReferenceProperties(int pReferenceProperties)
                            throws IOException,
                                   AutomationException

The properties to be used in reference raster.

Product Availability

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

Parameters:

pReferenceProperties - The pReferenceProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportBandSelection

boolean isSupportBandSelection()
                               throws IOException,
                                      AutomationException

Indicates if this function supports band selection.

Product Availability

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

Returns:

The pSupportBandSelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportBandSelection

void setSupportBandSelection(boolean pSupportBandSelection)
                             throws IOException,
                                    AutomationException

Indicates if this function supports band selection.

Product Availability

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

Parameters:

pSupportBandSelection - The pSupportBandSelection (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRaster

void createRaster(IRaster pRaster,
                  IRaster pReferenceRaster,
                  ILongArray[] ppBandIDs,
                  IRaster[] ppNewRaster)
                  throws IOException,
                         AutomationException

Creates a new raster using a given reference raster.

Product Availability

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

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

pReferenceRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

ppBandIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

ppNewRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRaster

IRaster getRaster()
                  throws IOException,
                         AutomationException

The current source raster.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IRaster

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.