Back to Top

Feature Solar Radiation (Spatial Analyst)

In this topic

  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information

Available with Spatial Analyst license.

Summary

Calculates the incoming solar insolation for input points or polygon features relative to the surface (ground) on the Earth or the Moon.

The input features can represent locations or engineered surfaces by specifying attributes to define size, height, and orientation for analysis relative to the ground. Solar insolation is calculated as the amount of solar radiation energy received during an amount of time for each feature. Values are represented as totals and averages for the area of the feature and have units, kilowatt hours (kWh) and kilowatt hours per square meter (kWh/m2), respectively.

Usage

  • The defined spatial reference of the Input surface raster parameter specifies whether the analysis will be for the Earth or the Moon.

  • The solar radiation computation requires the Output Coordinate System environment value to be in a projected coordinate system (PCS). It is recommended that the data be in a PCS with units of meters. If you run the analysis with a spherical coordinate system, you must set the Output Coordinate System environment to a valid PCS.

  • The input features must be point or polygon feature data. Analysis on 3D or multipatch are not supported.

    You can include additional details to represent engineered surfaces using the input feature parameters by specifying direction, tilt, area, and offset for all or individual features, for example, to represent a set of points as solar panel arrays on the ground or building rooftop.

  • It is recommended that you specify the output table format as geodatabase. This allows for increased performance and greater functionality. Tables in dBase file format (.dbf) have known limitations in precision, field name lengths, and date and time formatting.

  • The calculated solar insolation values for total, direct, diffuse, and direct duration are added as attributes to the output table. These include values for total insolation (across the entire area) and average insolation (per unit area) of each feature. The units are kilowatt hours (kWh) and kilowatt hours per meter squared (kwh/m2), respectively. Duration units are hours.

  • The total insolation is calculated by analyzing each cell location of the input surface raster that intersects the feature (or part thereof) and multiplying it by that feature's area. It is not calculated for a single central location of the feature.

  • If you are running an analysis for large extents with few or highly dispersed polygon features, the process may take additional time due to the resolution required for rasterization.

  • The Feature Slope, Feature Aspect, Feature Area, and Feature Offset parameters can be used to provide additional details to represent engineered surfaces that may intercept the incoming solar radiation, such as direction, tilt, area, and offset. These may be static or changing position and orientation in time. For example, a set of points that represent solar panel arrays on the ground or building rooftop, or a panel on a moving vehicle.

    If the feature parameters are not specified, the values are calculated from the input surface raster or the individual features by default. Points have an area of zero unless otherwise specified.

    If you provide a value for any of these parameters, it will be applied to all input features. Alternatively, you can provide an input field attribute from the input features to analyze each feature individually. If a field is specified and a value is missing (Null), the value will be set as zero.

  • Daylight saving time is supported for the Earth only. For the Moon, times must be specified in UTC.

  • The End date and time parameter value must be equal to or greater than the start date. The total span of time must not be greater than one year. The start and end date times can cross the calendar year.

  • Output radiation values will be calculated for each respective time interval. If no solar radiation was received for a time interval, the result for that location will have a value of zero.

    If the total time specified between the start and end times is not equally divisible by the time interval, the total duration will be extended internally to provide the required number of time slices. For example, if the Time Interval parameter is set to cover three days but the difference between the specified start and end times covers eight days, the time interval will be extended to nine days. No partial results for times will be returned.

  • The minimum time interval for Earth data is 30 minutes and must be proportional to 30. The minimum time interval for Moon data is four hours and must be proportional to 2.

  • The Neighborhood Distance (neighborhood_distance in Python) parameter determines the neighborhood size and calculates the surface parameter over this distance from the target cell center. The value cannot be less than the input raster cell size.

    A small neighborhood distance captures more local variability in the landscape, such as characteristics of smaller landscape features. With high-resolution elevation data, larger distances may be more appropriate.

  • If the Use adaptive neighborhood parameter is checked (use_adaptive_neighborhood = "ADAPTIVE_NEIGHBORHOOD" in Python), the neighborhood distance will change with variability in the terrain. The neighborhood distance will shrink if there is too much variability in the calculation window.

  • The Earth's Moon does not have an atmosphere; therefore, the radiation parameters diffuse proportion and transmittivity are not relevant during analysis. As a result, the incoming diffuse solar radiation is zero and the total radiation is equal to direct solar radiation.

  • The diffuse proportion is the fraction of global normal radiation flux that is diffuse. Values range from 0 to 1. Set this value according to atmospheric conditions. Typical values are 0.2 for very clear sky conditions and 0.3 for generally clear sky conditions.

  • Transmittivity is the ratio of the energy reaching Earth's surface to that which is received at the upper limit of the atmosphere. Values range from 0 (no transmission) to 1 (complete transmission). Typically observed values are 0.6 or 0.7 for very clear sky conditions and 0.5 for a generally clear sky.

  • Transmittivity has an inverse relationship with the diffuse proportion parameter. Altering these values may affect the model result. Identifying the best values for the area of interest depends on several variables (such as location and time). You can change these values to compare how they affect the result.

  • This tool can be GPU accelerated, which means that if a compatible graphics processing unit (GPU) is available on your system, it will be used to enhance the performance of the tool. Use the Target device for analysis (analysis_target_device in Python) parameter to control whether the GPU or CPU will be used to run the tool.

    See GPU processing with Spatial Analyst for more details on compatible GPUs, configuring and working with GPU devices, as well as troubleshooting tips.

  • See Analysis environments and Spatial Analyst for additional details on the geoprocessing environments that apply to this tool.

  • Additional resources:

    Acton, C. A. "Ancillary data services of NASA's Navigation and Ancillary Information Facility". Planetary and Space Science. Vol. 44, Issue 1, January 1996, 65-70. https://doi.org/10.1016/0032-0633(95)00107-7

    Acton, C, Bachman, Semenov, B., and Wright, E. "A look toward the future in the handling of space science mission geometry". Planetary and Space Science. Volume 150, January 2018, 9-12. https://doi.org/10.1016/j.pss.2017.02.013

Parameters

DialogPython

LabelExplanationData Type
Input Surface Raster

The input elevation surface raster.

Raster Layer
Input Point or Polygon Features

The input features (point or polygon) that represent a location or engineered surface to calculate the amount of solar radiation received.

Feature Layer
Unique ID Field

The field that contains the values that define each feature.

It can be an integer or a string field of the input features.

Field
Output table

The output table that will contain the summary of the amount of solar radiation received by the input features

The format of the table is determined by the output location and path. By default, the output will be a geodatabase table if in a geodatabase workspace, or a dBASE table if in a file workspace.

Table
Start Date and Time

The start date and time for the analysis.

Date
End Date and Time

The end date and time for the analysis.

Date
Time Zone
(Optional)

The time zone that will be used for the start and end time. The default is UTC, or Coordinated Universal Time.

  • UTC—The time zone will be UTC.
  • Dateline Standard Time—The time zone will be Dateline Standard Time (UTC-12:00).
  • UTC-11—The time zone will be UTC-11 (UTC-11:00).
  • Aleutian Standard Time—The time zone will be Aleutian Standard Time (UTC-10:00).
  • Hawaiian Standard Time—The time zone will be Hawaiian Standard Time (UTC-10:00).
  • Marquesas Standard Time—The time zone will be Marquesas Standard Time (UTC-09:30).
  • Alaskan Standard Time—The time zone will be Alaskan Standard Time (UTC-09:00).
  • UTC-09—The time zone will be UTC-09 (UTC-09:00).
  • Pacific Standard Time (Mexico)—The time zone will be Pacific Standard Time (Mexico) (UTC-08:00).
  • UTC-08—The time zone will be UTC-08 (UTC-08:00).
  • Pacific Standard Time—The time zone will be Pacific Standard Time (UTC-08:00).
  • US Mountain Standard Time—The time zone will be US Mountain Standard Time (UTC-07:00).
  • Mountain Standard Time (Mexico)—The time zone will be Mountain Standard Time (Mexico) (UTC-07:00).
  • Mountain Standard Time—The time zone will be Mountain Standard Time (UTC-07:00).
  • Yukon Standard Time—The time zone will be Yukon Standard Time (UTC-07:00).
  • Central America Standard Time—The time zone will be Central America Standard Time (UTC-06:00).
  • Central Standard Time—The time zone will be Central Standard Time (UTC-06:00).
  • Easter Island Standard Time—The time zone will be Easter Island Standard Time (UTC-06:00).
  • Central Standard Time (Mexico)—The time zone will be Central Standard Time (Mexico) (UTC-06:00).
  • Canada Central Standard Time—The time zone will be Canada Central Standard Time (UTC-06:00).
  • SA Pacific Standard Time—The time zone will be SA Pacific Standard Time (UTC-05:00).
  • Eastern Standard Time (Mexico)—The time zone will be Eastern Standard Time (Mexico) (UTC-05:00).
  • Eastern Standard Time—The time zone will be Eastern Standard Time (UTC-05:00).
  • Haiti Standard Time—The time zone will be Haiti Standard Time (UTC-05:00).
  • Cuba Standard Time—The time zone will be Cuba Standard Time (UTC-05:00).
  • US Eastern Standard Time—The time zone will be US Eastern Standard Time (UTC-05:00).
  • Turks And Caicos Standard Time—The time zone will be Turks And Caicos Standard Time (UTC-04:00).
  • Paraguay Standard Time—The time zone will be Paraguay Standard Time (UTC-04:00).
  • Atlantic Standard Time—The time zone will be Atlantic Standard Time (UTC-04:00).
  • Venezuela Standard Time—The time zone will be Venezuela Standard Time (UTC-04:00).
  • Central Brazilian Standard Time—The time zone will be Central Brazilian Standard Time (UTC-04:00).
  • SA Western Standard Time—The time zone will be SA Western Standard Time (UTC-04:00).
  • Pacific SA Standard Time—The time zone will be Pacific SA Standard Time (UTC-04:00).
  • Newfoundland Standard Time—The time zone will be Newfoundland Standard Time (UTC-03:30).
  • Tocantins Standard Time—The time zone will be Tocantins Standard Time (UTC-03:00).
  • E. South America Standard Time—The time zone will be E. South America Standard Time (UTC-03:00).
  • SA Eastern Standard Time—The time zone will be SA Eastern Standard Time (UTC-03:00).
  • Argentina Standard Time—The time zone will be Argentina Standard Time (UTC-03:00).
  • Greenland Standard Time—The time zone will be Greenland Standard Time (UTC-03:00).
  • Montevideo Standard Time—The time zone will be Montevideo Standard Time (UTC-03:00).
  • Magallanes Standard Time—The time zone will be Magallanes Standard Time (UTC-03:00).
  • Saint Pierre Standard Time—The time zone will be Saint Pierre Standard Time (UTC-03:00).
  • Bahia Standard Time—The time zone will be Bahia Standard Time (UTC-03:00).
  • UTC-02—The time zone will be UTC-02 (UTC-02:00).
  • Mid-Atlantic Standard Time—The time zone will be Mid-Atlantic Standard Time (UTC-02:00).
  • Azores Standard Time—The time zone will be Azores Standard Time (UTC-01:00).
  • Cape Verde Standard Time—The time zone will be Cape Verde Standard Time (UTC-01:00).
  • GMT Standard Time—The time zone will be GMT Standard Time (UTC+00:00).
  • Greenwich Standard Time—The time zone will be Greenwich Standard Time (UTC+00:00).
  • Sao Tome Standard Time—The time zone will be Sao Tome Standard Time (UTC+00:00).
  • Morocco Standard Time—The time zone will be Morocco Standard Time (UTC+00:00).
  • W. Europe Standard Time—The time zone will be W. Europe Standard Time (UTC+01:00).
  • Central Europe Standard Time—The time zone will be Central Europe Standard Time (UTC+01:00).
  • Romance Standard Time—The time zone will be Romance Standard Time (UTC+01:00).
  • Central European Standard Time—The time zone will be Central European Standard Time (UTC+01:00).
  • W. Central Africa Standard Time—The time zone will be W. Central Africa Standard Time (UTC+01:00).
  • Jordan Standard Time—The time zone will be Jordan Standard Time (UTC+02:00).
  • GTB Standard Time—The time zone will be GTB Standard Time (UTC+02:00).
  • Middle East Standard Time—The time zone will be Middle East Standard Time (UTC+02:00).
  • Egypt Standard Time—The time zone will be Egypt Standard Time (UTC+02:00).
  • E. Europe Standard Time—The time zone will be E. Europe Standard Time (UTC+02:00).
  • Syria Standard Time—The time zone will be Syria Standard Time (UTC+02:00).
  • West Bank Standard Time—The time zone will be West Bank Standard Time (UTC+02:00).
  • South Africa Standard Time—The time zone will be South Africa Standard Time (UTC+02:00).
  • FLE Standard Time—The time zone will be FLE Standard Time (UTC+02:00).
  • Israel Standard Time—The time zone will be Israel Standard (UTC+02:00).
  • South Sudan Standard Time—The time zone will be South Sudan Standard Time (UTC+02:00).
  • Kaliningrad Standard Time—The time zone will be Kaliningrad Standard Time (UTC+02:00).
  • Sudan Standard Time—The time zone will be Sudan Standard Time (UTC+02:00).
  • Libya Standard Time—The time zone will be Libya Standard Time (UTC+02:00).
  • Namibia Standard Time—The time zone will be Namibia Standard Time (UTC+02:00).
  • Arabic Standard Time—The time zone will be Arabic Standard Time (UTC+03:00).
  • Turkey Standard Time—The time zone will be Turkey Standard Time (UTC+03:00).
  • Arab Standard Time—The time zone will be Arab Standard Time (UTC+03:00).
  • Belarus Standard Time—The time zone will be Belarus Standard Time (UTC+03:00).
  • Russian Standard Time—The time zone will be Russian Standard Time (UTC+03:00).
  • E. Africa Standard Time—The time zone will be E. Africa Standard Time (UTC+03:00).
  • Volgograd Standard Time—The time zone will be Volgograd Standard Time (UTC+03:00).
  • Iran Standard Time—The time zone will be Iran Standard Time (UTC+03:30).
  • Arabian Standard Time—The time zone will be Arabian Standard Time (UTC+04:00).
  • Astrakhan Standard Time—The time zone will be Astrakhan Standard Time (UTC+04:00).
  • Azerbaijan Standard Time—The time zone will be Azerbaijan Standard Time (UTC+04:00).
  • Russia Time Zone 3—The time zone will be Russia Time Zone 3 (UTC+04:00).
  • Mauritius Standard Time—The time zone will be Mauritius Standard Time (UTC+04:00).
  • Saratov Standard Time—The time zone will be Saratov Standard Time (UTC+04:00).
  • Georgian Standard Time—The time zone will be Georgian Standard Time (UTC+04:00).
  • Caucasus Standard Time—The time zone will be Caucasus Standard Time (UTC+04:00).
  • Afghanistan Standard Time—The time zone will be Afghanistan Standard Time (UTC+04:30).
  • West Asia Standard Time—The time zone will be West Asia Standard Time (UTC+05:00).
  • Ekaterinburg Standard Time—The time zone will be Ekaterinburg Standard Time (UTC+05:00).
  • Pakistan Standard Time—The time zone will be Pakistan Standard Time (UTC+05:00).
  • Qyzylorda Standard Time—The time zone will be Qyzylorda Standard Time (UTC+05:00).
  • India Standard Time—The time zone will be India Standard Time (UTC+05:30).
  • Sri Lanka Standard Time—The time zone will be Sri Lanka Standard Time (UTC+05:30).
  • Nepal Standard Time—The time zone will be Nepal Standard Time (UTC+05:45).
  • Central Asia Standard Time—The time zone will be Central Asia Standard Time (UTC+06:00).
  • Bangladesh Standard Time—The time zone will be Bangladesh Standard Time (UTC+06:00).
  • Omsk Standard Time—The time zone will be Omsk Standard Time (UTC+06:00).
  • Myanmar Standard Time—The time zone will be Myanmar Standard Time (UTC+06:30).
  • SE Asia Standard Time—The time zone will be SE Asia Standard Time (UTC+07:00).
  • Altai Standard Time—The time zone will be Altai Standard Time (UTC+07:00).
  • W. Mongolia Standard Time—The time zone will be W. Mongolia Standard Time (UTC+07:00).
  • North Asia Standard Time—The time zone will be North Asia Standard Time (UTC+07:00).
  • N. Central Asia Standard Time—The time zone will be N. Central Asia Standard Time (UTC+07:00).
  • Tomsk Standard Time—The time zone will be Tomsk Standard Time (UTC+07:00).
  • China Standard Time—The time zone will be China Standard Time (UTC+08:00).
  • North Asia East Standard Time—The time zone will be North Asia East Standard Time (UTC+08:00).
  • Singapore Standard Time—The time zone will be Singapore Standard Time (UTC+08:00).
  • W. Australia Standard Time—The time zone will be W. Australia Standard Time (UTC+08:00).
  • Taipei Standard Time—The time zone will be Taipei Standard Time (UTC+08:00).
  • Ulaanbaatar Standard Time—The time zone will be Ulaanbaatar Standard Time (UTC+08:00).
  • Aus Central W. Standard Time—The time zone will be Aus Central W. Standard Time (UTC+08:45).
  • Transbaikal Standard Time—The time zone will be Transbaikal Standard Time (UTC+09:00).
  • Tokyo Standard Time—The time zone will be Tokyo Standard Time (UTC+09:00).
  • North Korea Standard Time—The time zone will be North Korea Standard Time (UTC+09:00).
  • Korea Standard Time—The time zone will be Korea Standard Time (UTC+09:00).
  • Yakutsk Standard Time—The time zone will be Yakutsk Standard Time (UTC+09:00).
  • Cen. Australia Standard Time—The time zone will be Cen. Australia Standard Time (UTC+09:30).
  • AUS Central Standard Time—The time zone will be AUS Central Standard Time (UTC+09:30).
  • E. Australia Standard Time—The time zone will be E. Australia Standard Time (UTC+10:00).
  • AUS Eastern Standard Time—The time zone will be AUS Eastern Standard Time (UTC+10:00).
  • West Pacific Standard Time—The time zone will be West Pacific Standard Time (UTC+10:00).
  • Tasmania Standard Time—The time zone will be Tasmania Standard Time (UTC+10:00).
  • Vladivostok Standard Time—The time zone will be Vladivostok Standard Time (UTC+10:00).
  • Lord Howe Standard Time—The time zone will be Lord Howe Standard Time (UTC+10:30).
  • Bougainville Standard Time—The time zone will be Bougainville Standard Time (UTC+11:00).
  • Russia Time Zone 10—The time zone will be Russia Time Zone 10 (UTC+11:00).
  • Magadan Standard Time—The time zone will be Magadan Standard Time (UTC+11:00).
  • Norfolk Standard Time—The time zone will be Norfolk Standard Time (UTC+11:00).
  • Sakhalin Standard Time—The time zone will be Sakhalin Standard Time (UTC+11:00).
  • Central Pacific Standard Time—The time zone will be Central Pacific Standard Time (UTC+11:00).
  • Russia Time Zone 11—The time zone will be Russia Time Zone 11 (UTC+11:00).
  • New Zealand Standard Time—The time zone will be New Zealand Standard Time (UTC+12:00).
  • UTC+12—The time zone will be UTC+12 (UTC+12:00).
  • Fiji Standard Time—The time zone will be Fiji Standard Time (UTC+12:00).
  • Kamchatka Standard Time—The time zone will be Kamchatka Standard Time (UTC+12:00).
  • Chatham Islands Standard Time—The time zone will be Chatham Islands Standard Time (UTC+12:45).
  • UTC+13—The time zone will be UTC+13 (UTC+13:00).
  • Tonga Standard Time—The time zone will be Tonga Standard Time (UTC+13:00).
  • Samoa Standard Time—The time zone will be Samoa Standard Time (UTC+13:00).
  • Line Islands Standard Time—The time zone will be Line Islands Standard Time (UTC+14:00).
