需要 Spatial Analyst 许可。
描述
定义一个 MS 小值变换函数,该函数是根据平均值乘数和标准差乘数这两个形状控制参数,以及确定函数应用范围的阈值上限和下限确定的。
讨论
使用 TfMSSmall 对象的工具为按函数重设等级。
其中 x 为输入值,根据 a * m 的乘积,MS 小值函数有两个方程:
- 如果 x > a * m:
f(x) = (b * s) / (x - (a * m) + (b * s))
- 其中:
x = 输入值
m = 平均值
s = 标准差
a = 平均值乘数
b = 标准差乘数
a 和 b 乘数是输入参数。
- 其中:
- 如果 x <= a * m:
f(x) = 0
函数值的范围为从 0 到 1,此范围随后将转换为评估等级。
MS 小值函数适用于优先使用小输入值并获得较高输出评估值的情况。
MS 小值变换函数的结果与小值变换函数类似,具体取决于平均值和标准差乘数的定义方式。
语法
TfMSSmall ({meanMultiplier}, {STDMultiplier}, {lowerThreshold}, {valueBelowThreshold}, {upperThreshold}, {valueAboveThreshold})
参数 | 说明 | 数据类型 |
meanMultiplier | MS 小值函数方程中输入值的平均值的乘数。 meanMultiplier 必须大于 0。 (默认值为 1.0) | Double |
STDMultiplier | MS 小值函数方程中输入值的标准差的乘数。 STDMultiplier 必须大于 0。 (默认值为 1.0) | 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 |
属性
属性 | 说明 | 数据类型 |
meanMultiplier (可读写) |
变换函数的 meanMultiplier 值,用于确定方程中的平均值乘数。 | Double |
STDMultiplier (可读写) |
变换函数的 STDMultiplier 值,用于确定函数方程中标准差的乘数。 | Double |
lowerThreshold (可读写) |
变换函数的 lowerThreshold 的值,用于定义开始应用指定变换函数的起始值。 | Double |
valueBelowThreshold (可读写) |
输入值低于 lowerThreshold 的值将被分配到输出像元。 | Variant |
upperThreshold (可读写) |
变换函数的 upperThreshold 值,用于定义停止应用指定函数的终止值。 | Double |
valueAboveThreshold (可读写) | 输入值高于 upperThreshold 的值将被分配到输出像元。 | Variant |
代码示例
MS 小值变换函数示例 1(Python 窗口)
演示如何创建 TfMSSmall 类以及如何在 Python 窗口的 RescaleByFunction 工具中使用该类。
import arcpy
from arcpy.sa import *
from arcpy import env
env.workspace = "c:/sapyexamples/data"
outRescale = RescaleByFunction("elevation", TfMSSmall(1.5, 1.75, "#", "#", "#", "#"), 1, 10)
outRescale.save("c:/sapyexamples/rescaletfms1")
MS 小值变换函数示例 2(独立脚本)
演示如何通过 TfMSSmall 类在 RescaleByFunction 工具中转换输入数据。
# Name: TfMSSmall_Ex_02.py
# Description: Rescales input raster data using a MSSmall 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 = "elevation"
# Create the TfMSSmall object
meanmult = 1.5
stdmult = 1.75
lowerthresh = "#"
valbelowthresh = "#"
upperthresh = "#"
valabovethresh = "#"
myTfFunction = TfMSSmall(meanmult, stdmult, 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/rescaletfms2")