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

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

All Implemented Interfaces:

GPTool

public class Skyline
extends AbstractGPTool

Generates a line feature class containing the results from a skyline silhouette analysis. The analysis is conducted from observer points above a functional or virtual surface and will also consider features that are encountered during the analysis. The Skyline tool is contained in the 3D Analyst Tools tool box.

Field Summary

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

vals

Constructor Summary

Skyline()
Creates the Skyline tool with defaults.

Skyline(Object inObserverPointFeatures, Object outFeatureClass)
Creates the Skyline tool with the required parameters.

Method Summary

Object	getAzimuthIncrementValueOrField() Returns the Azimuth Increment parameter of this tool .
String	getFeatureLod() Returns the Feature Level of Detail parameter of this tool .
Object	getFromAzimuthValueOrField() Returns the From Azimuth parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getInObserverPointFeatures() Returns the Input Observer Point Features parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
Object	getMaxHorizonRadius() Returns the Maximum Horizon Radius parameter of this tool .
Object	getOutFeatureClass() Returns the Output Skyline 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	getScaleAccordingTo() Returns the Scale According To parameter of this tool .
String	getScaleMethod() Returns the Scale Method parameter of this tool .
double	getScaleToPercent() Returns the Scale To Percent parameter of this tool .
String	getSegmentSkyline() Returns the Segment Skyline parameter of this tool .
Object	getToAzimuthValueOrField() Returns the To Azimuth 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 .
Object	getVirtualSurfaceElevation() Returns the Virtual Surface Elevation parameter of this tool .
Object	getVirtualSurfaceRadius() Returns the Virtual Surface Radius parameter of this tool .
void	setAzimuthIncrementValueOrField(Object azimuthIncrementValueOrField) Sets the Azimuth Increment parameter of this tool .
void	setFeatureLod(String featureLod) Sets the Feature Level of Detail parameter of this tool .
void	setFromAzimuthValueOrField(Object fromAzimuthValueOrField) Sets the From Azimuth parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setInObserverPointFeatures(Object inObserverPointFeatures) Sets the Input Observer Point Features parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setMaxHorizonRadius(Object maxHorizonRadius) Sets the Maximum Horizon Radius parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Skyline 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	setScaleAccordingTo(String scaleAccordingTo) Sets the Scale According To parameter of this tool .
void	setScaleMethod(String scaleMethod) Sets the Scale Method parameter of this tool .
void	setScaleToPercent(double scaleToPercent) Sets the Scale To Percent parameter of this tool .
void	setSegmentSkyline(String segmentSkyline) Sets the Segment Skyline parameter of this tool .
void	setToAzimuthValueOrField(Object toAzimuthValueOrField) Sets the To Azimuth 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 .
void	setVirtualSurfaceElevation(Object virtualSurfaceElevation) Sets the Virtual Surface Elevation parameter of this tool .
void	setVirtualSurfaceRadius(Object virtualSurfaceRadius) Sets the Virtual Surface Radius 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

Skyline

public Skyline()

Creates the Skyline tool with defaults.

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

Skyline

public Skyline(Object inObserverPointFeatures,
               Object outFeatureClass)

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

inObserverPointFeatures - the 3D points representing observers; a separate skyline is generated for each.

outFeatureClass - the line feature class into which the skyline(s) will be placed.

Method Detail

getInObserverPointFeatures

public Object getInObserverPointFeatures()

Returns the Input Observer Point Features parameter of this tool . This parameter is the 3D points representing observers; a separate skyline is generated for each. This is a required parameter.

Returns:

the Input Observer Point Features

setInObserverPointFeatures

public void setInObserverPointFeatures(Object inObserverPointFeatures)

Sets the Input Observer Point Features parameter of this tool . This parameter is the 3D points representing observers; a separate skyline is generated for each. This is a required parameter.

Parameters:

inObserverPointFeatures - the 3D points representing observers; a separate skyline is generated for each.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Skyline Feature Class parameter of this tool . This parameter is the line feature class into which the skyline(s) will be placed. This is a required parameter.

Returns:

the Output Skyline Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Skyline Feature Class parameter of this tool . This parameter is the line feature class into which the skyline(s) will be placed. This is a required parameter.

Parameters:

outFeatureClass - the line feature class into which the skyline(s) will be placed.

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the functional surface for determining the horizon. This is an optional parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the functional surface for determining the horizon. This is an optional parameter.

Parameters:

inSurface - the functional surface for determining the horizon.

getVirtualSurfaceRadius

public Object getVirtualSurfaceRadius()

Returns the Virtual Surface Radius parameter of this tool . This parameter is the radius of the virtual surface for defining the horizon in lieu of an actual surface. Must be a positive value. Ignored if an actual surface is provided. The default is 1000. This is an optional parameter.

Returns:

the Virtual Surface Radius

setVirtualSurfaceRadius

public void setVirtualSurfaceRadius(Object virtualSurfaceRadius)

Sets the Virtual Surface Radius parameter of this tool . This parameter is the radius of the virtual surface for defining the horizon in lieu of an actual surface. Must be a positive value. Ignored if an actual surface is provided. The default is 1000. This is an optional parameter.