String
Adjust times for daylight saving time
(Optional)

Specifies whether the input time configuration will be adjusted for daylight saving time.

This parameter is not applicable for analysis on the Moon.

  • Unchecked—The input time values will not be adjusted for daylight saving time. This is the default.
  • Checked—The input time values will be adjusted for daylight saving time.
Boolean
Calculate insolation for time intervals
(Optional)

Specifies whether a single total insolation value will be calculated for the entire time configuration or multiple radiation values will be calculated for the specified interval.

  • Unchecked—A single total radiation value will be calculated for the entire time configuration. This is the default.
  • Checked—Multiple radiation values will be calculated for each time interval over the entire time configuration. The number of outputs depends on the interval value. For example, for a whole year with monthly intervals, the result will contain 12 output radiation values for each location.
Boolean
Time Interval Unit
(Optional)

Specifies the time unit that will be used for calculating solar radiation values over the entire time configuration.

This parameter is only available when the Calculate insolation for time intervals parameter is checked.

  • Minute—The interval unit will be minutes. This option is only available for Earth-based data.
  • Hour—The interval unit will be hours.
  • Day—The interval unit will be days. This is the default
  • Week—The interval unit will be weeks.
String
Time Interval
(Optional)

The value of the duration or time between intervals.

The default value is dependent on the interval unit specified. The default value for each of the available units are listed below.

  • Minute—60
  • Hour—4
  • Day—14
  • Week—2
