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

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

All Implemented Interfaces:

GPTool

public class Dendrogram

extends AbstractGPTool

Constructs a tree diagram showing attribute distances between sequentially merged classes in a signature file. The Dendrogram tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Dendrogram works

Software restrictions: none

Usage tips:

• The input signature file must be an ASCII file in the prescribed signature file format (see Create Signatures; ). A signature file can be created with the Iso Cluster or Create Signatures tools. The file must have a minimum of two classes.
• A signature file can be recognized by its ".gsg" extension.
• The output of Dendrogram is an ASCII text file. The file has two components, a table and a graph. The first component is a table of distances between pairs of sequentially merged classes. The second component is a graphical representation of the classes, demonstrating the relationships and the hierarchy of the merging. The graph illustrates relative distances between pairs of merged classes, which are based on statistically determined similarities, in a signature file. The classes themselves represent clusters of cells or cells from training samples extracted from the study site. By analyzing the graph and the associate table, you can determine the potential of merging classes.
• The default extension for the output text file is ".txt". It can also be ".asc".
• The proximity of a pair of classes within a signature file is measured by the attribute distance.
• The value entered for the line width of Dendrogram specifies the width of the graph based on the number of characters. The default value of 78 is also the minimum valid number of characters. If numbers less than this are entered, the default value of 78 will be applied. When specifying values higher than the default, the resolution of the graph will increase, which may provide more accurate interpolation of the distances.
• To make the display of the dendrogram meaningful, the ASCII file should be displayed with a non-proportional font, such as Courier.

Field Summary

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

vals

Constructor Summary

Dendrogram()
Creates the Dendrogram tool with defaults.

Dendrogram(java.lang.Object inSignatureFile, java.lang.Object outDendrogramFile)
Creates the Dendrogram tool with the required parameters.

Method Summary

java.lang.String	getDistanceCalculation() Returns the Use variance in distance calculations parameter of this tool .
java.lang.Object	getInSignatureFile() Returns the Input signature file parameter of this tool .
int	getLineWidth() Returns the Line width of dendrogram parameter of this tool .
java.lang.Object	getOutDendrogramFile() Returns the Output dendrogram file parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setDistanceCalculation(java.lang.String distanceCalculation) Sets the Use variance in distance calculations parameter of this tool .
void	setInSignatureFile(java.lang.Object inSignatureFile) Sets the Input signature file parameter of this tool .
void	setLineWidth(int lineWidth) Sets the Line width of dendrogram parameter of this tool .
void	setOutDendrogramFile(java.lang.Object outDendrogramFile) Sets the Output dendrogram file 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

Dendrogram

public Dendrogram()

Creates the Dendrogram tool with defaults.

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

Dendrogram

public Dendrogram(java.lang.Object inSignatureFile,
                  java.lang.Object outDendrogramFile)

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

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

outDendrogramFile - File, the extension can be ".txt" or ".asc".

Method Detail

getInSignatureFile

public java.lang.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(java.lang.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.

getOutDendrogramFile

public java.lang.Object getOutDendrogramFile()

Returns the Output dendrogram file parameter of this tool . This parameter is File, the extension can be ".txt" or ".asc". This is a required parameter.

Returns:

the Output dendrogram file

setOutDendrogramFile

public void setOutDendrogramFile(java.lang.Object outDendrogramFile)

Sets the Output dendrogram file parameter of this tool . This parameter is File, the extension can be ".txt" or ".asc". This is a required parameter.

Parameters:

outDendrogramFile - File, the extension can be ".txt" or ".asc".

getDistanceCalculation

public java.lang.String getDistanceCalculation()

Returns the Use variance in distance calculations parameter of this tool . This parameter is String, specifies the manner in which the distances between classes in multidimensional attribute space are defined. This is an optional parameter.

Returns:

the Use variance in distance calculations

setDistanceCalculation

public void setDistanceCalculation(java.lang.String distanceCalculation)

Sets the Use variance in distance calculations parameter of this tool . This parameter is String, specifies the manner in which the distances between classes in multidimensional attribute space are defined. This is an optional parameter.

Parameters:

distanceCalculation - String, specifies the manner in which the distances between classes in multidimensional attribute space are defined.

• VARIANCE — The distances between classes will be computed based on the variances and the Euclidean distance between the means of their signatures.
• MEAN_ONLY — The distances between classes will be determined by the Euclidean distances between the means of the class signatures only.

getLineWidth

public int getLineWidth()

Returns the Line width of dendrogram parameter of this tool . This parameter is Long, the default is 78. This is an optional parameter.

Returns:

the Line width of dendrogram

setLineWidth

public void setLineWidth(int lineWidth)

Sets the Line width of dendrogram parameter of this tool . This parameter is Long, the default is 78. This is an optional parameter.

Parameters:

lineWidth - Long, the default is 78.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias