com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class RasterCompare

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.RasterCompare

All Implemented Interfaces:

GPTool

public class RasterCompare
extends AbstractGPTool

Compares the properties of two rasters datasets or two raster catalogs and returns the comparison result. The Raster Compare tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• The tool returns messages showing the comparison result.
• The parameter and attribute tolerances allow your comparisons to have a specified amount of leeway.
• The following environments affect this tool: current workspace; scratch workspace;

Field Summary

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

vals

Constructor Summary

RasterCompare()
Creates the Raster Compare tool with defaults.

RasterCompare(Object inBaseRaster, Object inTestRaster)
Creates the Raster Compare tool with the required parameters.

Method Summary

Object	getAttributeTolerances() Returns the Attribute Tolerance parameter of this tool .
String	getCompareStatus() Returns the Compare Status parameter of this tool (Read only).
String	getCompareType() Returns the Compare Type parameter of this tool .
String	getContinueCompare() Returns the Continue Comparison parameter of this tool .
Object	getIgnoreOption() Returns the Ignore Options parameter of this tool .
Object	getInBaseRaster() Returns the Input Base Raster parameter of this tool .
Object	getInTestRaster() Returns the Input Test Raster parameter of this tool .
Object	getOmitField() Returns the Omit Fields parameter of this tool .
Object	getOutCompareFile() Returns the Output Compare File parameter of this tool .
Object	getParameterTolerances() Returns the Parameter Tolerance 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	setAttributeTolerances(Object attributeTolerances) Sets the Attribute Tolerance parameter of this tool .
void	setCompareType(String compareType) Sets the Compare Type parameter of this tool .
void	setContinueCompare(String continueCompare) Sets the Continue Comparison parameter of this tool .
void	setIgnoreOption(Object ignoreOption) Sets the Ignore Options parameter of this tool .
void	setInBaseRaster(Object inBaseRaster) Sets the Input Base Raster parameter of this tool .
void	setInTestRaster(Object inTestRaster) Sets the Input Test Raster parameter of this tool .
void	setOmitField(Object omitField) Sets the Omit Fields parameter of this tool .
void	setOutCompareFile(Object outCompareFile) Sets the Output Compare File parameter of this tool .
void	setParameterTolerances(Object parameterTolerances) Sets the Parameter Tolerance 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

RasterCompare

public RasterCompare()

Creates the Raster Compare tool with defaults.

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

RasterCompare

public RasterCompare(Object inBaseRaster,
                     Object inTestRaster)

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

inBaseRaster - Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the test raster.

inTestRaster - Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the input base raster.

Method Detail

getInBaseRaster

public Object getInBaseRaster()

Returns the Input Base Raster parameter of this tool . This parameter is Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the test raster. This is a required parameter.

Returns:

the Input Base Raster

setInBaseRaster

public void setInBaseRaster(Object inBaseRaster)

Sets the Input Base Raster parameter of this tool . This parameter is Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the test raster. This is a required parameter.

Parameters:

inBaseRaster - Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the test raster.

getInTestRaster

public Object getInTestRaster()

Returns the Input Test Raster parameter of this tool . This parameter is Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the input base raster. This is a required parameter.

Returns:

the Input Test Raster

setInTestRaster

public void setInTestRaster(Object inTestRaster)

Sets the Input Test Raster parameter of this tool . This parameter is Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the input base raster. This is a required parameter.

Parameters:

inTestRaster - Raster Layer | Raster Catalog Layer, the raster dataset that will be compared to the input base raster.

getCompareType

public String getCompareType()

Returns the Compare Type parameter of this tool . This parameter is String, the type of comparison. This is an optional parameter.

Returns:

the Compare Type

setCompareType

public void setCompareType(String compareType)

Sets the Compare Type parameter of this tool . This parameter is String, the type of comparison. This is an optional parameter.

Parameters:

compareType - String, the type of comparison.

getIgnoreOption

public Object getIgnoreOption()

Returns the Ignore Options parameter of this tool . This parameter is String, the properties specified will not be compared during comparison. This is an optional parameter.

Returns:

the Ignore Options

setIgnoreOption

public void setIgnoreOption(Object ignoreOption)

Sets the Ignore Options parameter of this tool . This parameter is String, the properties specified will not be compared during comparison. This is an optional parameter.

Parameters:

