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

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

public class AreaSolarRadiation
extends AbstractGPTool

Derives incoming solar radiation from a raster surface. The Area Solar Radiation tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AreaSolarRadiation()
          Creates the Area Solar Radiation tool with defaults.
AreaSolarRadiation(Object inSurfaceRaster, Object outGlobalRadiationRaster)
          Creates the Area Solar Radiation tool with the required parameters.
 
Method Summary
 int getAzimuthDivisions()
          Returns the Azimuth divisions parameter of this tool .
 int getCalculationDirections()
          Returns the Calculation directions parameter of this tool .
 int getDayInterval()
          Returns the Day interval parameter of this tool .
 String getDiffuseModelType()
          Returns the Diffuse model type parameter of this tool .
 double getDiffuseProportion()
          Returns the Diffuse proportion parameter of this tool .
 String getEachInterval()
          Returns the Create outputs for each interval parameter of this tool .
 double getHourInterval()
          Returns the Hour interval parameter of this tool .
 Object getInSurfaceRaster()
          Returns the Input raster parameter of this tool .
 double getLatitude()
          Returns the Latitude parameter of this tool .
 Object getOutDiffuseRadiationRaster()
          Returns the Output diffuse radiation raster parameter of this tool .
 Object getOutDirectDurationRaster()
          Returns the Output direct duration raster parameter of this tool .
 Object getOutDirectRadiationRaster()
          Returns the Output direct radiation raster parameter of this tool .
 Object getOutGlobalRadiationRaster()
          Returns the Output global radiation raster parameter of this tool .
 int getSkySize()
          Returns the Sky size / Resolution parameter of this tool .
 String getSlopeAspectInputType()
          Returns the Slope and aspect input type parameter of this tool .
 Object getTimeConfiguration()
          Returns the Time configuration 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 getTransmittivity()
          Returns the Transmittivity parameter of this tool .
 int getZenithDivisions()
          Returns the Zenith divisions parameter of this tool .
 double getZFactor()
          Returns the Z factor parameter of this tool .
 void setAzimuthDivisions(int azimuthDivisions)
          Sets the Azimuth divisions parameter of this tool .
 void setCalculationDirections(int calculationDirections)
          Sets the Calculation directions parameter of this tool .
 void setDayInterval(int dayInterval)
          Sets the Day interval parameter of this tool .
 void setDiffuseModelType(String diffuseModelType)
          Sets the Diffuse model type parameter of this tool .
 void setDiffuseProportion(double diffuseProportion)
          Sets the Diffuse proportion parameter of this tool .
 void setEachInterval(String eachInterval)
          Sets the Create outputs for each interval parameter of this tool .
 void setHourInterval(double hourInterval)
          Sets the Hour interval parameter of this tool .
 void setInSurfaceRaster(Object inSurfaceRaster)
          Sets the Input raster parameter of this tool .
 void setLatitude(double latitude)
          Sets the Latitude parameter of this tool .
 void setOutDiffuseRadiationRaster(Object outDiffuseRadiationRaster)
          Sets the Output diffuse radiation raster parameter of this tool .
 void setOutDirectDurationRaster(Object outDirectDurationRaster)
          Sets the Output direct duration raster parameter of this tool .
 void setOutDirectRadiationRaster(Object outDirectRadiationRaster)
          Sets the Output direct radiation raster parameter of this tool .
 void setOutGlobalRadiationRaster(Object outGlobalRadiationRaster)
          Sets the Output global radiation raster parameter of this tool .
 void setSkySize(int skySize)
          Sets the Sky size / Resolution parameter of this tool .
 void setSlopeAspectInputType(String slopeAspectInputType)
          Sets the Slope and aspect input type parameter of this tool .
 void setTimeConfiguration(Object timeConfiguration)
          Sets the Time configuration parameter of this tool .
 void setTransmittivity(double transmittivity)
          Sets the Transmittivity parameter of this tool .
 void setZenithDivisions(int zenithDivisions)
          Sets the Zenith divisions 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

AreaSolarRadiation

public AreaSolarRadiation()
Creates the Area Solar Radiation tool with defaults.

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


