com.esri.arcgis.datasourcesraster

Interface IRasterFunction

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ArgStatisticsFunction, ArithmeticFunction, AspectFunction, BandArithmeticFunction, CachedRasterFunction, ClassifyFunction, ClipFunction, ColormapFunction, ColormapToRGBFunction, ColorspaceConversionFunction, ComplexFunction, CompositeBandFunction, ComputeChangeFunction, ConstantFunction, ContourFunction, ContrastBrightnessFunction, ConvolutionFunction, CreateColorCompositeFunction, CurvatureFunction, DownsampleFunction, ElevationVoidFillFunction, ExcludedAreaFunction, ExtractBandFunction, FootprintFunction, GeometricFunction, GeometricMedianFunction, GradientFunction, GrayscaleFunction, HillshadeFunction, IdentityFunction, InterpolateIrregularDataFunction, InterpolateRasterByDimensionFunction, IRasterFunctionProxy, KauthThomasFunction, LasDatasetToRasterFunction, LasToRasterFunction, MaskFunction, MergeRastersFunction, MosaicFunction, MosaicRastersFunction, MultidimensionalFilterFunction, MultidimensionalRasterFunction, NDVIFunction, PanSharpenGramSchmidtFunction, PansharpeningFunction, PredictUsingRegressionFunction, PyramidFunction, PythonAdapterFunction, RadarCalibrationFunction, RandomFunction, RasterFunctionCollection, RasterFunctionTemplate, RasterInfoFunction, RasterItemFunction, RasterizeFeatureClassFunction, RecastFunction, RedactionFunction, ReflectanceFunction, RegionGrowFunction, RegionPixelCountFunction, RemapFunction, RemoveHazeFunction, RenderedRasterFunction, ReprojectFunction, ResampleFunction, RGB32Function, RGB32ToRGBFunction, RGBToColormapFunction, RJPEGFunction, S1RadiometricCalibrationFunction, S1ThermalNoiseRemovalFunction, SAIFunction, SARIndicesFunction, SegmentMeanShiftFunction, SegmentToIndexFunction, ShadedReliefFunction, SimpleCollectionFunction, SlopeFunction, SpeckleFunction, SpectralAngleMapperFunction, SpectralConversionFunction, SpectralUnmixingFunction, StatisticsFunction, StatisticsHistogramFunction, StretchFunction, SwathFunction, TableFunction, TerrainFlattenFunction, TerrainToRasterFunction, ThermalNoiseRemovalFunction, ThresholdFunction, TransposeBitsFunction, TrendFunction, UnitConversionFunction, VectorFieldFunction

public interface IRasterFunction
extends java.io.Serializable

COM Interface 'IRasterFunction'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control a raster function.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	bind(java.lang.Object pArguments) Binds function arguments to this raster function.
java.lang.String	getDescription() The raster function description.
java.lang.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(java.lang.String pDescription) The raster function description.
void	setName(java.lang.String pName) The raster function name.
void	setPixelType(int pPixelType) The output pixel type.
void	update() Updates using newly available information from bound object.

Field Detail

IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e

static final int IIDcf7b7f99_3698_4f1f_aff8_e3430e106b1e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()
                  throws java.io.IOException,
                         AutomationException

The raster function name.

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String pName)
      throws java.io.IOException,
             AutomationException

The raster function name.

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                         throws java.io.IOException,
                                AutomationException

The raster function description.

Returns:

The pDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String pDescription)
             throws java.io.IOException,
                    AutomationException

The raster function description.

Parameters:

pDescription - The pDescription (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPixelType

int getPixelType()
          throws java.io.IOException,
                 AutomationException

The output pixel type.

Returns:

A com.esri.arcgis.geodatabase.rstPixelType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPixelType

void setPixelType(int pPixelType)
           throws java.io.IOException,
                  AutomationException

The output pixel type.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bind

void bind(java.lang.Object pArguments)
   throws java.io.IOException,
          AutomationException

Binds function arguments to this raster function.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
         throws java.io.IOException,
                AutomationException

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

Returns:

The pValid

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

update

void update()
     throws java.io.IOException,
            AutomationException

Updates using newly available information from bound object.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterInfo

IRasterInfo getRasterInfo()
                   throws java.io.IOException,
                          AutomationException

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

read

void read(IPnt pTlc,
          IRaster pRaster,
          IPixelBlock pPixelBlock)
   throws java.io.IOException,
          AutomationException

Reads a pixel block starting from the top left corner.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.