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

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

public class CreateSignatures
extends AbstractGPTool

Creates an ASCII signature file of classes defined by input sample data and a set of raster bands. The Create Signatures tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Create Signatures works

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateSignatures()
          Creates the Create Signatures tool with defaults.
CreateSignatures(Object inRasterBands, Object inSampleData, Object outSignatureFile)
          Creates the Create Signatures tool with the required parameters.
 
Method Summary
 String getComputeCovariance()
          Returns the Compute covariance matrices parameter of this tool .
 Object getInRasterBands()
          Returns the Input raster bands parameter of this tool .
 Object getInSampleData()
          Returns the Input raster or feature sample data parameter of this tool .
 Object getOutSignatureFile()
          Returns the Output signature file parameter of this tool .
 Object getSampleField()
          Returns the Sample field 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 setComputeCovariance(String computeCovariance)
          Sets the Compute covariance matrices parameter of this tool .
 void setInRasterBands(Object inRasterBands)
          Sets the Input raster bands parameter of this tool .
 void setInSampleData(Object inSampleData)
          Sets the Input raster or feature sample data parameter of this tool .
 void setOutSignatureFile(Object outSignatureFile)
          Sets the Output signature file parameter of this tool .
 void setSampleField(Object sampleField)
          Sets the Sample field 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

CreateSignatures

public CreateSignatures()
Creates the Create Signatures tool with defaults.

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


CreateSignatures

public CreateSignatures(Object inRasterBands,
                        Object inSampleData,
                        Object outSignatureFile)
Creates the Create 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 create the signatures for.
inSampleData - Composite Geodataset, the input can be an integer raster or a feature dataset.
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 create 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 create the signatures for. This is a required parameter.

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

getInSampleData

public Object getInSampleData()
Returns the Input raster or feature sample data parameter of this tool . This parameter is Composite Geodataset, the input can be an integer raster or a feature dataset. This is a required parameter.

Returns:
the Input raster or feature sample data

setInSampleData

public void setInSampleData(Object inSampleData)
Sets the Input raster or feature sample data parameter of this tool . This parameter is Composite Geodataset, the input can be an integer raster or a feature dataset. This is a required parameter.

Parameters:
inSampleData - Composite Geodataset, the input can be an integer raster or a feature dataset.

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.

getComputeCovariance

public String getComputeCovariance()
Returns the Compute covariance matrices parameter of this tool . This parameter is String, specifies whether covariance matrices are calculated. This is an optional parameter.

Returns:
the Compute covariance matrices

setComputeCovariance

public void setComputeCovariance(String computeCovariance)
Sets the Compute covariance matrices parameter of this tool . This parameter is String, specifies whether covariance matrices are calculated. This is an optional parameter.

Parameters:
computeCovariance - String, specifies whether covariance matrices are calculated.

getSampleField

public Object getSampleField()
Returns the Sample field parameter of this tool . This parameter is Field, if the in_sample_data is a raster, use the Value or any integer field. If the in_sample_data is a feature, use an integer field. This is an optional parameter.

Returns:
the Sample field

setSampleField

public void setSampleField(Object sampleField)
Sets the Sample field parameter of this tool . This parameter is Field, if the in_sample_data is a raster, use the Value or any integer field. If the in_sample_data is a feature, use an integer field. This is an optional parameter.

Parameters:
sampleField - Field, if the in_sample_data is a raster, use the Value or any integer field. If the in_sample_data is a feature, use an integer field.

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