com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class RasterToMultipoint

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.RasterToMultipoint

All Implemented Interfaces:

GPTool

public class RasterToMultipoint
extends AbstractGPTool

This tool converts a raster into a new multipoint feature class. The Raster to Multipoint tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Raster to Multipoint converts raster cell centers into 3D points, where their z is given the cell values, groups the points into multipoints, and writes them to an output feature class.
• This tool is useful for incorporating a raster DEM into points that can be used as ancillary data for creating a Terrain dataset or TIN.
• All the cell centers can be converted, using the NO_THIN option, or one of several filters can be applied to exclude those cells which are less significant. The thinning options include ZTOLERANCE, KERNEL, and VIP.
• Use the ZTOLERANCE thinning method when it is important to preserve vertical accuracy. Use the KERNEL thinning method when it is important to control the horizontal sample distance.
• Consider applying a thinning method when converting from raster to multipoints. There are two thinning methods used to generate a new multipoint feature class: ZTOLERANCE and KERNEL. If NO_THIN is selected, the full resolution data will be output into a new multipoint feature class.
• The VIP method is relatively fast, outputs a predictable number points, and is good at selecting local peaks and pits. However, it is sensitive to noise and insensitive to topographic features that are larger than the 3x3 window.

Field Summary

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

vals

Constructor Summary

RasterToMultipoint()
Creates the Raster to Multipoint tool with defaults.

RasterToMultipoint(java.lang.Object inRaster, java.lang.Object outFeatureClass)
Creates the Raster to Multipoint tool with the required parameters.

Method Summary

java.lang.Object	getInRaster() Returns the Input Raster parameter of this tool .
java.lang.String	getKernelMethod() Returns the Kernel Method parameter of this tool .
java.lang.String	getMethod() Returns the Method parameter of this tool .
java.lang.Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
java.lang.Object	getOutVipTable() Returns the Output VIP table parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setInRaster(java.lang.Object inRaster) Sets the Input Raster parameter of this tool .
void	setKernelMethod(java.lang.String kernelMethod) Sets the Kernel Method parameter of this tool .
void	setMethod(java.lang.String method) Sets the Method parameter of this tool .
void	setOutFeatureClass(java.lang.Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutVipTable(java.lang.Object outVipTable) Sets the Output VIP table parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

RasterToMultipoint

public RasterToMultipoint()

Creates the Raster to Multipoint tool with defaults.

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

RasterToMultipoint

public RasterToMultipoint(java.lang.Object inRaster,
                          java.lang.Object outFeatureClass)

Creates the Raster to Multipoint 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:

inRaster - the input raster.

outFeatureClass - the output multipoint feature class.

Method Detail

getInRaster

public java.lang.Object getInRaster()

Returns the Input Raster parameter of this tool . This parameter is the input raster. This is a required parameter.

Returns:

the Input Raster

setInRaster

public void setInRaster(java.lang.Object inRaster)

Sets the Input Raster parameter of this tool . This parameter is the input raster. This is a required parameter.

Parameters:

inRaster - the input raster.

getOutFeatureClass

public java.lang.Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output multipoint feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(java.lang.Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output multipoint feature class. This is a required parameter.

Parameters:

outFeatureClass - the output multipoint feature class.

getOutVipTable

public java.lang.Object getOutVipTable()

Returns the Output VIP table parameter of this tool . This parameter is the output VIP feature class table. This is an optional parameter.

Returns:

the Output VIP table

setOutVipTable

public void setOutVipTable(java.lang.Object outVipTable)

Sets the Output VIP table parameter of this tool . This parameter is the output VIP feature class table. This is an optional parameter.

Parameters:

outVipTable - the output VIP feature class table.

getMethod

public java.lang.String getMethod()

Returns the Method parameter of this tool . This parameter is the thinning method used to generate the new multipoint feature class. Select from either NO_THIN, ZTOLERANCE, KERNEL, VIP_HISTOGRAM, or VIP. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(java.lang.String method)

Sets the Method parameter of this tool . This parameter is the thinning method used to generate the new multipoint feature class. Select from either NO_THIN, ZTOLERANCE, KERNEL, VIP_HISTOGRAM, or VIP. This is an optional parameter.

Parameters:

method - the thinning method used to generate the new multipoint feature class. Select from either NO_THIN, ZTOLERANCE, KERNEL, VIP_HISTOGRAM, or VIP.

getKernelMethod

public java.lang.String getKernelMethod()

Returns the Kernel Method parameter of this tool . This is an optional parameter.

Returns:

the Kernel Method

setKernelMethod

public void setKernelMethod(java.lang.String kernelMethod)

Sets the Kernel Method parameter of this tool . This is an optional parameter.

Parameters:

kernelMethod - null

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is multiplies the z of the input by this factor. Generally used to convert units between feet and meters. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is multiplies the z of the input by this factor. Generally used to convert units between feet and meters. This is an optional parameter.

Parameters:

zFactor - multiplies the z of the input by this factor. Generally used to convert units between feet and meters.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias