com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class CollectEvents

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.CollectEvents

All Implemented Interfaces:

GPTool

public class CollectEvents
extends AbstractGPTool

Converts event data, such as crime or disease incidents, to weighted point data. The Collect Events tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• Collect Event combines coincident points: it creates a new Output Feature Class containing all of the unique locations found in the Input Feature Class. It then adds a field named ICOUNT to hold the sum of all incidents at each unique location.
• This tool will only combine features that have the exact same X and Y centroid coordinates. You may want to use the tool to snap nearby features together prior to running the Collect Events tool.
• The , , and tools, for example, require weighted points rather than individual incidents. Collect Events can be used to create weights when the input feature class contains coincident features.
• Although this tool will work with polygon or line data, it is really only appropriate for event, incident, or other point feature data. For line and polygon features, feature coincidence is based on feature true geometric centroids. For multipoint, polyline, or polygons with multiple parts, the centroid is computed using the weighted mean center of all feature parts. The weighting for point features is 1, for line features is length, and for polygon features is area.
• If you want each individual point/part of multipoint/multipart data treated as singlepart features, run the tool, then run Collect Events on the single part feature class. For more information, see .
• In addition to the Output Feature Class, this function passes, as derived output values, the name of the count field and the maximum count value encountered for any one location. These derived output values are helpful when you use this tool in models or scripts.
• When this tool runs in ArcMap, the output feature class is automatically added to the Table of Contents (TOC) with default rendering applied to the ICOUNT field. The graduated circle rendering scheme is defined by a layer file in /ArcToolbox/Templates/Layers. You can reapply the default rendering, if needed, by the template layer symbology.

Field Summary

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

vals

Constructor Summary

CollectEvents()
Creates the Collect Events tool with defaults.

CollectEvents(Object inputIncidentFeatures, Object outputWeightedPointFeatureClass)
Creates the Collect Events tool with the required parameters.

Method Summary

Object	getInputIncidentFeatures() Returns the Input Incident Features parameter of this tool .
Object	getOutputWeightedPointFeatureClass() Returns the Output Weighted Point Feature Class parameter of this tool .
Object	getResultsField() Returns the Results Field parameter of this tool (Read only).
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.
double	getZMaxValue() Returns the Z Max Value parameter of this tool (Read only).
void	setInputIncidentFeatures(Object inputIncidentFeatures) Sets the Input Incident Features parameter of this tool .
void	setOutputWeightedPointFeatureClass(Object outputWeightedPointFeatureClass) Sets the Output Weighted Point Feature Class 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

CollectEvents

public CollectEvents()

Creates the Collect Events tool with defaults.

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

CollectEvents

public CollectEvents(Object inputIncidentFeatures,
                     Object outputWeightedPointFeatureClass)

Creates the Collect Events 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:

inputIncidentFeatures - the features representing event or incident data.

outputWeightedPointFeatureClass - the output feature class to contain the weighted point data.

Method Detail

getInputIncidentFeatures

public Object getInputIncidentFeatures()

Returns the Input Incident Features parameter of this tool . This parameter is the features representing event or incident data. This is a required parameter.

Returns:

the Input Incident Features

setInputIncidentFeatures

public void setInputIncidentFeatures(Object inputIncidentFeatures)

Sets the Input Incident Features parameter of this tool . This parameter is the features representing event or incident data. This is a required parameter.

Parameters:

inputIncidentFeatures - the features representing event or incident data.

getOutputWeightedPointFeatureClass

public Object getOutputWeightedPointFeatureClass()

Returns the Output Weighted Point Feature Class parameter of this tool . This parameter is the output feature class to contain the weighted point data. This is a required parameter.

Returns:

the Output Weighted Point Feature Class

setOutputWeightedPointFeatureClass

public void setOutputWeightedPointFeatureClass(Object outputWeightedPointFeatureClass)

Sets the Output Weighted Point Feature Class parameter of this tool . This parameter is the output feature class to contain the weighted point data. This is a required parameter.

Parameters:

outputWeightedPointFeatureClass - the output feature class to contain the weighted point data.

getResultsField

public Object getResultsField()

Returns the Results Field parameter of this tool (Read only). This is an derived parameter.

Returns:

the Results Field

getZMaxValue

public double getZMaxValue()

Returns the Z Max Value parameter of this tool (Read only). This is an derived parameter.

Returns:

the Z Max Value

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