com.supermap.analyst.spatialstatistics
类 PatternsParameter

java.lang.Object
  com.supermap.analyst.spatialstatistics.PatternsParameter

public class PatternsParameter
extends java.lang.Object

分析模式参数类。该类主要用来对分析模式计算的参数进行设置。

通过分析模式参数设置类可以设置评估字段、概念化模型、中断距离容限、反距离幂指数、邻近数目、标准化、自身权重字段、FDR校正等。

构造方法摘要

PatternsParameter()
默认构造函数，构造一个新的 PatternsParameter 对象。

PatternsParameter(PatternsParameter patternsParameter)
拷贝构造函数，根据给定的 PatternsParameter 对象构造一个与其完全相同的新对象。

方法摘要

void	dispose() 释放 PatternsParameter 对象所占有的资源。
java.lang.String	getAssessmentFieldName() 返回评估字段的名称。
ConceptualizationModel	getConceptModel() 返回空间关系概念化模型。
DistanceMethod	getDistanceMethod() 返回距离计算方法类型。
double	getDistanceTolerance() 返回中断距离容限。
double	getExponent() 返回反距离幂指数。
java.lang.String	getFilePath() 返回空间权重矩阵文件路径。
int	getKNeighbors() 返回相邻数目。
java.lang.String	getSelfWeightFieldName() 返回自身权重字段的名称。
boolean	isFDRAdjusted() 返回是否进行FDR（错误发现率）校正。
boolean	isStandardization() 返回是否对空间权重矩阵进行标准化。
void	setAssessmentFieldName(java.lang.String value) 设置评估字段的名称。
void	setConceptModel(ConceptualizationModel value) 设置空间关系概念化模型。
void	setDistanceMethod(DistanceMethod value) 设置距离计算方法类型。
void	setDistanceTolerance(double value) 设置中断距离容限。
void	setExponent(double value) 设置反距离幂指数。
void	setFDRAdjusted(boolean value) 设置是否进行FDR（错误发现率）校正。
void	setFilePath(java.lang.String value) 设置空间权重矩阵文件路径。
void	setKNeighbors(int value) 设置相邻数目。
void	setSelfWeightFieldName(java.lang.String value) 设置自身权重字段的名称。
void	setStandardization(boolean value) 设置是否对空间权重矩阵进行标准化。

从类 java.lang.Object 继承的方法

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

PatternsParameter

public PatternsParameter()

默认构造函数，构造一个新的 PatternsParameter 对象。

PatternsParameter

public PatternsParameter(PatternsParameter patternsParameter)

拷贝构造函数，根据给定的 PatternsParameter 对象构造一个与其完全相同的新对象。

参数：

patternsParameter - 指定的 PatternsParameter 对象。

方法详细信息

getAssessmentFieldName

public java.lang.String getAssessmentFieldName()

返回评估字段的名称。

仅数值字段有效。

返回：

评估字段的名称。

setAssessmentFieldName

public void setAssessmentFieldName(java.lang.String value)

设置评估字段的名称。

参数：

value - 评估字段的名称。

getConceptModel

public ConceptualizationModel getConceptModel()

返回空间关系概念化模型。

返回：

空间关系概念化模型。

默认值:

默认值为 ConceptualizationModel.INVERSEDISTANCE。

setConceptModel

public void setConceptModel(ConceptualizationModel value)

设置空间关系概念化模型。

参数：

value - 空间关系概念化模型。

getDistanceTolerance

public double getDistanceTolerance()

返回中断距离容限。

仅对概念化模型设置为ConceptualizationModel.INVERSEDISTANCE、 ConceptualizationModel.INVERSEDISTANCESQUARED、 ConceptualizationModel.FIXEDDISTANCEBAND、 ConceptualizationModel.ZONEOFINDIFFERENCE 时有效。

为"反距离"和"固定距离"模型指定中断距离。"-1"表示计算并应用默认距离，此默认值为保证每个要素至少有一个相邻的要素;"0"表示为未应用任何距离，则每个要素都是相邻要素。

返回：

距离中断距离容限。

默认值:

默认值为 -1.0。

setDistanceTolerance

public void setDistanceTolerance(double value)

设置中断距离容限。

仅对概念化模型设置为ConceptualizationModel.INVERSEDISTANCE、 ConceptualizationModel.INVERSEDISTANCESQUARED、 ConceptualizationModel.FIXEDDISTANCEBAND、 ConceptualizationModel.ZONEOFINDIFFERENCE 时有效。