Long
Feature Offset
(Optional)

A vertical distance that will be added to the raster surface for analysis. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the height of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

The default value is 0.

Double; Field
Feature Area
(Optional)

The area associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the area of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

By default, the area is obtained from the input features. For point features, the default area is 0.

Double; Field
Feature Slope
(Optional)

The relative slope or incline associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the incline of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

Slope is expressed in degrees from 0 to 90. The default values for analysis are calculated from the underlying values of the input surface raster.

Double; Field
Feature Aspect
(Optional)

The relative aspect or direction associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the direction of the panel face.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

Aspect is expressed in degrees from 0 to 360. The default values for analysis area calculated from the underlying values of the input surface raster.

Double; Field
Neighborhood Distance
(Optional)

The distance from the target cell center for which the output insolation value will be calculated. It determines the size of the neighborhood.

The default value is the input surface raster cell size, resulting in a 3 by 3 neighborhood.

Linear Unit
Use Adaptive Neighborhood
(Optional)

Specifies whether neighborhood distance will vary with landscape changes (adaptive). The maximum distance is determined by the neighborhood distance. The minimum distance is the input raster cell size.

  • Unchecked—A single (fixed) neighborhood distance will be used at all locations. This is the default.
  • Checked—An adaptive neighborhood distance will be used at all locations.
Boolean
Diffuse Model Type
(Optional)

Specifies the type of diffuse radiation model that will be used.

  • Uniform sky—The uniform diffuse model will be used. The incoming diffuse radiation is the same from all sky directions. This is the default.
  • Standard overcast sky—The standard overcast diffuse model will be used. The incoming diffuse radiation flux varies with the zenith angle.
String
Diffuse Proportion
(Optional)

The proportion of global normal radiation flux that is diffuse. Values range from 0 to 1.

