com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class GANeighborhoodSelection

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.GANeighborhoodSelection
All Implemented Interfaces:
GPTool

public class GANeighborhoodSelection
extends AbstractGPTool

Creates a layer of points based on a user-defined neighborhood. The Neighborhood Selection tool is contained in the Geostatistical Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
GANeighborhoodSelection()
          Creates the Neighborhood Selection tool with defaults.
GANeighborhoodSelection(Object inDataset, Object outLayer, Object pointCoord, int neighborsMax, int neighborsMin, double minorSemiaxis, double majorSemiaxis, double angle)
          Creates the Neighborhood Selection tool with the required parameters.
 
Method Summary
 double getAngle()
          Returns the Angle parameter of this tool .
 Object getInDataset()
          Returns the Input point features parameter of this tool .
 double getMajorSemiaxis()
          Returns the Major semiaxis parameter of this tool .
 double getMinorSemiaxis()
          Returns the Minor semiaxis parameter of this tool .
 int getNeighborsMax()
          Returns the Neighbors to include parameter of this tool .
 int getNeighborsMin()
          Returns the Include at least parameter of this tool .
 Object getOutLayer()
          Returns the Output layer parameter of this tool .
 Object getPointCoord()
          Returns the Input point parameter of this tool .
 String getShapeType()
          Returns the Shape type parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 void setAngle(double angle)
          Sets the Angle parameter of this tool .
 void setInDataset(Object inDataset)
          Sets the Input point features parameter of this tool .
 void setMajorSemiaxis(double majorSemiaxis)
          Sets the Major semiaxis parameter of this tool .
 void setMinorSemiaxis(double minorSemiaxis)
          Sets the Minor semiaxis parameter of this tool .
 void setNeighborsMax(int neighborsMax)
          Sets the Neighbors to include parameter of this tool .
 void setNeighborsMin(int neighborsMin)
          Sets the Include at least parameter of this tool .
 void setOutLayer(Object outLayer)
          Sets the Output layer parameter of this tool .
 void setPointCoord(Object pointCoord)
          Sets the Input point parameter of this tool .
 void setShapeType(String shapeType)
          Sets the Shape type parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GANeighborhoodSelection

public GANeighborhoodSelection()
Creates the Neighborhood Selection tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


GANeighborhoodSelection

public GANeighborhoodSelection(Object inDataset,
                               Object outLayer,
                               Object pointCoord,
                               int neighborsMax,
                               int neighborsMin,
                               double minorSemiaxis,
                               double majorSemiaxis,
                               double angle)
Creates the Neighborhood Selection tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inDataset - Feature Layer, points from which to create a neighborhood selection.
outLayer - Feature Layer, the name of the layer to contain the neighborhood selection.
pointCoord - Point, the x,y coordinate of the center of the neighborhood.
neighborsMax - Long, the number of points to use in each sector. Some sectors may not have the required number of points, in which case all points in that sector will be used.
neighborsMin - Long, the minimum number of points to use in each sector. If the minimum number of required points are not available in any given sector, the nearest available point(s) outside the sector will be selected.
minorSemiaxis - Double, size of the minor semi-axis of the search neighborhood.
majorSemiaxis - Double, size of the major semi-axis of the search neighborhood.
angle - Double, the angle of rotation of the axis of the neighborhood.
Method Detail

getInDataset

public Object getInDataset()
Returns the Input point features parameter of this tool . This parameter is Feature Layer, points from which to create a neighborhood selection. This is a required parameter.

Returns:
the Input point features

setInDataset

public void setInDataset(Object inDataset)
Sets the Input point features parameter of this tool . This parameter is Feature Layer, points from which to create a neighborhood selection. This is a required parameter.

Parameters:
inDataset - Feature Layer, points from which to create a neighborhood selection.

getOutLayer

public Object getOutLayer()
Returns the Output layer parameter of this tool . This parameter is Feature Layer, the name of the layer to contain the neighborhood selection. This is a required parameter.

Returns:
the Output layer

setOutLayer

