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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.EditSignatures
All Implemented Interfaces:
GPTool

public class EditSignatures
extends AbstractGPTool

Edits and updates a signature file by merging, renumbering, and deleting class signatures. The Edit Signatures tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Edit Signatures works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
EditSignatures()
          Creates the Edit Signatures tool with defaults.
EditSignatures(Object inRasterBands, Object inSignatureFile, Object inSignatureRemapFile, Object outSignatureFile)
          Creates the Edit Signatures tool with the required parameters.
 
Method Summary
 Object getInRasterBands()
          Returns the Input raster bands parameter of this tool .
 Object getInSignatureFile()
          Returns the Input signature file parameter of this tool .
 Object getInSignatureRemapFile()
          Returns the Input signature remap file parameter of this tool .
 Object getOutSignatureFile()
          Returns the Output signature file parameter of this tool .
 int getSampleInterval()
          Returns the Sample interval 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 setInRasterBands(Object inRasterBands)
          Sets the Input raster bands parameter of this tool .
 void setInSignatureFile(Object inSignatureFile)
          Sets the Input signature file parameter of this tool .
 void setInSignatureRemapFile(Object inSignatureRemapFile)
          Sets the Input signature remap file parameter of this tool .
 void setOutSignatureFile(Object outSignatureFile)
          Sets the Output signature file parameter of this tool .
 void setSampleInterval(int sampleInterval)
          Sets the Sample interval 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

EditSignatures

public EditSignatures()
Creates the Edit Signatures tool with defaults.

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


EditSignatures

public EditSignatures(Object inRasterBands,
                      Object inSignatureFile,
                      Object inSignatureRemapFile,
                      Object outSignatureFile)
Creates the Edit Signatures 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:
inRasterBands - Composite Geodataset, the input raster bands to edit the signatures for.
inSignatureFile - File, a ".gsg" extension is required.
inSignatureRemapFile - File, the extension can be ".rmp", ".asc" or ".txt". The default is ".rmp".
outSignatureFile - File, a ".gsg" extension is required.
Method Detail

getInRasterBands

public Object getInRasterBands()
Returns the Input raster bands parameter of this tool . This parameter is Composite Geodataset, the input raster bands to edit the signatures for. This is a required parameter.

Returns:
the Input raster bands

setInRasterBands

public void setInRasterBands(Object inRasterBands)
Sets the Input raster bands parameter of this tool . This parameter is Composite Geodataset, the input raster bands to edit the signatures for. This is a required parameter.

Parameters:
inRasterBands - Composite Geodataset, the input raster bands to edit the signatures for.

getInSignatureFile

public Object getInSignatureFile()
Returns the Input signature file parameter of this tool . This parameter is File, a ".gsg" extension is required. This is a required parameter.

Returns:
the Input signature file

setInSignatureFile

public void setInSignatureFile(Object inSignatureFile)
Sets the Input signature file parameter of this tool . This parameter is File, a ".gsg" extension is required. This is a required parameter.

Parameters:
inSignatureFile - File, a ".gsg" extension is required.

getInSignatureRemapFile

public Object getInSignatureRemapFile()
Returns the Input signature remap file parameter of this tool . This parameter is File, the extension can be ".rmp", ".asc" or ".txt". The default is ".rmp". This is a required parameter.

Returns:
the Input signature remap file

setInSignatureRemapFile

public void setInSignatureRemapFile(Object inSignatureRemapFile)
Sets the Input signature remap file parameter of this tool . This parameter is File, the extension can be ".rmp", ".asc" or ".txt". The default is ".rmp". This is a required parameter.

Parameters:
inSignatureRemapFile - File, the extension can be ".rmp", ".asc" or ".txt". The default is ".rmp".

getOutSignatureFile

public Object getOutSignatureFile()
Returns the Output signature file parameter of this tool . This parameter is File, a ".gsg" extension is required. This is a required parameter.

Returns:
the Output signature file

setOutSignatureFile

public void setOutSignatureFile(Object outSignatureFile)
Sets the Output signature file parameter of this tool . This parameter is File, a ".gsg" extension is required. This is a required parameter.

Parameters:
outSignatureFile - File, a ".gsg" extension is required.

getSampleInterval

public int getSampleInterval()
Returns the Sample interval parameter of this tool . This parameter is Long, the default is 10. This is an optional parameter.

Returns:
the Sample interval

setSampleInterval

public void setSampleInterval(int sampleInterval)
Sets the Sample interval parameter of this tool . This parameter is Long, the default is 10. This is an optional parameter.

Parameters:
sampleInterval - Long, the default is 10.

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