com.esri.arcgis.geoanalyst
Class RasterInterpolationOp

java.lang.Object
  extended by com.esri.arcgis.geoanalyst.RasterInterpolationOp
All Implemented Interfaces:
IGeoAnalysisEnvironment, IInterpolationOp, IInterpolationOp2, IInterpolationOp3, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class RasterInterpolationOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IRasterAnalysisGlobalEnvironment, IRasterOpBase, IInterpolationOp, IInterpolationOp2, IInterpolationOp3, ISupportErrorInfo

Raster interpolation operation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterInterpolationOp()
          Constructs a RasterInterpolationOp using ArcGIS Engine.
RasterInterpolationOp(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterInterpolationOp theRasterInterpolationOp = (RasterInterpolationOp) obj;
 
Method Summary
 void addOutputDatasetName(int index, IDatasetName pOutName)
          Adds an output dataset name to the specified index.
 boolean equals(Object o)
          Compare this object with another
 void getCellSize(int[] envType, double[] cellSize)
          Gets the type and value of cell size in the RasterAnalysis.
static String getClsid()
          getClsid.
 String getDefaultOutputRasterPrefix()
          The default output raster prefix.
 String getDefaultOutputVectorPrefix()
          The default output vector prefix.
 void getExtent(int[] envType, IEnvelope[] extent)
          Gets the type and values of extent in the RasterAnalysis.
 IGeoDataset getMask()
          Mask allows processing to occur only for a selected set of cells.
 ISpatialReference getOutSpatialReference()
          The output spatial reference of GeoAnalysis.
 IWorkspace getOutWorkspace()
          The output workspace of GeoAnalysis.
 int getVerifyType()
          The verify type of the RasterAnalysis.
 int hashCode()
          the hashcode for this object
 IGeoDataset iDW(IGeoDataset geoData, double power, IRasterRadius radius, Object barrier)
          Interpolates using IDW.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAvoidDataConversion()
          Indicates weather to avoid data conversion in the RasterAnalysis.
 IGeoDataset krige(IGeoDataset geoData, int semiVariogramType, IRasterRadius radius, boolean outSemiVariance, Object barrier)
          Interpolates using kriging.
 IGeoDataset naturalNeighbor(IGeoDataset geoDataset)
          Interpolates using natual neighbor.
 void reset()
          Remove all previously stored default rasteranalysis environments.
 void restoreToPreviousDefaultEnvironment()
          Restores to the previous default raster analysis environment.
 void setAsNewDefaultEnvironment()
          Sets the raster analysis environment of the object as new default environment.
 void setAvoidDataConversion(boolean bAvoid)
          Indicates weather to avoid data conversion in the RasterAnalysis.
 void setCellSize(int envType, Object cellSizeProvider)
          Sets the type and value of cell size in the RasterAnalysis.
 void setDefaultOutputRasterPrefix(String rasterPrefix)
          The default output raster prefix.
 void setDefaultOutputVectorPrefix(String vectorPrefix)
          The default output vector prefix.
 void setExtent(int envType, Object extentProvider, Object snapRasterData)
          Sets the type and values of extent in the RasterAnalysis.
 void setMaskByRef(IGeoDataset mask)
          Mask allows processing to occur only for a selected set of cells.
 void setOutputDatasetNameArrayByRef(IArray rhs1)
          Puts output name array.
 void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
          The output spatial reference of GeoAnalysis.
 void setOutWorkspaceByRef(IWorkspace workspace)
          The output workspace of GeoAnalysis.
 void setVerifyType(int verifyType)
          The verify type of the RasterAnalysis.
 IGeoDataset spline(IGeoDataset geoData, int splineType, Object weight, Object numPoints)
          Interpolates using splining.
 IRasterDataset topoToRasterByFile(String paramFile, IFeatureClass[] outStream, IFeatureClass[] outSink)
          Interpolates using AnuDem.
 IGeoDataset trend(IGeoDataset geoData, int trendType, int order)
          Interpolates using trend surface.
 IGeoDataset trendWithRms(IGeoDataset geoData, int trendType, int order, String out_rms_file)
          Interpolates using trend surface with optional rms file.
 IGeoDataset variogram(IGeoDataset geoData, IGeoAnalysisSemiVariogram semiVariogram, IRasterRadius radius, boolean outSemiVariance, Object barrier)
          Interpolates using Variogram.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterInterpolationOp

public RasterInterpolationOp()
                      throws IOException,
                             UnknownHostException
Constructs a RasterInterpolationOp using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterInterpolationOp

public RasterInterpolationOp(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterInterpolationOp theRasterInterpolationOp = (RasterInterpolationOp) obj;

Construct a RasterInterpolationOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterInterpolationOp.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException
Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type

esriRasterEnvMaxOf – The largest cell size of all input raster datasets that are specifed in the function. This is the default.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead.

esriRasterEnvMinOf - Smallest cell size of all input raster datasets.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead

esriRasterEnvValue - Any user specified value for the cell size.

Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
cellSizeProvider - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException
Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType

will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type

esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default.

esriRasterEnvMinOf - smallest cell size of all input datasets

esriRasterEnvValue - User specified value.

cellsize

returns a value that specifying the current environment setting for cellsize

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
cellSize - The cellSize (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException
Sets the type and values of extent in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type

esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

[extentProvider]

An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.

[snapRasterData]

A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
extentProvider - A Variant (in, optional, pass null if not required)
snapRasterData - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException
Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type,

esriRasterEnvMinOf – Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException
Mask allows processing to occur only for a selected set of cells.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskByRef in interface IRasterAnalysisEnvironment
Parameters:
mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException
Mask allows processing to occur only for a selected set of cells.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMask in interface IRasterAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException
The verify type of the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerifyType in interface IRasterAnalysisEnvironment
Parameters:
verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException
The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerifyType in interface IRasterAnalysisEnvironment
Returns:
A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException
The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Returns:
The rasterPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException
The default output raster prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Parameters:
rasterPrefix - The rasterPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException
The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Returns:
The vectorPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException
The default output vector prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Parameters:
vectorPrefix - The vectorPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException
Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException
Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
reset in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException
The output workspace of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutWorkspaceByRef in interface IGeoAnalysisEnvironment
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException
The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutWorkspace in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException
The output spatial reference of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException
The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutSpatialReference in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvoidDataConversion

public void setAvoidDataConversion(boolean bAvoid)
                            throws IOException,
                                   AutomationException
Indicates weather to avoid data conversion in the RasterAnalysis.

Remarks

Setting to false (the default setting) is the same as in versions before ArcGIS 9.4.

Setting the property to True ensures that all processing is performed natively on the raster data. This improves the overall performance as there is no need for the input data to be converted to ESRI grid format. The output data, however, is still temporary rasters in ESRI grid format.

Product Availability

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

Specified by:
setAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment
Parameters:
bAvoid - The bAvoid (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAvoidDataConversion

public boolean isAvoidDataConversion()
                              throws IOException,
                                     AutomationException
Indicates weather to avoid data conversion in the RasterAnalysis.

Product Availability

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

Specified by:
isAvoidDataConversion in interface IRasterAnalysisGlobalEnvironment
Returns:
The bAvoid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addOutputDatasetName

public void addOutputDatasetName(int index,
                                 IDatasetName pOutName)
                          throws IOException,
                                 AutomationException
Adds an output dataset name to the specified index.

Product Availability

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

Specified by:
addOutputDatasetName in interface IRasterOpBase
Parameters:
index - The index (in)
pOutName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputDatasetNameArrayByRef

public void setOutputDatasetNameArrayByRef(IArray rhs1)
                                    throws IOException,
                                           AutomationException
Puts output name array.

Product Availability

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

Specified by:
setOutputDatasetNameArrayByRef in interface IRasterOpBase
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

iDW

public IGeoDataset iDW(IGeoDataset geoData,
                       double power,
                       IRasterRadius radius,
                       Object barrier)
                throws IOException,
                       AutomationException
Interpolates using IDW.

Remarks

geoData

an input FeatureClass or FeatureClassDescriptor containing the points with z values to be interpolated onto a surface Raster

power

exponent of distance. Controls the significance of surrounding points upon the interpolated value. A higher power results in less influence from distant points. It can be any real number greater than zero but the most reasonable results will be obtained using values from 0.5 to 3. A commonly used power is 2

radius

an IRasterRadius indicating the search radius for the input points. The radius distance is specified in map units within which all input sample points will be used to perform interpolation. A commonly used radius is five times the cell size of the output Raster

The object will set and use whatever you set last in your VB script. For example,

set pRad.SetFixed 207.1

set pRad.SetVariable 12

will use the args ... ,SAMPLE,12, ....

set pRad.SetVariable 12

set pRad.SetFixed 207.1

will use the args ... ,RADIUS,207.1, ....

[barrier]

a shapefile containing arcs to be used as a break or limit in searching for the input sample points

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
iDW in interface IInterpolationOp
Specified by:
iDW in interface IInterpolationOp2
Specified by:
iDW in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
power - The power (in)
radius - A reference to a com.esri.arcgis.geoanalyst.IRasterRadius (in)
barrier - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

krige

public IGeoDataset krige(IGeoDataset geoData,
                         int semiVariogramType,
                         IRasterRadius radius,
                         boolean outSemiVariance,
                         Object barrier)
                  throws IOException,
                         AutomationException
Interpolates using kriging.

Remarks

geoData

an input FeatureClass or FeatureClassDescriptor containing the points with z values to be interpolated onto a surface Raster

semiVariogramType an esriGeoAnalysisSemivariogramEnum specifying the type of mathematical function used to model the semivariance

The types are:

esriGeoAnalysisCircularSemivariogram circular semivariogram model

esriGeoAnalysisExponentialSemivariogram exponential semivariogram model

esriGeoAnalysisGaussianSemivariogram Gaussian or normal distribution semivariogram model

esriGeoAnalysisLinearSemivariogram linear semivariogram model with a sill

esriGeoAnalysisNoneSemivariogram no model is fit

esriGeoAnalysisSphericalSemivariogram spherical semivariogram model

This is a commonly used function.

esriGeoAnalysisUniversal1Semivariogram Universal Kriging with linear drift

The GRAPH and BOTH options are not available with the UNIVERSAL1 method.

radius an IRasterRadius indicating the search radius for the input points

The radius distance is specified in map units within which all input sample points will be used to perform interpolation. A commonly used radius is five times the cell size of the output Raster.

The object will set and use whatever you set last in your VB script. For example,

set pRad.SetFixed 207.1

set pRad.SetVariable 12

will use the args ... ,SAMPLE,12, ....

set pRad.SetVariable 12

set pRad.SetFixed 207.1

will use the args ... ,RADIUS,207.1, ....

outSemiVariance if True an optional output Raster will be created containing predicted semivariance values for each mesh point in output interpolation surface

If the GRAPH option is specified, an {output_variance} grid will not be created.

[barrier] a coverage or shapefile containing the arcs for the barrier information used for limiting the line search for input sample points

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
krige in interface IInterpolationOp
Specified by:
krige in interface IInterpolationOp2
Specified by:
krige in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
semiVariogramType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisSemiVariogramEnum constant (in)
radius - A reference to a com.esri.arcgis.geoanalyst.IRasterRadius (in)
outSemiVariance - The outSemiVariance (in)
barrier - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

variogram

public IGeoDataset variogram(IGeoDataset geoData,
                             IGeoAnalysisSemiVariogram semiVariogram,
                             IRasterRadius radius,
                             boolean outSemiVariance,
                             Object barrier)
                      throws IOException,
                             AutomationException
Interpolates using Variogram.

Remarks

geoData

an input FeatureClass or FeatureClassDescriptor containing the points with z values to be interpolated onto a surface Raster

semiVariogram

A semivariogram model defined by a GeoAnalystSemiVariogram object using the IGeoAnalysisSemiVariogram::DefineVarigoram method. The semivariogram is described by nugget, sill and range parameters.

radius

an IRasterRadius indicating the search radius for the input points

The radius distance is specified in map units within which all input sample points will be used to perform interpolation. A commonly used radius is five times the cell size of the output Raster.

The object will set and use whatever you set last in your VB script. For example,

set pRad.SetFixed 207.1

set pRad.SetVariable 12 

will use the args ... ,SAMPLE,12, ....

set pRad.SetVariable 12

set pRad.SetFixed 207.1 

will use the args ... ,RADIUS,207.1, ....

outSemiVariance

if True an optional output Raster will be created containing predicted semivariance values for each mesh point in output interpolation surface

If the GRAPH option is specified, an {output_variance} grid will not be created.

[barrier]

a coverage or shapefile containing the arcs for the barrier information used for limiting the line search for input sample points

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
variogram in interface IInterpolationOp
Specified by:
variogram in interface IInterpolationOp2
Specified by:
variogram in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
semiVariogram - A reference to a com.esri.arcgis.geoanalyst.IGeoAnalysisSemiVariogram (in)
radius - A reference to a com.esri.arcgis.geoanalyst.IRasterRadius (in)
outSemiVariance - The outSemiVariance (in)
barrier - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

spline

public IGeoDataset spline(IGeoDataset geoData,
                          int splineType,
                          Object weight,
                          Object numPoints)
                   throws IOException,
                          AutomationException
Interpolates using splining.

Remarks

geoData

an input FeatureClass or FeatureClassDescriptor containing the points with z values to be interpolated onto a surface Raster

splineType

an esriGeoAnalysisSpliceEnum defining the method of Spline to be performed

There are two options.

esriGeoAnalysisRegularizedSpline yields a smooth surface and smooth first derivatives

esriGeoAnalysisTensionSpline tunes the stiffness of the interpolant according to the character of the modeled phenomenon.

[weight]

parameter influencing the character of the surface interpolation

When the Regularized option is chosen, it defines the weight of the third derivatives of the surface in the curvature minimization expression. If the Tension method is run, it defines the weight of tension. When no weight is specified the default is 0.1.

[numPoints]

number of points per region used for local approximation

When no numPoints is given the Spline method will use 12.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
spline in interface IInterpolationOp
Specified by:
spline in interface IInterpolationOp2
Specified by:
spline in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
splineType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisSplineEnum constant (in)
weight - A Variant (in, optional, pass null if not required)
numPoints - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trend

public IGeoDataset trend(IGeoDataset geoData,
                         int trendType,
                         int order)
                  throws IOException,
                         AutomationException
Interpolates using trend surface.

Remarks

geoData

an input FeatureClass or FeatureClassDescriptor containing the points with z values to be interpolated onto a surface Raster

trendType

an esriGeoAnalysisTrendEnum specifying the type of regression to be performed.

esriGeoAnalysisLinearTrend polynomial regression is performed to fit a least-squares surface to the set of input points

It is applicable for continuous types of data.

esriGeoAnalysisLogisticTrend logistic trend surface analysis is performed

It generates a continuous probability surface for binary, or dichotomous, types of data.

order

order of the polynomial

It must be an integer value 1 through 12. A value of 1 will fit a flat plane to the points, and a higher value will fit a more complex surface. A commonly used value is 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
trend in interface IInterpolationOp
Specified by:
trend in interface IInterpolationOp2
Specified by:
trend in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
trendType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisTrendEnum constant (in)
order - The order (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

naturalNeighbor

public IGeoDataset naturalNeighbor(IGeoDataset geoDataset)
                            throws IOException,
                                   AutomationException
Interpolates using natual neighbor.

Remarks

geoDataset an input point featureclass containing the points with z values to be interpolated onto a surface Raster

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
naturalNeighbor in interface IInterpolationOp2
Specified by:
naturalNeighbor in interface IInterpolationOp3
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

topoToRasterByFile

public IRasterDataset topoToRasterByFile(String paramFile,
                                         IFeatureClass[] outStream,
                                         IFeatureClass[] outSink)
                                  throws IOException,
                                         AutomationException
Interpolates using AnuDem.

Description

Generates a hydrologically correct raster of elevation

Remarks

paramFile

The input path to a parameter file specifing required parameters to create the surface. The file can be created using a text editor or saved from the Geoprocessing Topo_to_Raster tool.

[outStream]

Output feature class of stream polyline features

[outSink]

Output feature class of remaining sink point features

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
topoToRasterByFile in interface IInterpolationOp2
Specified by:
topoToRasterByFile in interface IInterpolationOp3
Parameters:
paramFile - The paramFile (in)
outStream - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (out: use single element array, optional, pass single element of null if not required)
outSink - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (out: use single element array, optional, pass single element of null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

trendWithRms

public IGeoDataset trendWithRms(IGeoDataset geoData,
                                int trendType,
                                int order,
                                String out_rms_file)
                         throws IOException,
                                AutomationException
Interpolates using trend surface with optional rms file.

Remarks

geoData an input point featureclass containing the points with z values to be interpolated onto a surface Raster
trendType an esriGeoAnalysisTrendEnum specifying the type of regression to be performed

esriGeoAnalysisLinearTrend polynomial regression is performed to fit a least-squares surface to the set of input points

It is applicable for continuous types of data.

esriGeoAnalysisLogisticTrend logistic trend surface analysis is performed

It generates a continuous probability surface for binary, or dichotomous, types of data.

order order of the polynomial

It must be an integer value 1 through 12. A value of 1 will fit a flat plane to the points, and a higher value will fit a more complex surface. A commonly used value is 1.

out_rms_file Filename for an output text file that contains information about the RMS error of the interpolation.

Product Availability

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

Specified by:
trendWithRms in interface IInterpolationOp3
Parameters:
geoData - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
trendType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisTrendEnum constant (in)
order - The order (in)
out_rms_file - The out_rms_file (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.