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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.LineOfSight

All Implemented Interfaces:

GPTool

public class LineOfSight
extends AbstractGPTool

Uses an input 2D or 3D polyline feature class along with a raster, TIN, or terrain surface to determine visibility between 'from' and 'to' points. Produces an output line feature class that contains line and target visibility information. If one or more targets are not visible, the Line of Sight tool produces an output point feature class. This contains the location of the first obstruction encountered for each line whose target is not visible. The Line Of Sight tool is contained in the 3D Analyst Tools tool box.
Learn more about how Line of Sight (3D Analyst) works

Software restrictions: none

Usage tips:

• The observer is the point from which visibility is determined. The target is the opposite end of the line, to which visibility is determined.
• Only the endpoints of the input line are used to determine target visibility.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

LineOfSight()
Creates the Line Of Sight tool with defaults.

LineOfSight(Object inSurface, Object inLineFeatureClass, Object outLosFeatureClass)
Creates the Line Of Sight tool with the required parameters.

Method Summary

Object	getInLineFeatureClass() Returns the Input Line Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
Object	getOutLosFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getOutObstructionFeatureClass() Returns the Output Obstruction Point Feature Class parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
double	getRefractionFactor() Returns the Refraction Factor 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.
String	getUseCurvature() Returns the Use Curvature parameter of this tool .
String	getUseRefraction() Returns the Use Refraction parameter of this tool .
void	setInLineFeatureClass(Object inLineFeatureClass) Sets the Input Line Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setOutLosFeatureClass(Object outLosFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutObstructionFeatureClass(Object outObstructionFeatureClass) Sets the Output Obstruction Point Feature Class parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setRefractionFactor(double refractionFactor) Sets the Refraction Factor parameter of this tool .
void	setUseCurvature(String useCurvature) Sets the Use Curvature parameter of this tool .
void	setUseRefraction(String useRefraction) Sets the Use Refraction 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

LineOfSight

public LineOfSight()

Creates the Line Of Sight tool with defaults.

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

LineOfSight

public LineOfSight(Object inSurface,
                   Object inLineFeatureClass,
                   Object outLosFeatureClass)

Creates the Line Of Sight 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:

inSurface - Tin Layer | Raster Layer, the input raster, TIN, or Terrain surface on which calculations will be based.

inLineFeatureClass - Feature Layer, the input polyline feature class along which visibility will be calculated. This may be a 2-D or 3-D feature class.

outLosFeatureClass - Feature Class, the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is Tin Layer | Raster Layer, the input raster, TIN, or Terrain surface on which calculations will be based. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is Tin Layer | Raster Layer, the input raster, TIN, or Terrain surface on which calculations will be based. This is a required parameter.

Parameters:

inSurface - Tin Layer | Raster Layer, the input raster, TIN, or Terrain surface on which calculations will be based.

getInLineFeatureClass

public Object getInLineFeatureClass()

Returns the Input Line Feature Class parameter of this tool . This parameter is Feature Layer, the input polyline feature class along which visibility will be calculated. This may be a 2-D or 3-D feature class. This is a required parameter.

Returns:

the Input Line Feature Class

setInLineFeatureClass

public void setInLineFeatureClass(Object inLineFeatureClass)

Sets the Input Line Feature Class parameter of this tool . This parameter is Feature Layer, the input polyline feature class along which visibility will be calculated. This may be a 2-D or 3-D feature class. This is a required parameter.

Parameters:

inLineFeatureClass - Feature Layer, the input polyline feature class along which visibility will be calculated. This may be a 2-D or 3-D feature class.

getOutLosFeatureClass

public Object getOutLosFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible. This is a required parameter.

Returns:

the Output Feature Class

setOutLosFeatureClass

public void setOutLosFeatureClass(Object outLosFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible. This is a required parameter.

Parameters:

outLosFeatureClass - Feature Class, the output line feature class along which visibility has been determined. Two attribute fields are created. VisCode indicates visibility along the line, 1 being visible and 2 not visible. TarIsVis indicates the target visibility, 0 being not visible and 1 being visible.

getOutObstructionFeatureClass

public Object getOutObstructionFeatureClass()

Returns the Output Obstruction Point Feature Class parameter of this tool . This parameter is Feature Class, the output point feature class indicating the first obstruction point along the line of sight if the target is not visible. This is an optional parameter.

Returns:

the Output Obstruction Point Feature Class

setOutObstructionFeatureClass

public void setOutObstructionFeatureClass(Object outObstructionFeatureClass)

Sets the Output Obstruction Point Feature Class parameter of this tool . This parameter is Feature Class, the output point feature class indicating the first obstruction point along the line of sight if the target is not visible. This is an optional parameter.

Parameters:

outObstructionFeatureClass - Feature Class, the output point feature class indicating the first obstruction point along the line of sight if the target is not visible.

getUseCurvature

public String getUseCurvature()

Returns the Use Curvature parameter of this tool . This parameter is String, use this option to incorporate earth curvature in the calculation. For this option to be enabled, the surface needs to have a defined spatial reference in projected coordinates with defined z units. This is an optional parameter.

Returns:

the Use Curvature

setUseCurvature

public void setUseCurvature(String useCurvature)

Sets the Use Curvature parameter of this tool . This parameter is String, use this option to incorporate earth curvature in the calculation. For this option to be enabled, the surface needs to have a defined spatial reference in projected coordinates with defined z units. This is an optional parameter.

Parameters:

useCurvature - String, use this option to incorporate earth curvature in the calculation. For this option to be enabled, the surface needs to have a defined spatial reference in projected coordinates with defined z units.

getUseRefraction

public String getUseRefraction()

Returns the Use Refraction parameter of this tool . This parameter is String, use this option to incorporate atmospheric refraction of light in the calculation. This is an optional parameter.

Returns:

the Use Refraction

setUseRefraction

public void setUseRefraction(String useRefraction)

Sets the Use Refraction parameter of this tool . This parameter is String, use this option to incorporate atmospheric refraction of light in the calculation. This is an optional parameter.

Parameters:

useRefraction - String, use this option to incorporate atmospheric refraction of light in the calculation.

getRefractionFactor

public double getRefractionFactor()

Returns the Refraction Factor parameter of this tool . This parameter is Double, provides a value to be used in the refraction factor. The default refraction factor is 0.13. This is an optional parameter.

Returns:

the Refraction Factor

setRefractionFactor

public void setRefractionFactor(double refractionFactor)

Sets the Refraction Factor parameter of this tool . This parameter is Double, provides a value to be used in the refraction factor. The default refraction factor is 0.13. This is an optional parameter.

Parameters:

refractionFactor - Double, provides a value to be used in the refraction factor. The default refraction factor is 0.13.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is Double, the resolution, given in z-tolerance, of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is Double, the resolution, given in z-tolerance, of the pyramid level to use for conversion. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - Double, the resolution, given in z-tolerance, of the pyramid level to use for conversion. The default is 0, full resolution.

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