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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• A .gsg extension should be used for the output signature file.
• The input raster bands and the input raster or feature sample data must have overlapping extents. The statistics will be computed for the common area only.
• The minimum valid number of class samples in the sample data is two. There is no maximum number of classes.
• If the signature file is to be used in further multivariate analysis tools that use covariance matrices, such as Maximum Likelihood Classification and Class Probability, the covariance matrices must be present. This information is generated when the Compute Covariance Matrices option in the dialog box is enabled, or the COVARIANCE option is specified in scripting. Note that this is the default setting. See to compare signature files when the covariance matrices are generated versus only the means.
• You should not change anything in the signature file except to enter the names of classes. The statistics in the file should be created and altered by Multivariate tools only.
• If the input is a layer created from a multiband raster with more than three bands, the operation will consider all the bands associated with the source dataset, not just the three bands that were loaded (symbolized) by the layer. If you want to process a subset of the bands in the source dataset use the tool to create an input layer containing the desired bands.
• The names of the classes in the output signature file are optional. They're used for reference only. Any text editor can be used to enter the names. Each class name must consist of a single string no more than 14 alphanumeric characters in length.

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 - the input raster bands for which to create the signatures.

inSampleData - the input delineating the set of class samples. the input can be an integer raster or a feature dataset.

outSignatureFile - the output signature file. a .gsg extension must be specified.

Method Detail

getInRasterBands

public Object getInRasterBands()

Returns the Input raster bands parameter of this tool . This parameter is the input raster bands for which to create the signatures. 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 the input raster bands for which to create the signatures. This is a required parameter.

Parameters:

inRasterBands - the input raster bands for which to create the signatures.

getInSampleData

public Object getInSampleData()

Returns the Input raster or feature sample data parameter of this tool . This parameter is the input delineating the set of class samples. 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 the input delineating the set of class samples. the input can be an integer raster or a feature dataset. This is a required parameter.

Parameters:

inSampleData - the input delineating the set of class samples. 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 the output signature file. a .gsg extension must be specified. 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 the output signature file. a .gsg extension must be specified. This is a required parameter.

Parameters:

outSignatureFile - the output signature file. a .gsg extension must be specified.

getComputeCovariance

public String getComputeCovariance()

Returns the Compute covariance matrices parameter of this tool . This parameter is specifies whether covariance matrices in addition to the means 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 specifies whether covariance matrices in addition to the means are calculated. This is an optional parameter.

Parameters:

computeCovariance - specifies whether covariance matrices in addition to the means are calculated.

getSampleField

public Object getSampleField()

Returns the Sample field parameter of this tool . This parameter is field of the input raster or feature sample data to assign values to the sampled locations (classes). only integer fields are valid fields. 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 of the input raster or feature sample data to assign values to the sampled locations (classes). only integer fields are valid fields. This is an optional parameter.

Parameters:

sampleField - field of the input raster or feature sample data to assign values to the sampled locations (classes). only integer fields are valid fields.

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