AreaSolarRadiation

public AreaSolarRadiation(Object inSurfaceRaster,
                          Object outGlobalRadiationRaster)
Creates the Area Solar Radiation 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:
inSurfaceRaster - Composite Geodataset, input DEM surface raster.
outGlobalRadiationRaster - Raster Dataset, the output has unit watt hours per square meter (WH/m2).
Method Detail

getInSurfaceRaster

public Object getInSurfaceRaster()
Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input DEM surface raster. This is a required parameter.

Returns:
the Input raster

setInSurfaceRaster

public void setInSurfaceRaster(Object inSurfaceRaster)
Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, input DEM surface raster. This is a required parameter.

Parameters:
inSurfaceRaster - Composite Geodataset, input DEM surface raster.

getOutGlobalRadiationRaster

public Object getOutGlobalRadiationRaster()
Returns the Output global radiation raster parameter of this tool . This parameter is Raster Dataset, the output has unit watt hours per square meter (WH/m2). This is a required parameter.

Returns:
the Output global radiation raster

setOutGlobalRadiationRaster

public void setOutGlobalRadiationRaster(Object outGlobalRadiationRaster)
Sets the Output global radiation raster parameter of this tool . This parameter is Raster Dataset, the output has unit watt hours per square meter (WH/m2). This is a required parameter.

Parameters:
outGlobalRadiationRaster - Raster Dataset, the output has unit watt hours per square meter (WH/m2).

getLatitude

public double getLatitude()
Returns the Latitude parameter of this tool . This parameter is Double, for input surface rasters containing a spatial reference, the mean latitude is automatically calculated; otherwise, latitude will default to 45 degrees. This is an optional parameter.

Returns:
the Latitude

setLatitude

public void setLatitude(double latitude)
Sets the Latitude parameter of this tool . This parameter is Double, for input surface rasters containing a spatial reference, the mean latitude is automatically calculated; otherwise, latitude will default to 45 degrees. This is an optional parameter.

Parameters:
latitude - Double, for input surface rasters containing a spatial reference, the mean latitude is automatically calculated; otherwise, latitude will default to 45 degrees.

getSkySize

public int getSkySize()
Returns the Sky size / Resolution parameter of this tool . This parameter is Long, the resolution or skysize for the viewshed, skymap, and sunmap grids (units: cells). The default creates a raster of 200 x 200 cells. This is an optional parameter.

Returns:
the Sky size / Resolution

setSkySize

public void setSkySize(int skySize)
Sets the Sky size / Resolution parameter of this tool . This parameter is Long, the resolution or skysize for the viewshed, skymap, and sunmap grids (units: cells). The default creates a raster of 200 x 200 cells. This is an optional parameter.

Parameters:
skySize - Long, the resolution or skysize for the viewshed, skymap, and sunmap grids (units: cells). The default creates a raster of 200 x 200 cells.

getTimeConfiguration

public Object getTimeConfiguration()
Returns the Time configuration parameter of this tool . This parameter is Time configuration, when the start time and the end time are the same, instantaneous insolation will be calculated. When the start time is before sunrise and the end time is after sunset, insolation will be calculated for the whole day. This is an optional parameter.

Returns:
the Time configuration

setTimeConfiguration

public void setTimeConfiguration(Object timeConfiguration)
Sets the Time configuration parameter of this tool . This parameter is Time configuration, when the start time and the end time are the same, instantaneous insolation will be calculated. When the start time is before sunrise and the end time is after sunset, insolation will be calculated for the whole day. This is an optional parameter.

Parameters:
timeConfiguration - Time configuration, when the start time and the end time are the same, instantaneous insolation will be calculated. When the start time is before sunrise and the end time is after sunset, insolation will be calculated for the whole day.

getDayInterval

public int getDayInterval()
Returns the Day interval parameter of this tool . This parameter is Long, the default value is 14 (biweekly). This is an optional parameter.

Returns:
the Day interval

setDayInterval

public void setDayInterval(int dayInterval)
Sets the Day interval parameter of this tool . This parameter is Long, the default value is 14 (biweekly). This is an optional parameter.