Set this value according to atmospheric conditions. The default value is 0.3 for generally clear sky conditions.

Double
Transmittivity
(Optional)

The fraction of radiation that passes through the atmosphere (averaged overall wavelengths). Values range from 0 (no transmission) to 1 (all transmission).

The default is 0.5 for a generally clear sky.

Double
Target Device for Analysis
(Optional)

Specifies the device that will be used to perform the calculation.

  • GPU then CPU—If a compatible GPU is found, it will be used to perform the calculation. Otherwise, the CPU will be used. This is the default.
  • CPU only—The calculation will only be performed on the CPU.
  • GPU only—The calculation will only be performed on the GPU.
String
Output Join Layer
(Optional)

The output layer that will be created by joining the output table to the input feature class. This is an optional output.

Feature Layer

FeatureSolarRadiation(in_surface_raster, in_features, unique_id_field, out_table, start_date_time, end_date_time, {time_zone}, {adjust_DST}, {use_time_interval}, {interval_unit}, {interval}, {feature_offset}, {feature_area}, {feature_slope}, {feature_aspect}, {neighborhood_distance}, {use_adaptive_neighborhood}, {diffuse_model_type}, {diffuse_proportion}, {transmittivity}, {analysis_target_device}, {out_join_layer})
NameExplanationData Type
in_surface_raster

The input elevation surface raster.

Raster Layer
in_features

The input features (point or polygon) that represent a location or engineered surface to calculate the amount of solar radiation received.

Feature Layer
unique_id_field

The field that contains the values that define each feature.

It can be an integer or a string field of the input features.

Field
out_table

The output table that will contain the summary of the amount of solar radiation received by the input features

The format of the table is determined by the output location and path. By default, the output will be a geodatabase table if in a geodatabase workspace, or a dBASE table if in a file workspace.

Table
start_date_time

The start date and time for the analysis.

Date
end_date_time

The end date and time for the analysis.

Date
time_zone
(Optional)

