ImageStretchParameter (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.image.processing.ImageStretchParameter

所有已实现的接口:

IDisposable
```
public class ImageStretchParameter
extends com.supermap.data.InternalHandleDisposable
```
影像拉伸参数，用于DOM处理，参考 DomProject.setImageStretchParameter(boolean, com.supermap.image.processing.ImageStretchParameter)

构造器概要

构造器
构造器和说明

ImageStretchParameter()
默认构造函数

ImageStretchParameter(ImageStretchingType stretchingType)
根据影像拉伸类型构造对象

构造器
构造器和说明
`ImageStretchParameter()` 默认构造函数
`ImageStretchParameter(ImageStretchingType stretchingType)` 根据影像拉伸类型构造对象

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`ImageStretchParameter`	`clone()`
`void`	`dispose()` 释放对象所占用的资源。
`int`	`getBlueBand()` 返回蓝色波段索引
`double`	`getGamma()` 返回伽马拉伸参数。
`int`	`getGreenBand()` 返回绿色波段索引
`double`	`getHighlightAreaThreshold()` 返回高亮区域面积阈值
`double`	`getMaxPercent()` 返回最大截断百分比值。
`double`	`getMinPercent()` 返回最小截断百分比值。
`double`	`getNoDataValue()` 返回无值。
`int`	`getNumOfStd()` 返回高斯标准差系数。
`PixelFormat`	`getPixelFormat()` 返回结果影像像素格式。
`int`	`getRedBand()` 获取红色波段索引
`ImageStretchingType`	`getStretchingType()` 返回拉伸类型，默认为 `ImageStretchingType.LINEAR`
`boolean`	`isAdaptivePercent()`
`ImageStretchParameter`	`setAdaptivePercent(boolean value)` 设置是否自动计算线性拉伸截断百分比。
`ImageStretchParameter`	`setBlueBand(int value)` 设置蓝色波段索引。
`ImageStretchParameter`	`setGamma(double gamma)` 设置伽马拉伸参数。
`ImageStretchParameter`	`setGreenBand(int value)` 设置绿色波段索引。
`ImageStretchParameter`	`setHighlightAreaThreshold(double value)` 设置高亮区域面积阈值。
`static void`	`setIsDisposable(com.supermap.data.InternalHandleDisposable obj, boolean disposable)`
`ImageStretchParameter`	`setMaxPercent(double maxPercent)` 设置最大截断百分比值，表示最大值截断比例，范围为（0,100]。
`ImageStretchParameter`	`setMinPercent(double minPercent)` 设置最小截断百分比值，表示最小截断比例，范围为[0,100)。
`ImageStretchParameter`	`setNoDataValue(double value)` 拉伸结果影像的无值
`ImageStretchParameter`	`setNumOfStd(int value)` 设置高斯标准差系数，可以改变高斯分布的形状。
`ImageStretchParameter`	`setPixelFormat(PixelFormat pixelFormat)` 设置结果影像像素格式。
`ImageStretchParameter`	`setRedBand(int value)` 设置红色波段索引。
`ImageStretchParameter`	`setStretchingType(ImageStretchingType stretchingType)` 设置拉伸类型。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ImageStretchParameter
```
public ImageStretchParameter()
```
    默认构造函数
  - ImageStretchParameter
```
public ImageStretchParameter(ImageStretchingType stretchingType)
```
    根据影像拉伸类型构造对象
    
    参数:
    
    stretchingType - 影像拉伸类型
- 方法详细资料
  - dispose
```
public void dispose()
```
    释放对象所占用的资源。调用该方法之后，此对象不再可用。
  - clone
```
public ImageStretchParameter clone()
                            throws CloneNotSupportedException
```
    覆盖:
    
    clone 在类中 Object
    
    抛出:
    
    CloneNotSupportedException
  - getStretchingType
```
public ImageStretchingType getStretchingType()
```
    返回拉伸类型，默认为 ImageStretchingType.LINEAR
    
    返回:
    
    拉伸类型。
  - setStretchingType
```
public ImageStretchParameter setStretchingType(ImageStretchingType stretchingType)
```
    设置拉伸类型。
    
    参数:
    
    stretchingType - 拉伸类型。
    
    返回:
    
    当前对象
  - getMinPercent
```
public double getMinPercent()
```
    返回最小截断百分比值。
    
    返回:
    
    最小截断百分比值。
  - setMinPercent
```
public ImageStretchParameter setMinPercent(double minPercent)
```
    设置最小截断百分比值，表示最小截断比例，范围为[0,100)。
    
    参数:
    
    minPercent - 最小截断百分比值。
    
    返回:
    
    拉伸参数对象。
  - getMaxPercent
```
public double getMaxPercent()
```
    返回最大截断百分比值。
    
    返回:
    
    最大截断百分比值。
  - setMaxPercent
```
public ImageStretchParameter setMaxPercent(double maxPercent)
```
    设置最大截断百分比值，表示最大值截断比例，范围为（0,100]。
    
    参数:
    
    maxPercent - 最大截断百分比值。
    
    返回:
    
    当前对象
  - getGamma
```
public double getGamma()
```
    返回伽马拉伸参数。
    
    返回:
    
    伽马拉伸参数。
  - setGamma
