Available with Spatial Analyst license.
Summary
Defines the relationship between the vertical cost factor and the vertical relative moving angle through the reciprocal of Tobler's function, which results in hiking time in hours.
Illustration
Discussion
The VfHikingTime object is used in the Distance Accumulation and Distance Allocation Spatial Analyst tools, as well as the Path Distance, Path Distance Allocation, and Path Distance Back Link Legacy Distance tools.
The vertical factor (VF) object defines the relationship between the vertical cost factor and the vertical relative moving angle (VRMA).
VF defines the vertical difficulty encountered in moving from one cell to the next.
VRMA identifies the slope angle between the FROM or processing cell and the TO cell.
When the VRMA is larger than the low-cut angle and smaller than the high-cut angle, the VF for moving between the two cells is set to the value derived from the function. If the VRMA is greater than the highCutAngle value or lower than the lowCutAngle value, the VF is set to infinity.
The formula for Tobler's hiking function is as follows:
The formula for VfHikingTime, which is the reciprocal of Tobler's hiking function, is as follows:
Where d is the angle that slope is calculated from.
Note:
For additional information about Tobler's hiking function, see Adjust the encountered distance using a vertical factor in the geoprocessing tool help and the following resource:
- Tobler, Waldo. 1993. Three Presentations on Geographical Analysis and Modeling: Non-Isotropic Geographic Modeling; Speculations on the Geometry of Geography; and Global Spatial Analysis (93-1). Retrieved from https://escholarship.org/uc/item/05r820mz
Syntax
VfHikingTime ({lowCutAngle}, {highCutAngle})
Parameter | Explanation | Data Type |
lowCutAngle | The VRMA degree defining the lower threshold, below which (less than) the VFs are set to infinity. (The default value is -70.0) | Double |
highCutAngle | The VRMA degree defining the upper threshold, beyond which (larger than) the VFs are set to infinity. (The default value is 70.0) | Double |
Properties
Property | Explanation | Data Type |
lowCutAngle (Read and Write) | The VRMA degree defining the lower threshold, below which (less than) the VFs are set to infinity. | Double |
highCutAngle (Read and Write) | The VRMA degree defining the upper threshold, beyond which (larger than) the VFs are set to infinity. | Double |
Code sample
This code sample demonstrates how to create the VfHikingTime class and use it in the Distance Accumulation tool in the Python window.
import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
myVerticalFactor = VfHikingTime(-30, 30)
outDistAccum = DistanceAccumulation("Source.shp", "", "elev.tif",
"cost.tif", "elev.tif",
myVerticalFactor)
outDistAccum.save("C:/sapyexamples/output/distAccumVfH.tif")
Perform a distance accumulation analysis using the Distance Accumulation tool and the VfHikingTime class.
# Name: VfHikingTime_Ex_02.py
# Description: Uses the VfHikingTime object to run the
# DistanceAccumulation tool
# 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
inSourceData = "source.shp"
inCostRaster = "costraster.tif"
inElevation = "elev.tif"
# Create the VfHikingTime Object
lowCutAngle = -30
highCutAngle = 30
myVerticalFactor = VfHikingTime(lowCutAngle, highCutAngle)
# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")
# Run DistanceAccumulation
outDistAccum = DistanceAccumulation(inSourceData, "", inElevation,
inCostRaster, inElevation,
myVerticalFactor)
# Save the output
outDistAccum.save("C:/sapyexamples/output/distaccumvfH2.tif")