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

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

All Implemented Interfaces:

GPTool

public class CreateNormalRaster
extends AbstractGPTool

Creates a raster of random values with a normal (gaussian) distribution within the extent and cell size of the analysis window. The Create Normal Raster tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The Create Normal Raster tool generates values for every cell in the output raster.
• The output raster from this tool is always floating point.
• The cell values will have up to 7 digits of precision after the decimal point.
• The output values will have a mean of 0.0 and a standard deviation of 1.0. If a different standard deviation is desired, multiply the output raster by that value. If a different mean is desired, add that value to the raster. For example, to create a raster where the values are characterized by a mean of 39 and a standard deviation of 2.5, multiply the results of Create Normal Raster by 2.5, then add 39.
• The random number generator is automatically seeded with the current value of the system clock (seconds since January 1, 1970). Reseeding the Create Random Raster tool also reseeds Create Normal Raster.

Field Summary

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

vals

Constructor Summary

CreateNormalRaster()
Creates the Create Normal Raster tool with defaults.

CreateNormalRaster(Object outRaster)
Creates the Create Normal Raster tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getExtent() Returns the Output extent 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setExtent(Object extent) Sets the Output extent 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

CreateNormalRaster

public CreateNormalRaster()

Creates the Create Normal Raster tool with defaults.

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

CreateNormalRaster

public CreateNormalRaster(Object outRaster)

Creates the Create Normal Raster 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:

outRaster - the output raster of normally distributed values with a mean of 0.0 and a standard deviation of 1.0.

Method Detail

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster of normally distributed values with a mean of 0.0 and a standard deviation of 1.0. 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 raster of normally distributed values with a mean of 0.0 and a standard deviation of 1.0. This is a required parameter.

Parameters:

outRaster - the output raster of normally distributed values with a mean of 0.0 and a standard deviation of 1.0.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is the cell size for the output raster dataset. this is the value in the environment if specifically set. If not specifically set, it is the shorter of the width or height of the environment extent 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 the cell size for the output raster dataset. this is the value in the environment if specifically set. If not specifically set, it is the shorter of the width or height of the environment extent in the output spatial reference, divided by 250. This is an optional parameter.

Parameters:

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

getExtent

public Object getExtent()

Returns the Output extent parameter of this tool . This parameter is the extent for the output raster dataset. the Extent is a Python class. in this tool it is in the form of: Extent(XMin, YMin, XMax, YMax) the coordinates are specified in the same map units as the in_raster. the extent will be the value in the environment if specifically set. If not specifically set, the default is 0, 0, 250, 250. This is an optional parameter.

Returns:

the Output extent

setExtent

public void setExtent(Object extent)

Sets the Output extent parameter of this tool . This parameter is the extent for the output raster dataset. the Extent is a Python class. in this tool it is in the form of: Extent(XMin, YMin, XMax, YMax) the coordinates are specified in the same map units as the in_raster. the extent will be the value in the environment if specifically set. If not specifically set, the default is 0, 0, 250, 250. This is an optional parameter.

Parameters:

extent - the extent for the output raster dataset. the Extent is a Python class. in this tool it is in the form of: Extent(XMin, YMin, XMax, YMax) the coordinates are specified in the same map units as the in_raster. the extent will be the value in the environment if specifically set. If not specifically set, the default is 0, 0, 250, 250.

• where XMin and YMin define the lower-left coordinate of the extent, with XMax and YMax defining the upper-right coordinate.

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