```
public ImageStretchParameter setGamma(double gamma)
```
    设置伽马拉伸参数。只对 ImageStretchingType.GAMMA 拉伸类型有效
    
    参数:
    
    gamma - 伽马拉伸参数。
    
    返回:
    
    当前对象
  - getNoDataValue
```
public double getNoDataValue()
```
    返回无值。
    
    返回:
    
    无值。
  - setNoDataValue
```
public ImageStretchParameter setNoDataValue(double value)
```
    拉伸结果影像的无值
    
    参数:
    
    value - 无值
    
    返回:
    
    当前对象
  - getNumOfStd
```
public int getNumOfStd()
```
    返回高斯标准差系数。
    
    返回:
    
    标准差数。
  - setNumOfStd
```
public ImageStretchParameter setNumOfStd(int value)
```
    设置高斯标准差系数，可以改变高斯分布的形状。只对 ImageStretchingType.GAUSSIAN 拉伸类型有效
    
    参数:
    
    value - 标准差数。
    
    返回:
    
    当前对象
  - getPixelFormat
```
public PixelFormat getPixelFormat()
```
    返回结果影像像素格式。
    
    返回:
    
    像素格式。
  - setPixelFormat
```
public ImageStretchParameter setPixelFormat(PixelFormat pixelFormat)
```
    设置结果影像像素格式。
    
    参数:
    
    pixelFormat - 像素格式。
    
    返回:
    
    拉伸参数对象。
  - isAdaptivePercent
```
public boolean isAdaptivePercent()
```
    返回:
    
    是否自动计算线性拉伸截断百分比，默认为 false
  - setAdaptivePercent
```
public ImageStretchParameter setAdaptivePercent(boolean value)
```
    设置是否自动计算线性拉伸截断百分比。只有当拉伸类型为 ImageStretchingType.LINEAR 且结果像素格式ImageStretchParameter.getPixelFormat()为 PixelFormat.UBIT8 时有效。当使用自动计算截断百分比时，设置的 ImageStretchParameter.setMinPercent(double) 和 ImageStretchParameter.getMaxPercent() 无效。
    
    参数:
    
    value - 否自动计算线性拉伸截断百分比
    
    返回:
    
    当前对象
  - getRedBand
```
public int getRedBand()
```
    获取红色波段索引
    
    返回:
    
    红色波段索引
  - setRedBand
```
public ImageStretchParameter setRedBand(int value)
```
    设置红色波段索引。当 ImageStretchParameter.setAdaptivePercent(boolean) 为 true 时且原始影像波段数目大于等于3时，需要设置影像的红色波段索引。当原始影像为1个波段时，不需要设置。
    
    参数:
    
    value - 红色波段索引
    
    返回:
    
    当前对象
  - getGreenBand
```
public int getGreenBand()
```
    返回绿色波段索引
    
    返回:
    
    绿色波段索引
  - setGreenBand
```
public ImageStretchParameter setGreenBand(int value)
```
    设置绿色波段索引。当 ImageStretchParameter.setAdaptivePercent(boolean) 为 true 时且原始影像波段数目大于等于3时，需要设置影像的绿色波段索引。当原始影像为1个波段时，不需要设置。
    
    参数:
    
    value - 绿色波段索引
    
    返回:
    
    当前对象
  - getBlueBand
```
public int getBlueBand()
```
    返回蓝色波段索引
    
    返回:
    
    蓝色波段索引
  - setBlueBand
```
public ImageStretchParameter setBlueBand(int value)
```
    设置蓝色波段索引。当 ImageStretchParameter.setAdaptivePercent(boolean) 为 true 时且原始影像波段数目大于等于3时，需要设置影像的蓝色波段索引。当原始影像为1个波段时，不需要设置。
    
    参数:
    
    value - 蓝色波段索引
    
    返回:
    
    当前对象
  - getHighlightAreaThreshold
```
public double getHighlightAreaThreshold()
```
    返回高亮区域面积阈值
    
    返回:
    
    高亮区域面积阈值
  - setHighlightAreaThreshold
```
public ImageStretchParameter setHighlightAreaThreshold(double value)
```
    设置高亮区域面积阈值。单位为米，当 ImageStretchParameter.setAdaptivePercent(boolean) 为 true 时有效。当使用截断百分比进行影像拉伸时，如果影像的高亮白斑区域面积大于指定面积阈值时，则认为截断百分比过大。否则认为还可以进一步提高截断百分比。默认为20000平方米。如果影像内高亮区域比较少，可以提高此参数，以获取更高的对比度。
    
    参数:
    
    value - 高亮区域面积阈值
    
    返回:
    
    当前对象
  - setIsDisposable
```
public static void setIsDisposable(com.supermap.data.InternalHandleDisposable obj,
                                   boolean disposable)
```

类 ImageStretchParameter

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

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

构造器详细资料

ImageStretchParameter

ImageStretchParameter

方法详细资料

dispose

clone

getStretchingType

setStretchingType

getMinPercent

setMinPercent

getMaxPercent

setMaxPercent

getGamma

setGamma

getNoDataValue

setNoDataValue

getNumOfStd

setNumOfStd

getPixelFormat

setPixelFormat

isAdaptivePercent

setAdaptivePercent

getRedBand

setRedBand

getGreenBand

setGreenBand

getBlueBand

setBlueBand

getHighlightAreaThreshold

setHighlightAreaThreshold

setIsDisposable