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

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

public class HillShade
extends AbstractGPTool

Computes hillshade values for a raster surface by considering the illumination angle and shadows. The Hillshade tool is contained in the 3D Analyst Tools tool box.
Learn more about how Hillshade works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
HillShade()
          Creates the Hillshade tool with defaults.
HillShade(Object inRaster, Object outRaster)
          Creates the Hillshade tool with the required parameters.
 
Method Summary
 double getAltitude()
          Returns the Altitude parameter of this tool .
 double getAzimuth()
          Returns the Azimuth parameter of this tool .
 Object getInRaster()
          Returns the Input raster parameter of this tool .
 String getModelShadows()
          Returns the Model shadows parameter of this tool .
 Object getOutRaster()
          Returns the Output raster 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 setAltitude(double altitude)
          Sets the Altitude parameter of this tool .
 void setAzimuth(double azimuth)
          Sets the Azimuth parameter of this tool .
 void setInRaster(Object inRaster)
          Sets the Input raster parameter of this tool .
 void setModelShadows(String modelShadows)
          Sets the Model shadows parameter of this tool .
 void setOutRaster(Object outRaster)
          Sets the Output raster 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

HillShade

public HillShade()
Creates the Hillshade tool with defaults.

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


HillShade

public HillShade(Object inRaster,
                 Object outRaster)
Creates the Hillshade 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 - Composite Geodataset, input raster.
outRaster - Raster Dataset, the hillshade raster has an integer value range of 0 to 255.
Method Detail

getInRaster

public Object getInRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input 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 Composite Geodataset, input raster. This is a required parameter.

Parameters:
inRaster - Composite Geodataset, input raster.

getOutRaster

public Object getOutRaster()
Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the hillshade raster has an integer value range of 0 to 255. 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 Raster Dataset, the hillshade raster has an integer value range of 0 to 255. This is a required parameter.

Parameters:
outRaster - Raster Dataset, the hillshade raster has an integer value range of 0 to 255.

getAzimuth

public double getAzimuth()
Returns the Azimuth parameter of this tool . This parameter is Double, the default is 315 degrees. This is an optional parameter.

Returns:
the Azimuth

setAzimuth

public void setAzimuth(double azimuth)
Sets the Azimuth parameter of this tool . This parameter is Double, the default is 315 degrees. This is an optional parameter.

Parameters:
azimuth - Double, the default is 315 degrees.

getAltitude

public double getAltitude()
Returns the Altitude parameter of this tool . This parameter is Double, the default is 45 degrees. This is an optional parameter.

Returns:
the Altitude

setAltitude

public void setAltitude(double altitude)
Sets the Altitude parameter of this tool . This parameter is Double, the default is 45 degrees. This is an optional parameter.

Parameters:
altitude - Double, the default is 45 degrees.

getModelShadows

public String getModelShadows()
Returns the Model shadows parameter of this tool . This parameter is String, type of shaded relief to be generated. This is an optional parameter.

Returns:
the Model shadows

setModelShadows

public void setModelShadows(String modelShadows)
Sets the Model shadows parameter of this tool . This parameter is String, type of shaded relief to be generated. This is an optional parameter.

Parameters:
modelShadows - String, type of shaded relief to be generated.

getZFactor

public double getZFactor()
Returns the Z factor parameter of this tool . This parameter is Double, 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 Double, 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 - Double, 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).

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