为"反距离"和"固定距离"模型指定中断距离。"-1"表示计算并应用默认距离，此默认值为保证每个要素至少有一个相邻的要素;"0"表示为未应用任何距离，则每个要素都是相邻要素。

参数：

value - 中断距离容限。

getExponent

public double getExponent()

返回反距离幂指数。

仅对概念化模型设置为ConceptualizationModel.INVERSEDISTANCE、 ConceptualizationModel.INVERSEDISTANCESQUARED、 ConceptualizationModel.ZONEOFINDIFFERENCE 时有效。

返回：

反距离幂指数。

默认值:

默认值为 1.0。

setExponent

public void setExponent(double value)

设置反距离幂指数。

仅对概念化模型设置为ConceptualizationModel.INVERSEDISTANCE、 ConceptualizationModel.INVERSEDISTANCESQUARED、 ConceptualizationModel.ZONEOFINDIFFERENCE 时有效。

参数：

value - 反距离幂指数。

getKNeighbors

public int getKNeighbors()

返回相邻数目。

仅对概念化模型设置为ConceptualizationModel.KNEARESTNEIGHBORS 时有效。

目标要素周围最近的K个要素为相邻要素。

返回：

相邻数目。

默认值:

默认值为 1。

setKNeighbors

public void setKNeighbors(int value)

设置相邻数目。

仅对概念化模型设置为ConceptualizationModel.KNEARESTNEIGHBORS 时有效。

目标要素周围最近的K个要素为相邻要素。

参数：

value - 相邻数目。

isStandardization

public boolean isStandardization()

返回是否对空间权重矩阵进行标准化。

若进行标准化,则每个权重都会除以该行的和。对热点分析无效。

返回：

是否对空间权重矩阵进行标准化。

默认值:

默认值为 false，即不进行标准化。

setStandardization

public void setStandardization(boolean value)

设置是否对空间权重矩阵进行标准化。

若进行标准化,则每个权重都会除以该行的和。对热点分析无效。

参数：

value - 是否对空间权重矩阵进行标准化。

getSelfWeightFieldName

public java.lang.String getSelfWeightFieldName()

返回自身权重字段的名称。

仅数值字段有效。暂仅对热点分析有效。

返回：

自身权重字段的名称。

默认值:

默认值为 null，即无自身权重字段。

setSelfWeightFieldName

public void setSelfWeightFieldName(java.lang.String value)

设置自身权重字段的名称。

仅数值字段有效。暂仅对热点分析有效。

参数：

value - 自身权重字段的名称。

默认值:

默认值为 null，即无自身权重字段。

isFDRAdjusted

public boolean isFDRAdjusted()

返回是否进行FDR（错误发现率）校正。

1. 若进行FDR（错误发现率）校正,则统计显著性将以错误发现率校正为基础,否则,统计显著性将以P值和z得分字段为基础。
2. 仅对聚类和异常值分析和热点分析有效。

返回：

是否进行FDR（错误发现率）校正。

默认值:

默认值为 false，即不进行FDR（错误发现率）校正。

setFDRAdjusted

public void setFDRAdjusted(boolean value)

设置是否进行FDR（错误发现率）校正。

1. 若进行FDR（错误发现率）校正,则统计显著性将以错误发现率校正为基础,否则,统计显著性将以P值和z得分字段为基础。
2. 仅对聚类和异常值分析和热点分析有效。

参数：

value - 是否进行FDR（错误发现率）校正。

getFilePath

public java.lang.String getFilePath()

返回空间权重矩阵文件路径。

返回：

空间权重矩阵文件路径。

默认值:

默认值为 null，即无空间权重矩阵文件。

setFilePath

public void setFilePath(java.lang.String value)

设置空间权重矩阵文件路径。

参数：

value - 空间权重矩阵文件路径。

getDistanceMethod

public DistanceMethod getDistanceMethod()

返回距离计算方法类型。

暂只支持欧式距离。

返回：

输出距离计算方法类型。

默认值:

默认值为 DistanceMethod.EUCLIDEAN。

setDistanceMethod

public void setDistanceMethod(DistanceMethod value)

设置距离计算方法类型。

暂只支持欧式距离。

参数：

value - 距离计算方法类型。

dispose

public void dispose()

释放 PatternsParameter 对象所占有的资源。当调用该方法之后，此对象不再可用。