Parameters:
dayInterval - Long, the default value is 14 (biweekly).

getHourInterval

public double getHourInterval()
Returns the Hour interval parameter of this tool . This parameter is Double, the default value is 0.5. This is an optional parameter.

Returns:
the Hour interval

setHourInterval

public void setHourInterval(double hourInterval)
Sets the Hour interval parameter of this tool . This parameter is Double, the default value is 0.5. This is an optional parameter.

Parameters:
hourInterval - Double, the default value is 0.5.

getEachInterval

public String getEachInterval()
Returns the Create outputs for each interval parameter of this tool . This parameter is String, specifies whether to calculate a single total insolation output raster or multiple output rasters for the specified hour and day interval. The default is NOINTERVAL. For example, when INTERVAL is specified for a whole year with monthly intervals, the result will contain 12 output radiation rasters. Otherwise, only a single total radiation raster will be calculated. This is an optional parameter.

Returns:
the Create outputs for each interval

setEachInterval

public void setEachInterval(String eachInterval)
Sets the Create outputs for each interval parameter of this tool . This parameter is String, specifies whether to calculate a single total insolation output raster or multiple output rasters for the specified hour and day interval. The default is NOINTERVAL. For example, when INTERVAL is specified for a whole year with monthly intervals, the result will contain 12 output radiation rasters. Otherwise, only a single total radiation raster will be calculated. This is an optional parameter.

Parameters:
eachInterval - String, specifies whether to calculate a single total insolation output raster or multiple output rasters for the specified hour and day interval. The default is NOINTERVAL. For example, when INTERVAL is specified for a whole year with monthly intervals, the result will contain 12 output radiation rasters. Otherwise, only a single total radiation raster will be calculated.

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).

getSlopeAspectInputType

public String getSlopeAspectInputType()
Returns the Slope and aspect input type parameter of this tool . This parameter is String, how slope and aspect information are derived for analysis. This is an optional parameter.

Returns:
the Slope and aspect input type

setSlopeAspectInputType

public void setSlopeAspectInputType(String slopeAspectInputType)
Sets the Slope and aspect input type parameter of this tool . This parameter is String, how slope and aspect information are derived for analysis. This is an optional parameter.

Parameters:
slopeAspectInputType - String, how slope and aspect information are derived for analysis.

getCalculationDirections

public int getCalculationDirections()
Returns the Calculation directions parameter of this tool . This parameter is Long, valid values must be multiples of 8 (8, 16, 24, 32, and so on). The default value is 32 directions, which is adequate for complex topography. This is an optional parameter.

Returns:
the Calculation directions

setCalculationDirections

public void setCalculationDirections(int calculationDirections)
Sets the Calculation directions parameter of this tool . This parameter is Long, valid values must be multiples of 8 (8, 16, 24, 32, and so on). The default value is 32 directions, which is adequate for complex topography. This is an optional parameter.

Parameters:
calculationDirections - Long, valid values must be multiples of 8 (8, 16, 24, 32, and so on). The default value is 32 directions, which is adequate for complex topography.

getZenithDivisions

public int getZenithDivisions()
Returns the Zenith divisions parameter of this tool . This parameter is Long, the default is eight divisions (relative to zenith). Values must be greater than zero and less than half of the skysize value. This is an optional parameter.

Returns:
the Zenith divisions

setZenithDivisions

public void setZenithDivisions(int zenithDivisions)
Sets the Zenith divisions parameter of this tool . This parameter is Long, the default is eight divisions (relative to zenith). Values must be greater than zero and less than half of the skysize value. This is an optional parameter.

Parameters:
zenithDivisions - Long, the default is eight divisions (relative to zenith). Values must be greater than zero and less than half of the skysize value.

getAzimuthDivisions

public int getAzimuthDivisions()
Returns the Azimuth divisions parameter of this tool . This parameter is Long, the default is eight divisions (relative to north). Valid values must be multiples of 8. Values must be greater than zero and less than 160. This is an optional parameter.

Returns:
the Azimuth divisions

