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

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

All Implemented Interfaces:

GPTool

public class Nibble
extends AbstractGPTool

Replaces cells of a raster corresponding to a mask with the values of the nearest neighbors. The Nibble tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Cells in the input raster containing NoData are not nibbled. To nibble NoData, first convert it to another value.

Field Summary

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

vals

Constructor Summary

Nibble()
Creates the Nibble tool with defaults.

Nibble(Object inRaster, Object inMaskRaster, Object outRaster)
Creates the Nibble tool with the required parameters.

Method Summary

Object	getInMaskRaster() Returns the Input raster mask parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
String	getNibbleValues() Returns the Use NoData values if they are the nearest neighbor parameter of this tool .
Object	getOutRaster() Returns the Output raster 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	setInMaskRaster(Object inMaskRaster) Sets the Input raster mask parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setNibbleValues(String nibbleValues) Sets the Use NoData values if they are the nearest neighbor parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster 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

Nibble

public Nibble()

Creates the Nibble tool with defaults.

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

Nibble

public Nibble(Object inRaster,
              Object inMaskRaster,
              Object outRaster)

Creates the Nibble 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 that will be nibbled. it must be of integer type.

inMaskRaster - the raster used as the mask. it must be of integer type. cells with NoData as their value will be nibbled in the in_raster.

outRaster - the output nibbled raster. the identified input cells will be replaced with the values of their nearest neighbors.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster that will be nibbled. it must be of integer type. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input raster that will be nibbled. it must be of integer type. This is a required parameter.

Parameters:

inRaster - the input raster that will be nibbled. it must be of integer type.

getInMaskRaster

public Object getInMaskRaster()

Returns the Input raster mask parameter of this tool . This parameter is the raster used as the mask. it must be of integer type. cells with NoData as their value will be nibbled in the in_raster. This is a required parameter.

Returns:

the Input raster mask

setInMaskRaster

public void setInMaskRaster(Object inMaskRaster)

Sets the Input raster mask parameter of this tool . This parameter is the raster used as the mask. it must be of integer type. cells with NoData as their value will be nibbled in the in_raster. This is a required parameter.

Parameters:

inMaskRaster - the raster used as the mask. it must be of integer type. cells with NoData as their value will be nibbled in the in_raster.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output nibbled raster. the identified input cells will be replaced with the values of their nearest neighbors. 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 nibbled raster. the identified input cells will be replaced with the values of their nearest neighbors. This is a required parameter.

Parameters:

outRaster - the output nibbled raster. the identified input cells will be replaced with the values of their nearest neighbors.

getNibbleValues

public String getNibbleValues()

Returns the Use NoData values if they are the nearest neighbor parameter of this tool . This parameter is keywords defining if NoData values in the in_raster are allowed to nibble into the area defined by the in_mask_raster. This is an optional parameter.

Returns:

the Use NoData values if they are the nearest neighbor

setNibbleValues

public void setNibbleValues(String nibbleValues)

Sets the Use NoData values if they are the nearest neighbor parameter of this tool . This parameter is keywords defining if NoData values in the in_raster are allowed to nibble into the area defined by the in_mask_raster. This is an optional parameter.

Parameters:

nibbleValues - keywords defining if NoData values in the in_raster are allowed to nibble into the area defined by the in_mask_raster.

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