Parameters:

virtualSurfaceRadius - the radius of the virtual surface for defining the horizon in lieu of an actual surface. Must be a positive value. Ignored if an actual surface is provided. The default is 1000.

getVirtualSurfaceElevation

public Object getVirtualSurfaceElevation()

Returns the Virtual Surface Elevation parameter of this tool . This parameter is the elevation of the virtual surface for defining the horizon in lieu of an actual surface. Ignored if an actual surface is provided. The default is 0. This is an optional parameter.

Returns:

the Virtual Surface Elevation

setVirtualSurfaceElevation

public void setVirtualSurfaceElevation(Object virtualSurfaceElevation)

Sets the Virtual Surface Elevation parameter of this tool . This parameter is the elevation of the virtual surface for defining the horizon in lieu of an actual surface. Ignored if an actual surface is provided. The default is 0. This is an optional parameter.

Parameters:

virtualSurfaceElevation - the elevation of the virtual surface for defining the horizon in lieu of an actual surface. Ignored if an actual surface is provided. The default is 0.

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the feature class to use in the skyline analysis. The features typically represent obstructions such as city buildings. This is an optional parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the feature class to use in the skyline analysis. The features typically represent obstructions such as city buildings. This is an optional parameter.

Parameters:

inFeatures - the feature class to use in the skyline analysis. The features typically represent obstructions such as city buildings.

getFeatureLod

public String getFeatureLod()

Returns the Feature Level of Detail parameter of this tool . This parameter is the level of detail at which each feature should be examined in the skyline analysis. This is an optional parameter.

Returns:

the Feature Level of Detail

setFeatureLod

public void setFeatureLod(String featureLod)

Sets the Feature Level of Detail parameter of this tool . This parameter is the level of detail at which each feature should be examined in the skyline analysis. This is an optional parameter.

Parameters:

featureLod - the level of detail at which each feature should be examined in the skyline analysis.

getFromAzimuthValueOrField

public Object getFromAzimuthValueOrField()

Returns the From Azimuth parameter of this tool . This parameter is the azimuth, in degrees, from which the skyline analysis should be started. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be greater than minus 360 and less than 360. The default is 0. This is an optional parameter.

Returns:

the From Azimuth

setFromAzimuthValueOrField

public void setFromAzimuthValueOrField(Object fromAzimuthValueOrField)

Sets the From Azimuth parameter of this tool . This parameter is the azimuth, in degrees, from which the skyline analysis should be started. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be greater than minus 360 and less than 360. The default is 0. This is an optional parameter.

Parameters:

fromAzimuthValueOrField - the azimuth, in degrees, from which the skyline analysis should be started. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be greater than minus 360 and less than 360. The default is 0.

getToAzimuthValueOrField

public Object getToAzimuthValueOrField()

Returns the To Azimuth parameter of this tool . This parameter is the direction, in degrees, at which the skyline analysis should be completed. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be no more than 360 greater than the From Azimuth. The default is 360. This is an optional parameter.

Returns:

the To Azimuth

setToAzimuthValueOrField

public void setToAzimuthValueOrField(Object toAzimuthValueOrField)

Sets the To Azimuth parameter of this tool . This parameter is the direction, in degrees, at which the skyline analysis should be completed. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be no more than 360 greater than the From Azimuth. The default is 360. This is an optional parameter.

Parameters:

toAzimuthValueOrField - the direction, in degrees, at which the skyline analysis should be completed. The analysis starts from the observer point and goes to the right, from the From Azimuth until the To Azimuth is reached. Must be no more than 360 greater than the From Azimuth. The default is 360.

getAzimuthIncrementValueOrField

public Object getAzimuthIncrementValueOrField()

Returns the Azimuth Increment parameter of this tool . This parameter is the angular interval, in degrees, at which the horizon should be evaluated while conducting the skyline analysis between the From Azimuth and the To Azimuth. Must be no greater than the To Azimuth minus the From Azimuth. The default is 1. This is an optional parameter.

Returns:

the Azimuth Increment

setAzimuthIncrementValueOrField

public void setAzimuthIncrementValueOrField(Object azimuthIncrementValueOrField)

Sets the Azimuth Increment parameter of this tool . This parameter is the angular interval, in degrees, at which the horizon should be evaluated while conducting the skyline analysis between the From Azimuth and the To Azimuth. Must be no greater than the To Azimuth minus the From Azimuth. The default is 1. This is an optional parameter.

Parameters:

azimuthIncrementValueOrField - the angular interval, in degrees, at which the horizon should be evaluated while conducting the skyline analysis between the From Azimuth and the To Azimuth. Must be no greater than the To Azimuth minus the From Azimuth. The default is 1.

getMaxHorizonRadius

public Object getMaxHorizonRadius()

Returns the Maximum Horizon Radius parameter of this tool . This parameter is the maximum distance for which a horizon should be sought from the observer location. A value of zero indicates that there should be no limit imposed. The default is 0. This is an optional parameter.

