Skip to main content

SearchNeighborhoodSmooth

Summary

The SearchNeighborhoodSmooth class can be used to define the search neighborhood for IDW, Local Polynomial Interpolation and Radial Basis Functions (only when the INVERSE_MULTIQUADRIC_FUNCTION keyword is used). The smooth search neighborhood class accepts inputs for a minor and major axis, the size of the search ellipse, the angle of the search ellipse, and a smoothing factor.

Learn more about smooth interpolation

Syntax

SearchNeighborhoodSmooth({majorSemiaxis}, {minorSemiaxis}, {angle}, {smoothFactor})

Name Explanation Data type

majorSemiaxis

(Optional)

The distance, in map units, specifying the length of the major semi axis of the ellipse within which data is selected from.

Double

minorSemiaxis

(Optional)

The distance, in map units, specifying the length of the minor semi axis of the ellipse within which data is selected from.

Double

angle

(Optional)

The angle of the search ellipse.

Double

smoothFactor

(Optional)

Determines how much smoothing will be performed. 0 is no smoothing; 1 is the maximum amount of smoothing.

Double

Properties

Name Explanation Data type

angle

(Read and Write)

The angle of the search ellipse.

Double

majorSemiaxis

(Read and Write)

The distance, in map units, specifying the length of the major semi axis of the ellipse within which data is selected.

Double

minorSemiaxis

(Read and Write)

The distance, in map units, specifying the length of the minor semi axis of the ellipse within which data is selected.

Double

nbrType

(Read only)

The neighborhood type: Smooth or Standard.

String

smoothFactor

(Read and Write)

Determines how much smoothing will be performed: 0 is no smoothing, and 1 is the maximum amount of smoothing.

Double

Code sample

SearchNeighborhoodSmooth (Python window)

SearchNeighborhoodSmooth with Local Polynomial Interpolation to produce an output raster.

import arcpy
arcpy.env.workspace = "C:/gapyexamples/data"
arcpy.ga.LocalPolynomialInterpolation(
    "ca_ozone_pts", "OZONE", "outLPI", "C:/gapyexamples/output/lpiout", "2000",
    "2", arcpy.SearchNeighborhoodSmooth(300000, 300000, 0, 0.5), "QUARTIC",
    "", "", "", "", "PREDICTION")
SearchNeighborhoodSmooth (stand-alone script)

SearchNeighborhoodSmooth with Local Polynomial Interpolation to produce an output raster.

# Name: LocalPolynomialInterpolation_Example_02.py
# Description: Local Polynomial interpolation fits many polynomials, each
#              within specified overlapping neighborhoods.
# Requirements: Geostatistical Analyst extension

# Import system modules
import arcpy

# Set environment settings
arcpy.env.workspace = "C:/gapyexamples/data"

# Set local variables
inPointFeatures = "ca_ozone_pts.shp"
zField = "ozone"
outLayer = "outLPI"
outRaster = "C:/gapyexamples/output/lpiout"
cellSize = 2000.0
power = 2
kernelFunction = "QUARTIC"
bandwidth = ""
useConNumber = ""
conNumber = ""
weightField = ""
outSurface = "PREDICTION"

# Set variables for search neighborhood
majSemiaxis = 300000
minSemiaxis = 300000
angle = 0
smoothFactor = 0.5
searchNeighbourhood = arcpy.SearchNeighborhoodSmooth(majSemiaxis, minSemiaxis,
                                                     angle, smoothFactor)

# Run LocalPolynomialInterpolation
arcpy.ga.LocalPolynomialInterpolation(inPointFeatures, zField, outLayer, outRaster,
                                      cellSize, power, searchNeighbourhood,
                                      kernelFunction, bandwidth, useConNumber,
                                      conNumber, weightField, outSurface)