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

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

All Implemented Interfaces:

GPTool

public class CreateConstantRaster
extends AbstractGPTool

Creates a raster of a constant value within the extent and cell size of the analysis window. The Create Constant Raster tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The Create Constant Raster tool assigns the specified value to every cell in the output raster.
• The constant value must be a numeric value. Scientific notation is acceptable (for example, 3.048e-4).
• Some typical reasons for creating a raster of all the same values include:

Field Summary

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

vals

Constructor Summary

CreateConstantRaster()
Creates the Create Constant Raster tool with defaults.

CreateConstantRaster(Object outRaster, double constantValue)
Creates the Create Constant Raster tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
double	getConstantValue() Returns the Constant value parameter of this tool .
String	getDataType() Returns the Output data type 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	setConstantValue(double constantValue) Sets the Constant value parameter of this tool .
void	setDataType(String dataType) Sets the Output data type 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

CreateConstantRaster

public CreateConstantRaster()

Creates the Create Constant Raster tool with defaults.

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

CreateConstantRaster

public CreateConstantRaster(Object outRaster,
                            double constantValue)

Creates the Create Constant 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 for which each cell will have specified constant value.

constantValue - the constant value from which to create an output raster dataset.

Method Detail

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster for which each cell will have specified constant value. 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 for which each cell will have specified constant value. This is a required parameter.

Parameters:

outRaster - the output raster for which each cell will have specified constant value.

getConstantValue

public double getConstantValue()

Returns the Constant value parameter of this tool . This parameter is the constant value from which to create an output raster dataset. This is a required parameter.

Returns:

the Constant value

setConstantValue

public void setConstantValue(double constantValue)

Sets the Constant value parameter of this tool . This parameter is the constant value from which to create an output raster dataset. This is a required parameter.

Parameters:

constantValue - the constant value from which to create an output raster dataset.

getDataType

public String getDataType()

Returns the Output data type parameter of this tool . This parameter is data type of the output raster dataset. if the specified data type is FLOAT, the input constant value is only accurate to 7 decimal places (single precision). This is an optional parameter.

Returns:

the Output data type

setDataType

public void setDataType(String dataType)

Sets the Output data type parameter of this tool . This parameter is data type of the output raster dataset. if the specified data type is FLOAT, the input constant value is only accurate to 7 decimal places (single precision). This is an optional parameter.

Parameters:

dataType - data type of the output raster dataset. if the specified data type is FLOAT, the input constant value is only accurate to 7 decimal places (single precision).

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