Returns:

the Maximum Horizon Radius

setMaxHorizonRadius

public void setMaxHorizonRadius(Object maxHorizonRadius)

Sets the Maximum Horizon Radius parameter of this tool . This parameter is the maximum distance for which a horizon should be sought from the observer location. A value of zero indicates that there should be no limit imposed. The default is 0. This is an optional parameter.

Parameters:

maxHorizonRadius - the maximum distance for which a horizon should be sought from the observer location. A value of zero indicates that there should be no limit imposed. The default is 0.

getSegmentSkyline

public String getSegmentSkyline()

Returns the Segment Skyline parameter of this tool . This parameter is instead of one only one line being generated to represent the skyline from each observer point, the output is split into multiple lines. Each of these lines represents a different feature, or a stretch of horizon between features. This is an optional parameter.

Returns:

the Segment Skyline

setSegmentSkyline

public void setSegmentSkyline(String segmentSkyline)

Sets the Segment Skyline parameter of this tool . This parameter is instead of one only one line being generated to represent the skyline from each observer point, the output is split into multiple lines. Each of these lines represents a different feature, or a stretch of horizon between features. This is an optional parameter.

Parameters:

segmentSkyline - instead of one only one line being generated to represent the skyline from each observer point, the output is split into multiple lines. Each of these lines represents a different feature, or a stretch of horizon between features.

getScaleToPercent

public double getScaleToPercent()

Returns the Scale To Percent parameter of this tool . This parameter is indicates to what percent of the original vertical angle (angle above the horizon, or angle of elevation) or elevation each skyline vertex should be placed. If either 0 or 100 is entered then no scaling will occur. The default is 100. This is an optional parameter.

Returns:

the Scale To Percent

setScaleToPercent

public void setScaleToPercent(double scaleToPercent)

Sets the Scale To Percent parameter of this tool . This parameter is indicates to what percent of the original vertical angle (angle above the horizon, or angle of elevation) or elevation each skyline vertex should be placed. If either 0 or 100 is entered then no scaling will occur. The default is 100. This is an optional parameter.

Parameters:

scaleToPercent - indicates to what percent of the original vertical angle (angle above the horizon, or angle of elevation) or elevation each skyline vertex should be placed. If either 0 or 100 is entered then no scaling will occur. The default is 100.

getScaleAccordingTo

public String getScaleAccordingTo()

Returns the Scale According To parameter of this tool . This parameter is the values according to which the scaling should be determined. This is an optional parameter.

Returns:

the Scale According To

setScaleAccordingTo

public void setScaleAccordingTo(String scaleAccordingTo)

Sets the Scale According To parameter of this tool . This parameter is the values according to which the scaling should be determined. This is an optional parameter.

Parameters:

scaleAccordingTo - the values according to which the scaling should be determined.

getScaleMethod

public String getScaleMethod()

Returns the Scale Method parameter of this tool . This parameter is the vertex to be used to calculate against. This is an optional parameter.

Returns:

the Scale Method

setScaleMethod

public void setScaleMethod(String scaleMethod)

Sets the Scale Method parameter of this tool . This parameter is the vertex to be used to calculate against. This is an optional parameter.

Parameters:

scaleMethod - the vertex to be used to calculate against.

getUseCurvature

public String getUseCurvature()

Returns the Use Curvature parameter of this tool . This parameter is indicates whether the earth's curvature should be taken into consideration when generating the ridgeline from a functional surface. 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 indicates whether the earth's curvature should be taken into consideration when generating the ridgeline from a functional surface. This is an optional parameter.

Parameters:

useCurvature - indicates whether the earth's curvature should be taken into consideration when generating the ridgeline from a functional surface.

getUseRefraction

public String getUseRefraction()

Returns the Use Refraction parameter of this tool . This parameter is indicates whether atmospheric refraction should be taken into consideration when generating the ridgeline from a functional surface. 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 indicates whether atmospheric refraction should be taken into consideration when generating the ridgeline from a functional surface. This is an optional parameter.

Parameters:

useRefraction - indicates whether atmospheric refraction should be taken into consideration when generating the ridgeline from a functional surface.

getRefractionFactor

public double getRefractionFactor()

Returns the Refraction Factor parameter of this tool . This parameter is if atmospheric refraction is considered, then apply a scalar value. The default 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 if atmospheric refraction is considered, then apply a scalar value. The default is 0.13. This is an optional parameter.

Parameters:

refractionFactor - if atmospheric refraction is considered, then apply a scalar value. The default is 0.13.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is if a terrain is specified for a functional surface, then this parameter is populated with the resolutions resident in the terrain. One of the resolutions may be chosen for the purpose of generating the horizon line. 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 if a terrain is specified for a functional surface, then this parameter is populated with the resolutions resident in the terrain. One of the resolutions may be chosen for the purpose of generating the horizon line. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - if a terrain is specified for a functional surface, then this parameter is populated with the resolutions resident in the terrain. One of the resolutions may be chosen for the purpose of generating the horizon line. 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