com.supermap.analyst.spatialanalyst
类 ZonalStatisticsAnalystParameter

java.lang.Object
  继承者 com.supermap.analyst.spatialanalyst.ZonalStatisticsAnalystParameter

public class ZonalStatisticsAnalystParameter
extends java.lang.Object

分带统计参数设置类。该类提供了进行分带统计时的参数的设置。


构造方法摘要
ZonalStatisticsAnalystParameter()
          构造一个新的 ZonalStatisticAnalystParameter 对象。
ZonalStatisticsAnalystParameter(ZonalStatisticsAnalystParameter zonalStatisticAnalystParameter)
          根据给定的 ZonalStatisticAnalystParameter 对象构造一个与其完全相同的的新对象。
 
方法摘要
 PixelFormat getPixelFormat()
          已过时。 已过时。对结果栅格的像素类型的说明,请参见:zonalStatisticsOnRasterValue() 方法。 返回像素格式。
 GridStatisticsMode getStatisticsMode()
          返回分带统计类型。
 java.lang.String getTargetDatasetName()
          返回结果数据集的名称。
 Datasource getTargetDatasource()
          返回用于存储结果数据的数据源。
 java.lang.String getTargetTableName()
          返回分析结果属性表的名称。
 Dataset getValueDataset()
          返回需要被统计的值数据。
 Dataset getZonalDataset()
          返回待统计的分带数据集。
 java.lang.String getZonalFieldName()
          返回矢量分带数据中用于标识带的字段。
 boolean isIgnoreNoValue()
          返回统计时是否忽略无值数据。
 void setIgnoreNoValue(boolean value)
          设置统计时是否忽略无值数据。
 void setPixelFormat(PixelFormat value)
          已过时。 已过时。对结果栅格的像素类型的说明,请参见:zonalStatisticsOnRasterValue() 方法。 设置像素格式。
 void setStatisticsMode(GridStatisticsMode value)
          设置分带统计类型。
 void setTargetDatasetName(java.lang.String value)
          设置结果数据集的名称。
 void setTargetDatasource(Datasource value)
          设置用于存储结果数据的数据源。
 void setTargetTableName(java.lang.String value)
          设置分析结果属性表的名称。
 void setValueDataset(Dataset value)
          设置需要被统计的值数据。
 void setZonalDataset(Dataset zonalDataset)
          设置待统计的分带数据集。
 void setZonalFieldName(java.lang.String zonalFieldName)
          设置矢量分带数据中用于标识带的字段。
 
从类 java.lang.Object 继承的方法
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

ZonalStatisticsAnalystParameter

public ZonalStatisticsAnalystParameter()
构造一个新的 ZonalStatisticAnalystParameter 对象。


ZonalStatisticsAnalystParameter

public ZonalStatisticsAnalystParameter(ZonalStatisticsAnalystParameter zonalStatisticAnalystParameter)
根据给定的 ZonalStatisticAnalystParameter 对象构造一个与其完全相同的的新对象。

参数:
zonalStatisticAnalystParameter -
方法详细信息

getStatisticsMode

public GridStatisticsMode getStatisticsMode()
返回分带统计类型。

返回:
分带统计类型。
默认值:
默认值为 GridStatisticsMode.SUM

setStatisticsMode

public void setStatisticsMode(GridStatisticsMode value)
设置分带统计类型。

参数:
value - 分带统计类型。

isIgnoreNoValue

public boolean isIgnoreNoValue()
返回统计时是否忽略无值数据。

如果为 true,表示无值栅格不参与运算;若为 false,表示有无值参与的运算,结果仍为无值。

返回:
统计时是否忽略无值数据。
默认值:
默认值为 true。

setIgnoreNoValue

public void setIgnoreNoValue(boolean value)
设置统计时是否忽略无值数据。

如果为 true,表示无值栅格不参与运算;若为 false,表示有无值参与的运算,结果仍为无值。

参数:
value - 统计时是否忽略无值数据。

getTargetDatasource

public Datasource getTargetDatasource()
返回用于存储结果数据的数据源。

返回:
用于存储结果数据的数据源。

setTargetDatasource

public void setTargetDatasource(Datasource value)
设置用于存储结果数据的数据源。

参数:
value - 用于存储结果数据的数据源。

getTargetDatasetName

public java.lang.String getTargetDatasetName()
返回结果数据集的名称。

返回:
结果数据集的名称。

setTargetDatasetName

public void setTargetDatasetName(java.lang.String value)
设置结果数据集的名称。

参数:
value - 结果数据集的名称。

getTargetTableName

public java.lang.String getTargetTableName()
返回分析结果属性表的名称。

返回:
分析结果属性表的名称。

setTargetTableName

public void setTargetTableName(java.lang.String value)
设置分析结果属性表的名称。

参数:
value - 分析结果属性表的名称。

getPixelFormat

@Deprecated
public PixelFormat getPixelFormat()
已过时。 已过时。对结果栅格的像素类型的说明,请参见:zonalStatisticsOnRasterValue() 方法。 返回像素格式。

返回:
像素格式。
默认值:
默认值为 PixelFormat.SINGLE

setPixelFormat

@Deprecated
public void setPixelFormat(PixelFormat value)
已过时。 已过时。对结果栅格的像素类型的说明,请参见:zonalStatisticsOnRasterValue() 方法。 设置像素格式。

参数:
value - 像素格式。

getValueDataset

public Dataset getValueDataset()
返回需要被统计的值数据。

返回:
需要被统计的值数据。

setValueDataset

public void setValueDataset(Dataset value)
设置需要被统计的值数据。目前只支持栅格数据。

参数:
value - 需要被统计的值数据。

getZonalDataset

public Dataset getZonalDataset()
返回待统计的分带数据集。

返回:
待统计的分带数据集。

setZonalDataset

public void setZonalDataset(Dataset zonalDataset)
设置待统计的分带数据集。仅支持像素格式(PixelFormat)为 UBIT1、UBIT4、UBIT8 和 UBIT16 的栅格数据集或矢量面数据集。

参数:
zonalDataset - 待统计的分带数据集。
抛出:
java.lang.IllegalArgumentException - 如果设置的栅格数据集的像素类型不是 UBIT1、UBIT4、UBIT8 或 UBIT16,或设置的矢量数据集不是面数据集。

getZonalFieldName

public java.lang.String getZonalFieldName()
返回矢量分带数据中用于标识带的字段。

返回:
矢量分带数据中用于标识带的字段。
默认值:
默认值为 SMID。

setZonalFieldName

public void setZonalFieldName(java.lang.String zonalFieldName)
设置矢量分带数据中用于标识带的字段。字段类型只支持32位整型。

参数:
zonalFieldName - 矢量分带数据中用于标识带的字段。