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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.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 3D Analyst Tools tool box.

Usage tips:

• Determining observer points is a computer-intensive process. The processing time is dependent on the resolution. For preliminary studies, you may want to use a coarser cell size to reduce the number of cells in the input. Use the full resolution raster when the final results are ready to be generated.
• If the input raster contains undesirable noise caused by sampling errors, and you have Spatial Analyst available, you can smooth the raster with a low-pass filter, such as the Mean option of Focal Statistics, before running this tool.
• The visibility of each cell center is determined by comparing the altitude angle to the cell center with the altitude angle to the local horizon. The local horizon is computed by considering the intervening terrain between the point of observation and the current cell center. If the point lies above the local horizon, it is considered visible.
• This tool does respect the environment.

Field Summary

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

vals

Constructor Summary

Viewshed()
Creates the Viewshed tool with defaults.

Viewshed(java.lang.Object inRaster, java.lang.Object inObserverFeatures, java.lang.Object outRaster)
Creates the Viewshed tool with the required parameters.

Method Summary

java.lang.String	getCurvatureCorrection() Returns the Use earth curvature corrections parameter of this tool .
java.lang.Object	getInObserverFeatures() Returns the Input point or polyline observer features parameter of this tool .
java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
double	getRefractivityCoefficient() Returns the Refractivity coefficient 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.
double	getZFactor() Returns the Z factor parameter of this tool .
void	setCurvatureCorrection(java.lang.String curvatureCorrection) Sets the Use earth curvature corrections parameter of this tool .
void	setInObserverFeatures(java.lang.Object inObserverFeatures) Sets the Input point or polyline observer features parameter of this tool .
void	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(java.lang.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(java.lang.Object inRaster,
                java.lang.Object inObserverFeatures,
                java.lang.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 - null

Method Detail

getInRaster

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

Returns the Output raster parameter of this tool . This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This is a required parameter.

Parameters:

outRaster - null

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