com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class PointStatistics

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.PointStatistics

All Implemented Interfaces:

GPTool

public class PointStatistics
extends AbstractGPTool

Calculates a statistic on the points in a neighborhood around each output cell. The Point Statistics tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• When the field is integer, the available overlay statistic choices are Mean, Majority, Maximum, Median, Minimum, Minority, Range, STD, Sum, and Variety. When the field is floating point, the only allowed statistics are Mean, Maximum, Minimum, Range, STD, and Sum.
• For statistic types Majority, Maximum, Median, Minimum, Minority, Range, and Sum, the output data type of the raster will be the same as the input field type. For statistic types Mean and STD, the output raster will always be floating point. For Variety, the output raster will always be integer.
• If there are no points in the neighborhood of a raster cell, the Variety statistic assigns a value of zero. For the other statistics, NoData is assigned.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

PointStatistics()
Creates the Point Statistics tool with defaults.

PointStatistics(Object inPointFeatures, Object field, Object outRaster)
Creates the Point Statistics tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getField() Returns the Field parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
Object	getNeighborhood() Returns the Neighborhood parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getStatisticsType() Returns the Statistics 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setField(Object field) Sets the Field parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setNeighborhood(Object neighborhood) Sets the Neighborhood parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setStatisticsType(String statisticsType) Sets the Statistics 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

PointStatistics

public PointStatistics()

Creates the Point Statistics tool with defaults.

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

PointStatistics

public PointStatistics(Object inPointFeatures,
                       Object field,
                       Object outRaster)

Creates the Point Statistics 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:

inPointFeatures - the input point features for which to calculate the statistics in a neighborhood around each output cell. the input can be either a point or multipoint feature class.

field - field can be any numeric field of the input point features. it can be the Shape field if the input features contains z.

outRaster - the output point statistics raster.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is the input point features for which to calculate the statistics in a neighborhood around each output cell. the input can be either a point or multipoint feature class. This is a required parameter.

Returns:

the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input point features parameter of this tool . This parameter is the input point features for which to calculate the statistics in a neighborhood around each output cell. the input can be either a point or multipoint feature class. This is a required parameter.

Parameters:

inPointFeatures - the input point features for which to calculate the statistics in a neighborhood around each output cell. the input can be either a point or multipoint feature class.

getField

public Object getField()

Returns the Field parameter of this tool . This parameter is field can be any numeric field of the input point features. it can be the Shape field if the input features contains z. This is a required parameter.

Returns:

the Field

setField

public void setField(Object field)

Sets the Field parameter of this tool . This parameter is field can be any numeric field of the input point features. it can be the Shape field if the input features contains z. This is a required parameter.

Parameters:

field - field can be any numeric field of the input point features. it can be the Shape field if the input features contains z.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output point statistics raster. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output point statistics raster. This is a required parameter.

Parameters:

outRaster - the output point statistics raster.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is cell size for output raster dataset. this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is cell size for output raster dataset. this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - cell size for output raster dataset. this is the value in the environment if specifically set. If not set in the environment, it is the shorter of the width or height of the extent of the input feature dataset, in the output spatial reference, divided by 250.

getNeighborhood

public Object getNeighborhood()

Returns the Neighborhood parameter of this tool . This parameter is the Neighborhood class dictates the shape of the area around each input point used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, and NbrWedge. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells. This is an optional parameter.

Returns:

the Neighborhood

setNeighborhood

public void setNeighborhood(Object neighborhood)

Sets the Neighborhood parameter of this tool . This parameter is the Neighborhood class dictates the shape of the area around each input point used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, and NbrWedge. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells. This is an optional parameter.

Parameters:

neighborhood - the Neighborhood class dictates the shape of the area around each input point used to calculate the statistic. the different types of neighborhood available are: NbrAnnulus, NbrCircle, NbrRectangle, and NbrWedge. the following are the forms of the neighborhoods: the {CELL | MAP} parameter defines the distance units as either being Cell units or Map units. the default neighborhood is a square NbrRectangle with a width and height of 3 cells.

getStatisticsType

public String getStatisticsType()

Returns the Statistics type parameter of this tool . This parameter is the statistic type to be calculated. the calculation is performed on the values of the specified field of the point input in the neighborhood of each output raster cell. This is an optional parameter.

Returns:

the Statistics type

setStatisticsType

public void setStatisticsType(String statisticsType)

Sets the Statistics type parameter of this tool . This parameter is the statistic type to be calculated. the calculation is performed on the values of the specified field of the point input in the neighborhood of each output raster cell. This is an optional parameter.

Parameters:

statisticsType - the statistic type to be calculated. the calculation is performed on the values of the specified field of the point input in the neighborhood of each output raster cell.

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