TfExponential (arcpy.sa)

摘要

定义一个指数变换函数，该函数是根据平移和基础系数这两个形状控制参数，以及确定函数应用范围的阈值上限和下限确定的。

了解有关各参数对此变换函数作用的详细信息

讨论

使用 TfExponential 对象的工具为按函数重设等级。

可达的最高函数值限于最大单精度浮点值（FLT_MAX，值为 3.402823466 x 10³⁸）的二分之一，即 1.701411733 x 10³⁸。任何超出此限值的输入值都将在输出栅格中获得至等级的值。

每次增加高输入值时都会大幅增大所得的函数范围。因此，当函数范围线性变换为评估等级时，较高的函数值将影响范围，因而指数函数曲线的形状可能会在输出评估等级中丢失。可通过减小 upperThreshold 截断部分较高值。

开始行动:

baseFactor 和指数的底数之间有一定关系。将该底数转换为自然底数的公式为 b^x = (e^ln(b))^x = e^{x * ln(b)}，其中 ln(b) 是 TfExponential 函数 Exp((x - shift) * baseFactor) 中所用公式的 baseFactor。

语法

TfExponential ({shift}, {baseFactor}, {lowerThreshold}, {valueBelowThreshold}, {upperThreshold}, {valueAboveThreshold})

参数	说明	数据类型
shift	定义每个输入值应平移的量。平移值是从输入值中减去的值。将变换函数应用于平移后的输入值以确定函数值。 The shift can be positive or negative. (默认值为 None)	Double
baseFactor	控制指数函数增长程度的乘数。该乘数越大，输入值较大时的函数曲线越陡。指数函数的底数和基础系数之间有紧密的联系。baseFactor 1 等于自然指数 (e^x)。 (默认值为 None)	Double
lowerThreshold	定义开始应用指定变换函数的起始值。在输出栅格上与 lowerThreshold 对应的输入值将分配到自等级评估等级值。低于 lowerThreshold 的输入值将分配到 valueBelowThreshold，并且不会计入函数值范围。 lowerThreshold 必须小于 upperThreshold。 (默认值为 None)	Double
valueBelowThreshold	此用户定义的值用于分配输入值小于 lowerThreshold 的输出像元位置。 valueBelowThreshold 的值可以为浮点数、整数或 NoData。在工具对话框内，NoData 左右不使用引号；但在编写脚本时需要使用引号，即 "NoData"。 (默认值为 None)	Variant
upperThreshold	定义终止应用指定变换函数的结束值。在输出栅格上与 upperThreshold 对应的输入值将分配到至等级评估等级值。高于 upperThreshold 的输入值将分配到 valueAboveThreshold，并且不会计入函数值范围。 lowerThreshold 必须小于 upperThreshold。 (默认值为 None)	Double
valueAboveThreshold	此用户定义的值用于分配输入值大于 upperThreshold 的输出像元位置。 valueAboveThreshold 的值可以为浮点数、整数或 NoData。在工具对话框内，NoData 左右不使用引号；但在编写脚本时需要使用引号，即 "NoData"。 (默认值为 None)	Variant

属性

属性	说明	数据类型
shift (读写)	函数的平移值，用于定义在应用函数前每个输入值应减去的量。	Double
baseFactor (读写)	变换函数的 baseFactor 的值，用于控制指数函数增长的急剧程度。	Double
lowerThreshold (读写)	变换函数的 lowerThreshold 的值，用于定义开始应用指定变换函数的起始值。	Double
valueBelowThreshold (读写)	输入值低于 lowerThreshold 的值将被分配到输出像元。	Variant
upperThreshold (读写)	变换函数的 upperThreshold 值，用于定义停止应用指定函数的终止值。	Double
valueAboveThreshold (读写)	输入值高于 upperThreshold 的值将被分配到输出像元。	Variant

代码实例

指数变换函数示例 1（Python 窗口）

演示如何创建 TfExponential 类以及如何在 Python 窗口的 RescaleByFunction 工具中使用该类。

import arcpy
from arcpy.sa import *
from arcpy import env
env.workspace = "c:/sapyexamples/data"
outRescale = RescaleByFunction("distroads", TfExponential(30, 0.00035, "#", "#", "#", "#"), 1, 10)
outRescale.save("c:/sapyexamples/rescaletfex1")

指数变换函数示例 2（独立脚本）

演示如何使用 TfExponential 类在 RescaleByFunction 工具中转换输入数据。

# Name: TfExponential_Ex_02.py
# Description: Rescales input raster data using an Exponential function and
#     transforms the function values onto a specified evaluation scale. 
# Requirements: Spatial Analyst Extension
# Author: esri

# 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 = "distroads"

# Create the TfExponential object
shift = 30
basefactor = 0.00035
lowerthresh = "#"
valbelowthresh = "#"
upperthresh = "#"
valabovethresh = "#"
myTfFunction = TfExponential(shift, basefactor, lowerthresh, valbelowthresh, upperthresh, valabovethresh)

# Set evaluation scale
fromscale = 1
toscale = 10

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

# Execute RescaleByFunction
outRescale = RescaleByFunction(inRaster, myTfFunction, fromscale, toscale)

# Save the output
outRescale.save("c:/sapyexamples/rescaletfex2")