public void setOutLayer(Object outLayer)
Sets the Output layer parameter of this tool . This parameter is Feature Layer, the name of the layer to contain the neighborhood selection. This is a required parameter.

Parameters:
outLayer - Feature Layer, the name of the layer to contain the neighborhood selection.

getPointCoord

public Object getPointCoord()
Returns the Input point parameter of this tool . This parameter is Point, the x,y coordinate of the center of the neighborhood. This is a required parameter.

Returns:
the Input point

setPointCoord

public void setPointCoord(Object pointCoord)
Sets the Input point parameter of this tool . This parameter is Point, the x,y coordinate of the center of the neighborhood. This is a required parameter.

Parameters:
pointCoord - Point, the x,y coordinate of the center of the neighborhood.

getNeighborsMax

public int getNeighborsMax()
Returns the Neighbors to include parameter of this tool . This parameter is Long, the number of points to use in each sector. Some sectors may not have the required number of points, in which case all points in that sector will be used. This is a required parameter.

Returns:
the Neighbors to include

setNeighborsMax

public void setNeighborsMax(int neighborsMax)
Sets the Neighbors to include parameter of this tool . This parameter is Long, the number of points to use in each sector. Some sectors may not have the required number of points, in which case all points in that sector will be used. This is a required parameter.

Parameters:
neighborsMax - Long, the number of points to use in each sector. Some sectors may not have the required number of points, in which case all points in that sector will be used.

getNeighborsMin

public int getNeighborsMin()
Returns the Include at least parameter of this tool . This parameter is Long, the minimum number of points to use in each sector. If the minimum number of required points are not available in any given sector, the nearest available point(s) outside the sector will be selected. This is a required parameter.

Returns:
the Include at least

setNeighborsMin

public void setNeighborsMin(int neighborsMin)
Sets the Include at least parameter of this tool . This parameter is Long, the minimum number of points to use in each sector. If the minimum number of required points are not available in any given sector, the nearest available point(s) outside the sector will be selected. This is a required parameter.

Parameters:
neighborsMin - Long, the minimum number of points to use in each sector. If the minimum number of required points are not available in any given sector, the nearest available point(s) outside the sector will be selected.

getMinorSemiaxis

public double getMinorSemiaxis()
Returns the Minor semiaxis parameter of this tool . This parameter is Double, size of the minor semi-axis of the search neighborhood. This is a required parameter.

Returns:
the Minor semiaxis

setMinorSemiaxis

public void setMinorSemiaxis(double minorSemiaxis)
Sets the Minor semiaxis parameter of this tool . This parameter is Double, size of the minor semi-axis of the search neighborhood. This is a required parameter.

Parameters:
minorSemiaxis - Double, size of the minor semi-axis of the search neighborhood.

getMajorSemiaxis

public double getMajorSemiaxis()
Returns the Major semiaxis parameter of this tool . This parameter is Double, size of the major semi-axis of the search neighborhood. This is a required parameter.

Returns:
the Major semiaxis

setMajorSemiaxis

public void setMajorSemiaxis(double majorSemiaxis)
Sets the Major semiaxis parameter of this tool . This parameter is Double, size of the major semi-axis of the search neighborhood. This is a required parameter.

Parameters:
majorSemiaxis - Double, size of the major semi-axis of the search neighborhood.

getAngle

public double getAngle()
Returns the Angle parameter of this tool . This parameter is Double, the angle of rotation of the axis of the neighborhood. This is a required parameter.

Returns:
the Angle

setAngle

public void setAngle(double angle)
Sets the Angle parameter of this tool . This parameter is Double, the angle of rotation of the axis of the neighborhood. This is a required parameter.

Parameters:
angle - Double, the angle of rotation of the axis of the neighborhood.

getShapeType

public String getShapeType()
Returns the Shape type parameter of this tool . This parameter is String, the geometry of the neighborhood. This is an optional parameter.

Returns:
the Shape type

setShapeType

public void setShapeType(String shapeType)
Sets the Shape type parameter of this tool . This parameter is String, the geometry of the neighborhood. This is an optional parameter.

Parameters:
shapeType - String, the geometry of the neighborhood.

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias