com.esri.arcgis.datasourcesraster
Interface IRasterFunction

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArithmeticFunction, AspectFunction, ClipFunction, ColormapFunction, ColormapToRGBFunction, ColorspaceConversionFunction, ComplexFunction, CompositeBandFunction, ConstantFunction, ConvolutionFunction, ExcludedAreaFunction, ExtractBandFunction, FootprintFunction, GeometricFunction, GrayscaleFunction, HillshadeFunction, IdentityFunction, MaskFunction, MLClassifyFunction, MosaicFunction, MosaicRastersFunction, NDVIFunction, PansharpeningFunction, RasterFunctionCollection, RasterFunctionTemplate, RasterInfoFunction, RemapFunction, RGB32Function, RGB32ToRGBFunction, SAIFunction, ShadedReliefFunction, SlopeFunction, SpectralConversionFunction, StatisticsFunction, StretchFunction, TrendFunction

public interface IRasterFunction
extends Serializable

Provides access to members that control a raster function.

Product Availability

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

Method Summary

void	bind(Object pArguments) Binds function arguments to this raster function.
String	getDescription() The raster function description.
String	getName() The raster function name.
int	getPixelType() The output pixel type.
IRasterInfo	getRasterInfo() The raster information after this function is applied to an object.
boolean	isValid() Indicates if this function is valid, e.g.
void	read(IPnt pTlc, IRaster pRaster, IPixelBlock pPixelBlock) Reads a pixel block starting from the top left corner.
void	setDescription(String pDescription) The raster function description.
void	setName(String pName) The raster function name.
void	setPixelType(int pPixelType) The output pixel type.
void	update() Updates using newly available information from bound object.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The raster function name.

Product Availability

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

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pName)
             throws IOException,
                    AutomationException

The raster function name.

Product Availability

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

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The raster function description.

Product Availability

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

Returns:

The pDescription

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String pDescription)
                    throws IOException,
                           AutomationException

The raster function description.

Product Availability

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

Parameters:

pDescription - The pDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
                 throws IOException,
                        AutomationException

The output 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.

setPixelType

void setPixelType(int pPixelType)
                  throws IOException,
                         AutomationException

The output pixel type.

Product Availability

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

Parameters:

pPixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bind

void bind(Object pArguments)
          throws IOException,
                 AutomationException

Binds function arguments to this 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.

isValid

boolean isValid()
                throws IOException,
                       AutomationException

Indicates if this function is valid, e.g. bound to an object, and etc.

Product Availability

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

Returns:

The pValid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update()
            throws IOException,
                   AutomationException

Updates using newly available information from bound object.

Product Availability

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

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,
          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)

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.