The time zone that will be used for the start and end time. The default is UTC, or Coordinated Universal Time.

  • UTC—The time zone will be UTC.
  • Dateline_Standard_Time—The time zone will be Dateline Standard Time (UTC-12:00).
  • UTC-11—The time zone will be UTC-11 (UTC-11:00).
  • Aleutian_Standard_Time—The time zone will be Aleutian Standard Time (UTC-10:00).
  • Hawaiian_Standard_Time—The time zone will be Hawaiian Standard Time (UTC-10:00).
  • Marquesas_Standard_Time—The time zone will be Marquesas Standard Time (UTC-09:30).
  • Alaskan_Standard_Time—The time zone will be Alaskan Standard Time (UTC-09:00).
  • UTC-09—The time zone will be UTC-09 (UTC-09:00).
  • Pacific_Standard_Time_(Mexico)—The time zone will be Pacific Standard Time (Mexico) (UTC-08:00).
  • UTC-08—The time zone will be UTC-08 (UTC-08:00).
  • Pacific_Standard_Time—The time zone will be Pacific Standard Time (UTC-08:00).
  • US_Mountain_Standard_Time—The time zone will be US Mountain Standard Time (UTC-07:00).
  • Mountain_Standard_Time_(Mexico)—The time zone will be Mountain Standard Time (Mexico) (UTC-07:00).
  • Mountain_Standard_Time—The time zone will be Mountain Standard Time (UTC-07:00).
  • Yukon_Standard_Time—The time zone will be Yukon Standard Time (UTC-07:00).
  • Central_America_Standard_Time—The time zone will be Central America Standard Time (UTC-06:00).
  • Central_Standard_Time—The time zone will be Central Standard Time (UTC-06:00).
  • Easter_Island_Standard_Time—The time zone will be Easter Island Standard Time (UTC-06:00).
  • Central_Standard_Time_(Mexico)—The time zone will be Central Standard Time (Mexico) (UTC-06:00).
  • Canada_Central_Standard_Time—The time zone will be Canada Central Standard Time (UTC-06:00).
  • SA_Pacific_Standard_Time—The time zone will be SA Pacific Standard Time (UTC-05:00).
  • Eastern_Standard_Time_(Mexico)—The time zone will be Eastern Standard Time (Mexico) (UTC-05:00).
  • Eastern_Standard_Time—The time zone will be Eastern Standard Time (UTC-05:00).
  • Haiti_Standard_Time—The time zone will be Haiti Standard Time (UTC-05:00).
  • Cuba_Standard_Time—The time zone will be Cuba Standard Time (UTC-05:00).
  • US_Eastern_Standard_Time—The time zone will be US Eastern Standard Time (UTC-05:00).
  • Turks_And_Caicos_Standard_Time—The time zone will be Turks And Caicos Standard Time (UTC-04:00).
  • Paraguay_Standard_Time—The time zone will be Paraguay Standard Time (UTC-04:00).
  • Atlantic_Standard_Time—The time zone will be Atlantic Standard Time (UTC-04:00).
  • Venezuela_Standard_Time—The time zone will be Venezuela Standard Time (UTC-04:00).
  • Central_Brazilian_Standard_Time—The time zone will be Central Brazilian Standard Time (UTC-04:00).
  • SA_Western_Standard_Time—The time zone will be SA Western Standard Time (UTC-04:00).
  • Pacific_SA_Standard_Time—The time zone will be Pacific SA Standard Time (UTC-04:00).
  • Newfoundland_Standard_Time—The time zone will be Newfoundland Standard Time (UTC-03:30).
  • Tocantins_Standard_Time—The time zone will be Tocantins Standard Time (UTC-03:00).
  • E._South_America_Standard_Time—The time zone will be E. South America Standard Time (UTC-03:00).
  • SA_Eastern_Standard_Time—The time zone will be SA Eastern Standard Time (UTC-03:00).
  • Argentina_Standard_Time—The time zone will be Argentina Standard Time (UTC-03:00).
  • Greenland_Standard_Time—The time zone will be Greenland Standard Time (UTC-03:00).
  • Montevideo_Standard_Time—The time zone will be Montevideo Standard Time (UTC-03:00).
  • Magallanes_Standard_Time—The time zone will be Magallanes Standard Time (UTC-03:00).
  • Saint_Pierre_Standard_Time—The time zone will be Saint Pierre Standard Time (UTC-03:00).
  • Bahia_Standard_Time—The time zone will be Bahia Standard Time (UTC-03:00).
  • UTC-02—The time zone will be UTC-02 (UTC-02:00).
  • Mid-Atlantic_Standard_Time—The time zone will be Mid-Atlantic Standard Time (UTC-02:00).
  • Azores_Standard_Time—The time zone will be Azores Standard Time (UTC-01:00).
  • Cape_Verde_Standard_Time—The time zone will be Cape Verde Standard Time (UTC-01:00).
  • GMT_Standard_Time—The time zone will be GMT Standard Time (UTC+00:00).
  • Greenwich_Standard_Time—The time zone will be Greenwich Standard Time (UTC+00:00).
  • Sao_Tome_Standard_Time—The time zone will be Sao Tome Standard Time (UTC+00:00).
  • Morocco_Standard_Time—The time zone will be Morocco Standard Time (UTC+00:00).
  • W._Europe_Standard_Time—The time zone will be W. Europe Standard Time (UTC+01:00).
  • Central_Europe_Standard_Time—The time zone will be Central Europe Standard Time (UTC+01:00).
  • Romance_Standard_Time—The time zone will be Romance Standard Time (UTC+01:00).
  • Central_European_Standard_Time—The time zone will be Central European Standard Time (UTC+01:00).
  • W._Central_Africa_Standard_Time—The time zone will be W. Central Africa Standard Time (UTC+01:00).
  • Jordan_Standard_Time—The time zone will be Jordan Standard Time (UTC+02:00).
  • GTB_Standard_Time—The time zone will be GTB Standard Time (UTC+02:00).
  • Middle_East_Standard_Time—The time zone will be Middle East Standard Time (UTC+02:00).
  • Egypt_Standard_Time—The time zone will be Egypt Standard Time (UTC+02:00).
  • E._Europe_Standard_Time—The time zone will be E. Europe Standard Time (UTC+02:00).
  • Syria_Standard_Time—The time zone will be Syria Standard Time (UTC+02:00).
  • West_Bank_Standard_Time—The time zone will be West Bank Standard Time (UTC+02:00).
  • South_Africa_Standard_Time—The time zone will be South Africa Standard Time (UTC+02:00).
  • FLE_Standard_Time—The time zone will be FLE Standard Time (UTC+02:00).
  • Israel_Standard_Time—The time zone will be Israel Standard (UTC+02:00).
  • South_Sudan_Standard_Time—The time zone will be South Sudan Standard Time (UTC+02:00).
  • Kaliningrad_Standard_Time—The time zone will be Kaliningrad Standard Time (UTC+02:00).
  • Sudan_Standard_Time—The time zone will be Sudan Standard Time (UTC+02:00).
  • Libya_Standard_Time—The time zone will be Libya Standard Time (UTC+02:00).
  • Namibia_Standard_Time—The time zone will be Namibia Standard Time (UTC+02:00).
  • Arabic_Standard_Time—The time zone will be Arabic Standard Time (UTC+03:00).
  • Turkey_Standard_Time—The time zone will be Turkey Standard Time (UTC+03:00).
  • Arab_Standard_Time—The time zone will be Arab Standard Time (UTC+03:00).
  • Belarus_Standard_Time—The time zone will be Belarus Standard Time (UTC+03:00).
  • Russian_Standard_Time—The time zone will be Russian Standard Time (UTC+03:00).
  • E._Africa_Standard_Time—The time zone will be E. Africa Standard Time (UTC+03:00).
  • Volgograd_Standard_Time—The time zone will be Volgograd Standard Time (UTC+03:00).
  • Iran_Standard_Time—The time zone will be Iran Standard Time (UTC+03:30).
  • Arabian_Standard_Time—The time zone will be Arabian Standard Time (UTC+04:00).
  • Astrakhan_Standard_Time—The time zone will be Astrakhan Standard Time (UTC+04:00).
  • Azerbaijan_Standard_Time—The time zone will be Azerbaijan Standard Time (UTC+04:00).
  • Russia_Time_Zone_3—The time zone will be Russia Time Zone 3 (UTC+04:00).
  • Mauritius_Standard_Time—The time zone will be Mauritius Standard Time (UTC+04:00).
  • Saratov_Standard_Time—The time zone will be Saratov Standard Time (UTC+04:00).
  • Georgian_Standard_Time—The time zone will be Georgian Standard Time (UTC+04:00).
  • Caucasus_Standard_Time—The time zone will be Caucasus Standard Time (UTC+04:00).
  • Afghanistan_Standard_Time—The time zone will be Afghanistan Standard Time (UTC+04:30).
  • West_Asia_Standard_Time—The time zone will be West Asia Standard Time (UTC+05:00).
  • Ekaterinburg_Standard_Time—The time zone will be Ekaterinburg Standard Time (UTC+05:00).
  • Pakistan_Standard_Time—The time zone will be Pakistan Standard Time (UTC+05:00).
  • Qyzylorda_Standard_Time—The time zone will be Qyzylorda Standard Time (UTC+05:00).
  • India_Standard_Time—The time zone will be India Standard Time (UTC+05:30).
  • Sri_Lanka_Standard_Time—The time zone will be Sri Lanka Standard Time (UTC+05:30).
  • Nepal_Standard_Time—The time zone will be Nepal Standard Time (UTC+05:45).
  • Central_Asia_Standard_Time—The time zone will be Central Asia Standard Time (UTC+06:00).
  • Bangladesh_Standard_Time—The time zone will be Bangladesh Standard Time (UTC+06:00).
  • Omsk_Standard_Time—The time zone will be Omsk Standard Time (UTC+06:00).
  • Myanmar_Standard_Time—The time zone will be Myanmar Standard Time (UTC+06:30).
  • SE_Asia_Standard_Time—The time zone will be SE Asia Standard Time (UTC+07:00).
  • Altai_Standard_Time—The time zone will be Altai Standard Time (UTC+07:00).
  • W._Mongolia_Standard_Time—The time zone will be W. Mongolia Standard Time (UTC+07:00).
  • North_Asia_Standard_Time—The time zone will be North Asia Standard Time (UTC+07:00).
  • N._Central_Asia_Standard_Time—The time zone will be N. Central Asia Standard Time (UTC+07:00).
  • Tomsk_Standard_Time—The time zone will be Tomsk Standard Time (UTC+07:00).
  • China_Standard_Time—The time zone will be China Standard Time (UTC+08:00).
  • North_Asia_East_Standard_Time—The time zone will be North Asia East Standard Time (UTC+08:00).
  • Singapore_Standard_Time—The time zone will be Singapore Standard Time (UTC+08:00).
  • W._Australia_Standard_Time—The time zone will be W. Australia Standard Time (UTC+08:00).
  • Taipei_Standard_Time—The time zone will be Taipei Standard Time (UTC+08:00).
  • Ulaanbaatar_Standard_Time—The time zone will be Ulaanbaatar Standard Time (UTC+08:00).
  • Aus_Central_W._Standard_Time—The time zone will be Aus Central W. Standard Time (UTC+08:45).
  • Transbaikal_Standard_Time—The time zone will be Transbaikal Standard Time (UTC+09:00).
  • Tokyo_Standard_Time—The time zone will be Tokyo Standard Time (UTC+09:00).
  • North_Korea_Standard_Time—The time zone will be North Korea Standard Time (UTC+09:00).
  • Korea_Standard_Time—The time zone will be Korea Standard Time (UTC+09:00).
  • Yakutsk_Standard_Time—The time zone will be Yakutsk Standard Time (UTC+09:00).
  • Cen._Australia_Standard_Time—The time zone will be Cen. Australia Standard Time (UTC+09:30).
  • AUS_Central_Standard_Time—The time zone will be AUS Central Standard Time (UTC+09:30).
  • E._Australia_Standard_Time—The time zone will be E. Australia Standard Time (UTC+10:00).
  • AUS_Eastern_Standard_Time—The time zone will be AUS Eastern Standard Time (UTC+10:00).
  • West_Pacific_Standard_Time—The time zone will be West Pacific Standard Time (UTC+10:00).
  • Tasmania_Standard_Time—The time zone will be Tasmania Standard Time (UTC+10:00).
  • Vladivostok_Standard_Time—The time zone will be Vladivostok Standard Time (UTC+10:00).
  • Lord_Howe_Standard_Time—The time zone will be Lord Howe Standard Time (UTC+10:30).
  • Bougainville_Standard_Time—The time zone will be Bougainville Standard Time (UTC+11:00).
  • Russia_Time_Zone_10—The time zone will be Russia Time Zone 10 (UTC+11:00).
  • Magadan_Standard_Time—The time zone will be Magadan Standard Time (UTC+11:00).
  • Norfolk_Standard_Time—The time zone will be Norfolk Standard Time (UTC+11:00).
  • Sakhalin_Standard_Time—The time zone will be Sakhalin Standard Time (UTC+11:00).
  • Central_Pacific_Standard_Time—The time zone will be Central Pacific Standard Time (UTC+11:00).
  • Russia_Time_Zone_11—The time zone will be Russia Time Zone 11 (UTC+11:00).
  • New_Zealand_Standard_Time—The time zone will be New Zealand Standard Time (UTC+12:00).
  • UTC+12—The time zone will be UTC+12 (UTC+12:00).
  • Fiji_Standard_Time—The time zone will be Fiji Standard Time (UTC+12:00).
  • Kamchatka_Standard_Time—The time zone will be Kamchatka Standard Time (UTC+12:00).
  • Chatham_Islands_Standard_Time—The time zone will be Chatham Islands Standard Time (UTC+12:45).
  • UTC+13—The time zone will be UTC+13 (UTC+13:00).
  • Tonga_Standard_Time—The time zone will be Tonga Standard Time (UTC+13:00).
  • Samoa_Standard_Time—The time zone will be Samoa Standard Time (UTC+13:00).
  • Line_Islands_Standard_Time—The time zone will be Line Islands Standard Time (UTC+14:00).
