com.esri.arcgis.geoanalyst
Class IInterpolationOpProxy

java.lang.Object
  extended bycom.esri.arcgis.interop.Dispatch
      extended bycom.esri.arcgis.geoanalyst.IInterpolationOpProxy
All Implemented Interfaces:
java.io.Externalizable, IInterpolationOp, java.io.Serializable

public class IInterpolationOpProxy
extends Dispatch
implements IInterpolationOp, java.io.Serializable

Provides access to members that control the Interpolating of a GeoDataset.

Product Availability

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

See Also:
Serialized Form

Field Summary
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF
 
Constructor Summary
  IInterpolationOpProxy()
          For internal use only
  IInterpolationOpProxy(java.lang.Object obj)
           
protected IInterpolationOpProxy(java.lang.Object obj, java.lang.String iid)
           
  IInterpolationOpProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
           
protected IInterpolationOpProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
          Adds a Java object to be a listener for a specific kind of event generated by the COM object.
 IGeoDataset iDW(IGeoDataset geoData, double power, IRasterRadius radius, java.lang.Object barrier)
          Interpolates using IDW.
 IGeoDataset krige(IGeoDataset geoData, int semiVariogramType, IRasterRadius radius, boolean outSemiVariance, java.lang.Object barrier)
          Interpolates using kriging.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Removes a Java object as a listener to events generated by a COM object.
 IGeoDataset spline(IGeoDataset geoData, int splineType, java.lang.Object weight, java.lang.Object numPoints)
          Interpolates using splining.
 IGeoDataset trend(IGeoDataset geoData, int trendType, int order)
          Interpolates using trend surface.
 IGeoDataset variogram(IGeoDataset geoData, IGeoAnalysisSemiVariogram semiVariogram, IRasterRadius radius, boolean outSemiVariance, java.lang.Object barrier)
          Interpolates using Variogram.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass
Constructor Detail

IInterpolationOpProxy

public IInterpolationOpProxy(java.lang.String CLSID,
                             java.lang.String host,
                             AuthInfo authInfo)
                      throws java.net.UnknownHostException,
                             java.io.IOException

IInterpolationOpProxy

public IInterpolationOpProxy()
For internal use only


IInterpolationOpProxy

public IInterpolationOpProxy(java.lang.Object obj)
                      throws java.io.IOException

IInterpolationOpProxy

protected IInterpolationOpProxy(java.lang.Object obj,
                                java.lang.String iid)
                         throws java.io.IOException

IInterpolationOpProxy

protected IInterpolationOpProxy(java.lang.String CLSID,
                                java.lang.String iid,
                                java.lang.String host,
                                AuthInfo authInfo)
                         throws java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Description copied from class: Dispatch
Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
addListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object to be informed of the events
theSource - the proxy class that represents the COM class that is the source of the events
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Description copied from class: Dispatch
Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:
removeListener in class Dispatch
Parameters:
iidStr - the ID of the outgoing interface, implemented by the listener
theListener - the object that no longer wishes to be informed of the events
Throws:
java.io.IOException

iDW

public IGeoDataset iDW(IGeoDataset geoData,
                       double power,
                       IRasterRadius radius,
                       java.lang.Object barrier)
                throws java.io.IOException,
                       AutomationException
Description copied from interface: IInterpolationOp
Interpolates using IDW.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:
iDW in interface IInterpolationOp
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

krige

public IGeoDataset krige(IGeoDataset geoData,
                         int semiVariogramType,
                         IRasterRadius radius,
                         boolean outSemiVariance,
                         java.lang.Object barrier)
                  throws java.io.IOException,
                         AutomationException
Description copied from interface: IInterpolationOp
Interpolates using kriging.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:
krige in interface IInterpolationOp
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:
AutomationException - If the ArcObject component throws an exception.
java.io.IOException - If there are interop problems.

variogram

public IGeoDataset variogram(IGeoDataset geoData,
                             IGeoAnalysisSemiVariogram semiVariogram,
                             IRasterRadius radius,
                             boolean outSemiVariance,
                             java.lang.Object barrier)
                      throws java.io.IOException,
                             AutomationException
Description copied from interface: IInterpolationOp
Interpolates using Variogram.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:
variogram in interface IInterpolationOp
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

spline

public IGeoDataset spline(IGeoDataset geoData,
                          int splineType,
                          java.lang.Object weight,
                          java.lang.Object numPoints)
                   throws java.io.IOException,
                          AutomationException
Description copied from interface: IInterpolationOp
Interpolates using splining.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
spline in interface IInterpolationOp
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:
java.io.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 java.io.IOException,
                         AutomationException
Description copied from interface: IInterpolationOp
Interpolates using trend surface.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:
trend in interface IInterpolationOp
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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.