Skip To Content

TimeWholeYear

Available with Spatial Analyst license.

Summary

Defines a year, using monthly intervals, to perform solar caclulations.

Discussion

This object can be used in the following tools: Area Solar Radiation, Points Solar Radiation, and Solar Radiation Graphics.

If the {each_interval} option is set in the tool parameter, then output files will be created for each month; otherwise, a single output will be created for the whole year.

Syntax

 TimeWholeYear ({year})
ParameterExplanationData Type
year

The Julian year.

(The default value is the current Julian year)

Long

Properties

PropertyExplanationData Type
year
(Read and Write)

The Julian year.

Long

Code sample

TimeWholeYear example 1 (Python window)

Demonstrates how to create a TimeWholeYear class and use it in the AreaSolarRadiation tool within the Python window.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outAreaSolar = AreaSolarRadiation("solar_dem", "", "", TimeWholeYear(2008))
outAreaSolar.save("C:/sapyexamples/output/areasolartwy")
TimeWholeYear example 2 (stand-alone script)

Calculates the incoming solar radiation with the AreaSolarRadiation tool using the TimeWholeYear class.

# Name: TimeWholeYear_Ex_02.py
# Description: Execute AreaSolarRadiation using the TimeWholeYear object
# Requirements: Spatial Analyst Extension

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

# Set environment settings
env.workspace = "C:/sapyexamples/data"

# Set local variables
inRaster = "solar_dem"

# Create a TimeWholeYear Object
year = 2004
myTimeWholeYear = TimeWholeYear(year)

# Execute AreaSolarRadiation
outAreaSolar = AreaSolarRadiation(inRaster, "", 200, myTimeWholeYear, 14, 0.5,
                                  "NOINTERVAL", 1, "FROM_DEM", 32, 8, 8,
                                  "UNIFORM_SKY", 0.3, 0.5)

# Save the output 
outAreaSolar.save("C:/sapyexamples/output/mysolarout")

Related topics