String
adjust_DST
(Optional)

Specifies whether the input time configuration will be adjusted for daylight saving time.

This parameter is not applicable for analysis on the Moon.

  • NOT_ADJUSTED_FOR_DST—The input time values will not be adjusted for daylight saving time. This is the default.
  • ADJUSTED_FOR_DST—The input time values will be adjusted for daylight saving time.
Boolean
use_time_interval
(Optional)

Specifies whether a single total insolation value will be calculated for the entire time configuration or multiple radiation values will be calculated for the specified interval.

  • NO_INTERVAL—A single radiation value will be calculated for the entire time configuration. This is default.
  • INTERVAL—Multiple radiation values will be calculated for each time interval over the entire time configuration.
Boolean
interval_unit
(Optional)

Specifies the time unit that will be used for calculating solar radiation values over the entire time configuration.

This parameter is only supported when the use_time_interval parameter is set to INTERVAL.

  • MINUTE—The interval unit will be minutes. This option is only available for Earth-based data.
  • HOUR—The interval unit will be hours.
  • DAY—The interval unit will be days. This is the default
  • WEEK—The interval unit will be weeks.
String
interval
(Optional)

The value of the duration or time between intervals.

The default value is dependent on the interval unit specified. The default value for each of the available units are listed below.

  • MINUTE—60
  • HOUR—4
  • DAY—14
  • WEEK—2