ignoreOption - String, the properties specified will not be compared during comparison.

getContinueCompare

public String getContinueCompare()

Returns the Continue Comparison parameter of this tool . This parameter is String, indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Returns:

the Continue Comparison

setContinueCompare

public void setContinueCompare(String continueCompare)

Sets the Continue Comparison parameter of this tool . This parameter is String, indicates whether to compare all properties after encountering the first mismatch. This is an optional parameter.

Parameters:

continueCompare - String, indicates whether to compare all properties after encountering the first mismatch.

getOutCompareFile

public Object getOutCompareFile()

Returns the Output Compare File parameter of this tool . This parameter is Text File, the name and path of the text file which will contain the comparison results. This is an optional parameter.

Returns:

the Output Compare File

setOutCompareFile

public void setOutCompareFile(Object outCompareFile)

Sets the Output Compare File parameter of this tool . This parameter is Text File, the name and path of the text file which will contain the comparison results. This is an optional parameter.

Parameters:

outCompareFile - Text File, the name and path of the text file which will contain the comparison results.

getParameterTolerances

public Object getParameterTolerances()

Returns the Parameter Tolerance parameter of this tool . This parameter is string, type the parameter name, tolerance, and tolerance type for each parameter that you want to have a tolerance for. The tolerance type is either the value of the tolerance or a fraction of it. When using the fraction type, the fraction is based on the base value, therefore the tolerance value for comparison would be the fraction times the base value. For example, if your base value is 100 and you set the fraction tolerance to 0.00001, the compare tolerance will be 100 * 0.00001 = 0.001. This is an optional parameter.

Returns:

the Parameter Tolerance

setParameterTolerances

public void setParameterTolerances(Object parameterTolerances)

Sets the Parameter Tolerance parameter of this tool . This parameter is string, type the parameter name, tolerance, and tolerance type for each parameter that you want to have a tolerance for. The tolerance type is either the value of the tolerance or a fraction of it. When using the fraction type, the fraction is based on the base value, therefore the tolerance value for comparison would be the fraction times the base value. For example, if your base value is 100 and you set the fraction tolerance to 0.00001, the compare tolerance will be 100 * 0.00001 = 0.001. This is an optional parameter.

Parameters:

parameterTolerances - string, type the parameter name, tolerance, and tolerance type for each parameter that you want to have a tolerance for. The tolerance type is either the value of the tolerance or a fraction of it. When using the fraction type, the fraction is based on the base value, therefore the tolerance value for comparison would be the fraction times the base value. For example, if your base value is 100 and you set the fraction tolerance to 0.00001, the compare tolerance will be 100 * 0.00001 = 0.001.

getAttributeTolerances

public Object getAttributeTolerances()

Returns the Attribute Tolerance parameter of this tool . This parameter is string, type the field name and tolerance value for each parameter that you want to have a tolerance for. The tolerance value is the actual value of the tolerance, not a fraction. This is an optional parameter.

Returns:

the Attribute Tolerance

setAttributeTolerances

public void setAttributeTolerances(Object attributeTolerances)

Sets the Attribute Tolerance parameter of this tool . This parameter is string, type the field name and tolerance value for each parameter that you want to have a tolerance for. The tolerance value is the actual value of the tolerance, not a fraction. This is an optional parameter.

Parameters:

attributeTolerances - string, type the field name and tolerance value for each parameter that you want to have a tolerance for. The tolerance value is the actual value of the tolerance, not a fraction.

getOmitField

public Object getOmitField()

Returns the Omit Fields parameter of this tool . This parameter is string, when dealing with a raster catalog scenario, you are comparing attribute columns of the raster catalogs, not any attributes within the catalog items. This is an optional parameter.

Returns:

the Omit Fields

setOmitField

public void setOmitField(Object omitField)

Sets the Omit Fields parameter of this tool . This parameter is string, when dealing with a raster catalog scenario, you are comparing attribute columns of the raster catalogs, not any attributes within the catalog items. This is an optional parameter.

Parameters:

omitField - string, when dealing with a raster catalog scenario, you are comparing attribute columns of the raster catalogs, not any attributes within the catalog items.

getCompareStatus

public String getCompareStatus()

Returns the Compare Status parameter of this tool (Read only). This is an derived parameter.

Returns:

the Compare Status

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