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

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


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Dendrogram()
          Creates the Dendrogram tool with defaults.
Dendrogram(Object inSignatureFile, Object outDendrogramFile)
          Creates the Dendrogram tool with the required parameters.
 
Method Summary
 String getDistanceCalculation()
          Returns the Use variance in distance calculations parameter of this tool .
 Object getInSignatureFile()
          Returns the Input signature file parameter of this tool .
 int getLineWidth()
          Returns the Line width of dendrogram parameter of this tool .
 Object getOutDendrogramFile()
          Returns the Output dendrogram file 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 setDistanceCalculation(String distanceCalculation)
          Sets the Use variance in distance calculations parameter of this tool .
 void setInSignatureFile(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(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(Object inSignatureFile,
                  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 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.

getOutDendrogramFile

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

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 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