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

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

public class Viewshed
extends AbstractGPTool

Determines the raster surface locations visible to a set of observer features. The Viewshed tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Viewshed()
          Creates the Viewshed tool with defaults.
Viewshed(Object inRaster, Object inObserverFeatures, Object outRaster)
          Creates the Viewshed tool with the required parameters.
 
Method Summary
 String getCurvatureCorrection()
          Returns the Use earth curvature corrections parameter of this tool .
 Object getInObserverFeatures()
          Returns the Input point or polyline observer features parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 Object getOutRaster()
          Returns the Output raster parameter of this tool .
 double getRefractivityCoefficient()
          Returns the Refractivity coefficient 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.
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setCurvatureCorrection(String curvatureCorrection)
          Sets the Use earth curvature corrections parameter of this tool .
 void setInObserverFeatures(Object inObserverFeatures)
          Sets the Input point or polyline observer features parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster parameter of this tool .
 void setRefractivityCoefficient(double refractivityCoefficient)
          Sets the Refractivity coefficient parameter of this tool .
 void setZFactor(double zFactor)
          Sets the Z factor 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

Viewshed

public Viewshed()
Creates the Viewshed tool with defaults.

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


Viewshed

public Viewshed(Object inRaster,
                Object inObserverFeatures,
                Object outRaster)
Creates the Viewshed 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:
inRaster - the input surface raster.
inObserverFeatures - the feature class that identifies the observer locations. the input can be point or polyline features.
outRaster - the output raster. the output will only record the number of times that each cell location in the input surface raster can be seen by the input observation points (or vertices for polylines). The observation frequency will be recorded in the VALUE item in the output raster's attribute table.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is the input surface raster. This is a required parameter.

Returns:
the Input raster

setInRaster

public void setInRaster(Object inRaster)
Sets the Input raster parameter of this tool . This parameter is the input surface raster. This is a required parameter.

Parameters:
inRaster - the input surface raster.

getInObserverFeatures

public Object getInObserverFeatures()
Returns the Input point or polyline observer features parameter of this tool . This parameter is the feature class that identifies the observer locations. the input can be point or polyline features. This is a required parameter.

Returns:
the Input point or polyline observer features

setInObserverFeatures

public void setInObserverFeatures(Object inObserverFeatures)
Sets the Input point or polyline observer features parameter of this tool . This parameter is the feature class that identifies the observer locations. the input can be point or polyline features. This is a required parameter.

Parameters:
inObserverFeatures - the feature class that identifies the observer locations. the input can be point or polyline features.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is the output raster. the output will only record the number of times that each cell location in the input surface raster can be seen by the input observation points (or vertices for polylines). The observation frequency will be recorded in the VALUE item in the output raster's attribute table. This is a required parameter.

Returns:
the Output raster

setOutRaster

public void setOutRaster(Object outRaster)
Sets the Output raster parameter of this tool . This parameter is the output raster. the output will only record the number of times that each cell location in the input surface raster can be seen by the input observation points (or vertices for polylines). The observation frequency will be recorded in the VALUE item in the output raster's attribute table. This is a required parameter.

Parameters:
outRaster - the output raster. the output will only record the number of times that each cell location in the input surface raster can be seen by the input observation points (or vertices for polylines). The observation frequency will be recorded in the VALUE item in the output raster's attribute table.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Returns:
the Z factor

setZFactor

public void setZFactor(double zFactor)
Sets the Z factor parameter of this tool . This parameter is number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter). This is an optional parameter.

Parameters:
zFactor - number of ground x,y units in one surface z unit. the z-factor adjusts the units of measure for the z units when they are different from the x,y units of the input surface. The z-values of the input surface are multiplied by the z-factor when calculating the final output surface. if the x,y units and z units are in the same units of measure, the z-factor is 1. This is the default. if the x,y units and z units are in different units of measure, the z-factor must be set to the appropriate factor, or the results will be incorrect. For example, if your z units are feet and your x,y units are meters, you would use a z-factor of 0.3048 to convert your z units from feet to meters (1 foot = 0.3048 meter).

getCurvatureCorrection

public String getCurvatureCorrection()
Returns the Use earth curvature corrections parameter of this tool . This parameter is allows correction for the earth's curvature. This is an optional parameter.

Returns:
the Use earth curvature corrections

setCurvatureCorrection

public void setCurvatureCorrection(String curvatureCorrection)
Sets the Use earth curvature corrections parameter of this tool . This parameter is allows correction for the earth's curvature. This is an optional parameter.

Parameters:
curvatureCorrection - allows correction for the earth's curvature.

getRefractivityCoefficient

public double getRefractivityCoefficient()
Returns the Refractivity coefficient parameter of this tool . This parameter is coefficient of the refraction of visible light in air. the default value is 0.13. This is an optional parameter.

Returns:
the Refractivity coefficient

setRefractivityCoefficient

public void setRefractivityCoefficient(double refractivityCoefficient)
Sets the Refractivity coefficient parameter of this tool . This parameter is coefficient of the refraction of visible light in air. the default value is 0.13. This is an optional parameter.

Parameters:
refractivityCoefficient - coefficient of the refraction of visible light in air. the default value is 0.13.

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