Long
feature_offset
(Optional)

A vertical distance that will be added to the raster surface for analysis. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the height of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

The default value is 0.

Double; Field
feature_area
(Optional)

The area associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the area of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

By default, the area is obtained from the input features. For point features, the default area is 0.

Double; Field
feature_slope
(Optional)

The relative slope or incline associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the incline of the panel.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

Slope is expressed in degrees from 0 to 90. The default values for analysis are calculated from the underlying values of the input surface raster.

Double; Field
feature_aspect
(Optional)

The relative aspect or direction associated with the input features. It must be a positive integer or floating-point value.

You can select a field from the input features dataset, or you can provide a numerical value.

For example, if the object is a panel, provide the direction of the panel face.

If a value is provided for this parameter, that value will be used by all features. To specify different values for each individual feature, select a field from the input features dataset.

Aspect is expressed in degrees from 0 to 360. The default values for analysis area calculated from the underlying values of the input surface raster.

Double; Field
neighborhood_distance
(Optional)

The distance from the target cell center for which the output insolation value will be calculated. It determines the size of the neighborhood.

The default value is the input surface raster cell size, resulting in a 3 by 3 neighborhood.

Linear Unit
use_adaptive_neighborhood
(Optional)

Specifies whether neighborhood distance will vary with landscape changes (adaptive). The maximum distance is determined by the neighborhood distance. The minimum distance is the input raster cell size.

  • FIXED_NEIGHBORHOOD—A single (fixed) neighborhood distance will be used at all locations. This is the default.
  • ADAPTIVE_NEIGHBORHOOD—An adaptive neighborhood distance will be used at all locations.
Boolean
diffuse_model_type
(Optional)

Specifies the type of diffuse radiation model that will be used.

  • UNIFORM_SKY—The uniform diffuse model will be used. The incoming diffuse radiation is the same from all sky directions. This is the default.
  • STANDARD_OVERCAST_SKY—The standard overcast diffuse model will be used. The incoming diffuse radiation flux varies with the zenith angle.
String
diffuse_proportion
(Optional)

The proportion of global normal radiation flux that is diffuse. Values range from 0 to 1.

Set this value according to atmospheric conditions. The default value is 0.3 for generally clear sky conditions.

Double
transmittivity
(Optional)

The fraction of radiation that passes through the atmosphere (averaged overall wavelengths). Values range from 0 (no transmission) to 1 (all transmission).

The default is 0.5 for a generally clear sky.

Double
analysis_target_device
(Optional)

Specifies the device that will be used to perform the calculation.

  • GPU_THEN_CPU—If a compatible GPU is found, it will be used to perform the calculation. Otherwise, the CPU will be used. This is the default.
  • CPU_ONLY—The calculation will only be performed on the CPU.
  • GPU_ONLY—The calculation will only be performed on the GPU.
String
out_join_layer
(Optional)

The output layer that will be created by joining the output table to the input feature class. This is an optional output.

Feature Layer

Code sample

FeatureSolarRadiation example 1 (Python window)

The following Python window script demonstrates how to use the FeatureSolarRadiation function.

import arcpy
from arcpy.sa import *
from arcpy import env
env.workspace = "C:/sapyexamples/solardata.gdb"
env.scratchWorkspace = "C:/sapyexamples/outfile.gdb"
#Run FeatureSolarRadiation
arcpy.sa.FeatureSolarRadiation("dem30m.tif","solar_pnts","pntID","SolarPnts_radiation_092023",
                               "9/1/2023 06:30:00 AM","10/1/2023 6:30:00 PM","Pacific_Standard_Time")
FeatureSolarRadiation example 2 (stand-alone script)

Calculates the solar insolation for the whole year 2023 at one week intervals for engineered features represented by point features.

# Name: FeatureSolarRadiation_standalone.py
# Description: Calculate the solar insolation for the whole year 2023 at one week 
#               intervals for engineered features represented by point features.
# Requirements: Spatial Analyst Extension

# Import system modules
import arcpy
from arcpy.sa import *

# Set environment settings
arcpy.env.workspace = "C:/sapyexamples/solardata.gdb"
arcpy.env.scratchWorkspace = "C:/sapyexamples/outfile.gdb"

# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")

# Run FeatureSolarRadiation
arcpy.sa.FeatureSolarRadiation(
    in_surface_raster="dem30m.tif",
    in_features="solar_pnts",
    unique_id_field="pntID",
    out_table=r"SolarPnts_radiation_092023",
    start_date_time="1/1/2023",
    end_date_time="12/31/2023",
    time_zone="Mountain_Standard_Time",
    adjust_DST="ADJUSTED_FOR_DST",
    use_time_interval="NO_INTERVAL",
    interval_unit="WEEK",
    interval=1,
    feature_offset=2.5,
    feature_area="Area_FLD",
    feature_slope="Slope_FLD",
    feature_aspect="Aspect_FLD",
    neighborhood_distance="",
    use_adaptive_neighborhood="",
    diffuse_model_type="UNIFORM_SKY",
    diffuse_proportion=0.3,
    transmittivity=0.5,
    analysis_target_device="GPU_THEN_CPU",
    out_join_layer=None
)

Environments

Auto Commit, Cell Size, Cell Size Projection Method, Compression, Current Workspace, Daylight Savings, Extent, Geographic Transformations, Output CONFIG Keyword, Output Coordinate System, Parallel Processing Factor, Qualified Field Names, Scratch Workspace, Snap Raster, Time Zone, Transfer Field Domain Descriptions

Licensing information

  • Basic: Requires Spatial Analyst
  • Standard: Requires Spatial Analyst
  • Advanced: Requires Spatial Analyst

Related topics

  • An overview of the Solar Radiation toolset
  • Find a geoprocessing tool
  • Raster Solar Radiation

Feedback on this topic?

In this topic
  1. Summary
  2. Usage
  3. Parameters
  4. Environments
  5. Licensing information