com.esri.arcgis.geoanalyst
Interface IInterpolationOp3

All Superinterfaces:
Serializable
All Known Implementing Classes:
RasterInterpolationOp

public interface IInterpolationOp3
extends Serializable

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

Remarks

  • Read the Working with ArcGIS Spatial Analyst objects technical document for general information on implementing Spatial Analyst operations.
  • Product Availability

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


    Method Summary
     IGeoDataset iDW(IGeoDataset geoData, double power, IRasterRadius radius, Object barrier)
              Interpolates using IDW.
     IGeoDataset krige(IGeoDataset geoData, int semiVariogramType, IRasterRadius radius, boolean outSemiVariance, Object barrier)
              Interpolates using kriging.
     IGeoDataset naturalNeighbor(IGeoDataset geoDataset)
              Interpolates using natual neighbor.
     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.
     

    Method Detail

    iDW

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

    Remarks

    geoDataset

    an input point featureclass 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.

    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

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

    Remarks

    geoData

    an input point featureclass 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.

    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

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

    Remarks

    geoData

    an input point featureclass 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.

    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

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

    Remarks

    geoData

    an input point featureclass 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.

    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

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

    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.

    Product Availability

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

    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

    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.

    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

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

    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.

    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

    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.

    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.