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

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

All Implemented Interfaces:

GPTool

public class Slice
extends AbstractGPTool

Slices or reclassifies the range of values of the input cells into zones of equal interval, equal area, or by natural breaks. The Slice tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• Slice works best on data that is normally distributed. When using input raster data that is skewed the output result may not contain all of the classes that you had expected or specified.
• If an environment has been set, those cells that have been masked will receive NoData on the output slice raster.
• When using the EQUAL_AREA method, sometimes not all of the output classes will have an equal, or even similar, number of cells (i.e., area). This may be an inherent result based on the nature of the input values and the specified number of classes (bins). If the results are deemed undesirable, you can try using a few number of classes or applying a statistics transformation (e.g., logarithm, square root, and so on) to the input dataset.

Field Summary

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

vals

Constructor Summary

Slice()
Creates the Slice tool with defaults.

Slice(Object inRaster, Object outRaster, int numberZones)
Creates the Slice tool with the required parameters.

Method Summary

int	getBaseOutputZone() Returns the Base zone for output parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
int	getNumberZones() Returns the Number of output zones parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getSliceType() Returns the Slice method 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	setBaseOutputZone(int baseOutputZone) Sets the Base zone for output parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setNumberZones(int numberZones) Sets the Number of output zones parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setSliceType(String sliceType) Sets the Slice method 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

Slice

public Slice()

Creates the Slice tool with defaults.

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

Slice

public Slice(Object inRaster,
             Object outRaster,
             int numberZones)

Creates the Slice 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 to be reclassified.

outRaster - the output reclassified raster. the output will always be of integer type.

numberZones - the number of zones to reclassify the input raster into. when the slice method is EQUAL_AREA, the output raster will have the defined number of zones, with a similar number of cells in each. when EQUAL_INTERVAL is used, the output raster will have the defined number of zones, each containing equal value ranges on the output raster. when NATURAL_BREAKS is used, the output raster will have the defined number of zones, with the number of cells in each determined by the class breaks.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input raster to be reclassified. 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 to be reclassified. This is a required parameter.

Parameters:

inRaster - the input raster to be reclassified.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output reclassified raster. the output will always be of integer type. 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 reclassified raster. the output will always be of integer type. This is a required parameter.

Parameters:

outRaster - the output reclassified raster. the output will always be of integer type.

getNumberZones

public int getNumberZones()

Returns the Number of output zones parameter of this tool . This parameter is the number of zones to reclassify the input raster into. when the slice method is EQUAL_AREA, the output raster will have the defined number of zones, with a similar number of cells in each. when EQUAL_INTERVAL is used, the output raster will have the defined number of zones, each containing equal value ranges on the output raster. when NATURAL_BREAKS is used, the output raster will have the defined number of zones, with the number of cells in each determined by the class breaks. This is a required parameter.

Returns:

the Number of output zones

setNumberZones

public void setNumberZones(int numberZones)

Sets the Number of output zones parameter of this tool . This parameter is the number of zones to reclassify the input raster into. when the slice method is EQUAL_AREA, the output raster will have the defined number of zones, with a similar number of cells in each. when EQUAL_INTERVAL is used, the output raster will have the defined number of zones, each containing equal value ranges on the output raster. when NATURAL_BREAKS is used, the output raster will have the defined number of zones, with the number of cells in each determined by the class breaks. This is a required parameter.

Parameters:

numberZones - the number of zones to reclassify the input raster into. when the slice method is EQUAL_AREA, the output raster will have the defined number of zones, with a similar number of cells in each. when EQUAL_INTERVAL is used, the output raster will have the defined number of zones, each containing equal value ranges on the output raster. when NATURAL_BREAKS is used, the output raster will have the defined number of zones, with the number of cells in each determined by the class breaks.

getSliceType

public String getSliceType()

Returns the Slice method parameter of this tool . This parameter is the manner in which to slice the values in the input raster. This is an optional parameter.

Returns:

the Slice method

setSliceType

public void setSliceType(String sliceType)

Sets the Slice method parameter of this tool . This parameter is the manner in which to slice the values in the input raster. This is an optional parameter.

Parameters:

sliceType - the manner in which to slice the values in the input raster.

getBaseOutputZone

public int getBaseOutputZone()

Returns the Base zone for output parameter of this tool . This parameter is defines the lowest zone value on the output raster dataset. the default value is 1. This is an optional parameter.

Returns:

the Base zone for output

setBaseOutputZone

public void setBaseOutputZone(int baseOutputZone)

Sets the Base zone for output parameter of this tool . This parameter is defines the lowest zone value on the output raster dataset. the default value is 1. This is an optional parameter.

Parameters:

baseOutputZone - defines the lowest zone value on the output raster dataset. the default value is 1.

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