VfBinary—ArcGIS Pro | Documentation

Available with Spatial Analyst license.

Summary

Defines the relationship between the vertical cost factor and the vertical relative moving angle through a binary function. If the vertical relative moving angle is greater than the low-cut angle and less than the high-cut angle, the vertical factor is set to the value associated with the zero factor; otherwise it is infinity.

Illustration

VfBinary vertical factor image — VfBinary vertical factor for the PathDistance functions.

Discussion

The VfBinary object is used in the Spatial Analyst tools Path Distance, Path Distance Allocation, and Path Distance Back Link.

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 associated with the zeroFactor. If the VRMA is greater than the highCutAngle or lower than the lowCutAngle, the VF is set to infinity.

Syntax

 VfBinary ({zeroFactor}, {lowCutAngle}, {highCutAngle})

Parameter	Explanation	Data Type
zeroFactor	The zeroFactor will be used to position the y-intercept of the binary function. (The default value is 1.0)	Double
lowCutAngle	The VRMA degree defining the lower threshold, below which (less than) the VFs are set to infinity. (The default value is -30.0)	Double
highCutAngle	The VRMA degree defining the upper threshold, beyond which (larger than) the VFs are set to infinity. (The default value is 30.0)	Double

Properties

Property	Explanation	Data Type
zeroFactor (Read and Write)	The zeroFactor is used to position the y-intercept for the vertical factor class.	Double
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

VfBinary example 1 (Python window)

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

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
myVerticalFactor = VfBinary(1.0, -30, 30)
outPathDist = PathDistance("source.shp", "costraster", "", "", "", "",
                           myVerticalFactor)
outPathDist.save("C:/sapyexamples/output/pathdistvfb")

VfBinary example 2 (stand-alone script)

Performs a PathDistance analysis using the VfBinary class.

# Name: VfBinary_Ex_02.py
# Description: Uses the VfBinary object to execute the PathDistance 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"

# Create the VfBinary Object
zeroFactor = 1.0
lowCutAngle = -30
highCutAngle = 30
myVerticalFactor = VfBinary(zeroFactor, lowCutAngle, highCutAngle)

# Execute PathDistance
outPathDist = PathDistance(inSourceData, inCostRaster, "", "", "", "",
                           myVerticalFactor)

# Save the output 
outPathDist.save("C:/sapyexamples/output/pathdistvfb2")