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

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

All Implemented Interfaces:

GPTool

public class Mod
extends AbstractGPTool

Finds the remainder (modulo) of the first raster when divided by the second raster on a cell-by-cell basis. The Mod tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The order of inputs is relevant for this tool.
• Mod assumes both its inputs are integers. If any inputs are not integer, those inputs will be converted to integers through truncation. Output values are always integers.
• Any value modulated (divided) by 0 is assigned NoData on the output. Therefore, any location on the second input that is either 0 or NoData will return NoData for that location on the output.
• If the second input value (the divisor) is larger than the first input value (the dividend), the output will be the same value as the first input. For example, if you were to divide a value of 8 by value 10, the integer division calculation will return the input value 8 for the remainder.
• In Map Algebra, the equivalent symbol for this tool is "%" ().

Field Summary

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

vals

Constructor Summary

Mod()
Creates the Mod tool with defaults.

Mod(Object inRasterOrConstant1, Object inRasterOrConstant2, Object outRaster)
Creates the Mod tool with the required parameters.

Method Summary

Object	getInRasterOrConstant1() Returns the Input raster or constant value 1 parameter of this tool .
Object	getInRasterOrConstant2() Returns the Input raster or constant value 2 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	setInRasterOrConstant1(Object inRasterOrConstant1) Sets the Input raster or constant value 1 parameter of this tool .
void	setInRasterOrConstant2(Object inRasterOrConstant2) Sets the Input raster or constant value 2 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

Mod

public Mod()

Creates the Mod tool with defaults.

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

Mod

public Mod(Object inRasterOrConstant1,
           Object inRasterOrConstant2,
           Object outRaster)

Creates the Mod 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:

inRasterOrConstant1 - the numerator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

inRasterOrConstant2 - the denominator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

outRaster - the output raster. the cell values are the remainder of the division of the values in the first input by the second input.

Method Detail

getInRasterOrConstant1

public Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is the numerator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(Object inRasterOrConstant1)

Sets the Input raster or constant value 1 parameter of this tool . This parameter is the numerator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant1 - the numerator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

getInRasterOrConstant2

public Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is the denominator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(Object inRasterOrConstant2)

Sets the Input raster or constant value 2 parameter of this tool . This parameter is the denominator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant2 - the denominator input. a number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the remainder of the division of the values in the first input by the second input. 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. the cell values are the remainder of the division of the values in the first input by the second input. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the remainder of the division of the values in the first input by the second input.

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