setAzimuthDivisions

public void setAzimuthDivisions(int azimuthDivisions)
Sets the Azimuth divisions parameter of this tool . This parameter is Long, the default is eight divisions (relative to north). Valid values must be multiples of 8. Values must be greater than zero and less than 160. This is an optional parameter.

Parameters:
azimuthDivisions - Long, the default is eight divisions (relative to north). Valid values must be multiples of 8. Values must be greater than zero and less than 160.

getDiffuseModelType

public String getDiffuseModelType()
Returns the Diffuse model type parameter of this tool . This parameter is String, type of diffuse radiation model. This is an optional parameter.

Returns:
the Diffuse model type

setDiffuseModelType

public void setDiffuseModelType(String diffuseModelType)
Sets the Diffuse model type parameter of this tool . This parameter is String, type of diffuse radiation model. This is an optional parameter.

Parameters:
diffuseModelType - String, type of diffuse radiation model.

getDiffuseProportion

public double getDiffuseProportion()
Returns the Diffuse proportion parameter of this tool . This parameter is Double, this value should be set according to atmospheric conditions. The default value is 0.3 for generally clear sky conditions. This is an optional parameter.

Returns:
the Diffuse proportion

setDiffuseProportion

public void setDiffuseProportion(double diffuseProportion)
Sets the Diffuse proportion parameter of this tool . This parameter is Double, this value should be set according to atmospheric conditions. The default value is 0.3 for generally clear sky conditions. This is an optional parameter.

Parameters:
diffuseProportion - Double, this value should be set according to atmospheric conditions. The default value is 0.3 for generally clear sky conditions.

getTransmittivity

public double getTransmittivity()
Returns the Transmittivity parameter of this tool . This parameter is Double, the default is 0.5 for a generally clear sky. This is an optional parameter.

Returns:
the Transmittivity

setTransmittivity

public void setTransmittivity(double transmittivity)
Sets the Transmittivity parameter of this tool . This parameter is Double, the default is 0.5 for a generally clear sky. This is an optional parameter.

Parameters:
transmittivity - Double, the default is 0.5 for a generally clear sky.

getOutDirectRadiationRaster

public Object getOutDirectRadiationRaster()
Returns the Output direct radiation raster parameter of this tool . This parameter is Raster Dataset, the output has units of watt hours per square meter (WH/m2). This is an optional parameter.

Returns:
the Output direct radiation raster

setOutDirectRadiationRaster

public void setOutDirectRadiationRaster(Object outDirectRadiationRaster)
Sets the Output direct radiation raster parameter of this tool . This parameter is Raster Dataset, the output has units of watt hours per square meter (WH/m2). This is an optional parameter.

Parameters:
outDirectRadiationRaster - Raster Dataset, the output has units of watt hours per square meter (WH/m2).

getOutDiffuseRadiationRaster

public Object getOutDiffuseRadiationRaster()
Returns the Output diffuse radiation raster parameter of this tool . This parameter is Raster Dataset, the output has units of watt hours per square meter (WH/m2). This is an optional parameter.

Returns:
the Output diffuse radiation raster

setOutDiffuseRadiationRaster

public void setOutDiffuseRadiationRaster(Object outDiffuseRadiationRaster)
Sets the Output diffuse radiation raster parameter of this tool . This parameter is Raster Dataset, the output has units of watt hours per square meter (WH/m2). This is an optional parameter.

Parameters:
outDiffuseRadiationRaster - Raster Dataset, the output has units of watt hours per square meter (WH/m2).

getOutDirectDurationRaster

public Object getOutDirectDurationRaster()
Returns the Output direct duration raster parameter of this tool . This parameter is Raster Dataset, the output has units of hours. This is an optional parameter.

Returns:
the Output direct duration raster

setOutDirectDurationRaster

public void setOutDirectDurationRaster(Object outDirectDurationRaster)
Sets the Output direct duration raster parameter of this tool . This parameter is Raster Dataset, the output has units of hours. This is an optional parameter.

Parameters:
outDirectDurationRaster - Raster Dataset, the output has units of hours.

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