ComposeTrueColorParameter (iObjects Java Help)

java.lang.Object
- com.supermap.image.processing.ComposeTrueColorParameter

public class ComposeTrueColorParameter
extends Object

合成真彩色影像参数类

构造器概要

构造器
构造器和说明

ComposeTrueColorParameter()
构造参数

构造器
构造器和说明
`ComposeTrueColorParameter()` 构造参数

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`int`	`getBlueBand()`
`double`	`getClipLimit()`
`int`	`getGreenBand()`
`double`	`getGreenWeight()`
`double`	`getHighLightAreaThreshold()`
`double`	`getNDVIThreshold()`
`int`	`getNirBand()`
`double`	`getNirWeight()`
`double`	`getPercent()`
`int`	`getRedBand()`
`boolean`	`isAdaptivePercent()`
`boolean`	`isEnhanceContrast()`
`boolean`	`isEnhanceVegetation()`
`ComposeTrueColorParameter`	`setAdaptivePercent(boolean value)` 设置是否自动计算线性拉伸截断百分比。
`ComposeTrueColorParameter`	`setBlueBand(int blueBand)` 设置蓝色波段索引
`ComposeTrueColorParameter`	`setClipLimit(double value)` 设置对比度限制参数，该参数为对比度限制参数又叫裁剪阈值，表示对比度增强的程度，该参数不应过大。
`ComposeTrueColorParameter`	`setEnhanceContrast(boolean value)` 设置是否增强对比度。
`ComposeTrueColorParameter`	`setEnhanceVegetation(boolean value)` 设置是否增强植被。
`ComposeTrueColorParameter`	`setGreenBand(int greenBand)` 设置绿色波段索引
`ComposeTrueColorParameter`	`setGreenWeight(double greenWeight)` 当进行植被增强时，绿色波段的权重值。
`ComposeTrueColorParameter`	`setHighLightAreaThreshold(double value)` 设置高亮区域面积阈值。
`ComposeTrueColorParameter`	`setNDVIThreshold(double value)` 设置 NDVI 阈值。
`ComposeTrueColorParameter`	`setNirBand(int nirBand)` 设置近红外波段索引，当使用植被增强时，需要设置正确的近红外波段索引
`ComposeTrueColorParameter`	`setNirWeight(double nirWeight)` 当进行植被增强时，近红外波段的权重值。
`ComposeTrueColorParameter`	`setPercent(double value)` 设置线性拉伸截断百分比。
`ComposeTrueColorParameter`	`setRedBand(int redBand)` 设置红色波段索引

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

- 构造器详细资料
  - ComposeTrueColorParameter
```
public ComposeTrueColorParameter()
```
    构造参数
- 方法详细资料
  - getRedBand
```
public int getRedBand()
```
    返回:
    
    返回红色波段索引，默认为2
  - setRedBand
```
public ComposeTrueColorParameter setRedBand(int redBand)
```
    设置红色波段索引
    
    参数:
    
    redBand - 红色波段索引
    
    返回:
    
    当前对象
  - getGreenBand
```
public int getGreenBand()
```
    返回:
    
    返回绿色波段索引，默认为 1
  - setGreenBand
```
public ComposeTrueColorParameter setGreenBand(int greenBand)
```
    设置绿色波段索引
    
    参数:
    
    greenBand - 绿色波段索引
    
    返回:
    
    当前对象
  - getBlueBand
```
public int getBlueBand()
```
    返回:
    
    返回蓝色波段索引，默认为 0
  - setBlueBand
```
public ComposeTrueColorParameter setBlueBand(int blueBand)
```
    设置蓝色波段索引
    
    参数:
    
    blueBand - 蓝色波段索引
    
    返回:
    
    当前对象
  - getNirBand
```
public int getNirBand()
```
    返回:
    
    返回近红外波段索引，默认为 3
  - setNirBand
```
public ComposeTrueColorParameter setNirBand(int nirBand)
```
    设置近红外波段索引，当使用植被增强时，需要设置正确的近红外波段索引
    
    参数:
    
    nirBand - 近红外波段索引
    
    返回:
  - isAdaptivePercent
```
public boolean isAdaptivePercent()
```
    返回:
    
    是否自动计算线性拉伸截断百分比，默认为 false
  - setAdaptivePercent
```
public ComposeTrueColorParameter setAdaptivePercent(boolean value)
```
    设置是否自动计算线性拉伸截断百分比。当使用自动计算截断百分比时，设置的 percent 值无效。注意，当用户输入影像数据为融合结果影像，且不带金字塔时，自动计算线性截断百分比会花费一些时间，建议提前创建金字塔影像
    
    参数:
    
    value - 否自动计算线性拉伸截断百分比
    
    返回:
    
    当前对象
  - getPercent
```
public double getPercent()
```
    返回:
    
    线性拉伸截断百分比值，默认值为0.5
  - setPercent
```
public ComposeTrueColorParameter setPercent(double value)
```
    设置线性拉伸截断百分比。合成真彩色影像使用截断线性拉伸，用户可以自定义截断比值。当设置自动计算截断百分比时，该设置的值无效。
    
    参数:
    
    value - 线性拉伸截断百分比值
    
    返回:
    
    当前对象
  - isEnhanceVegetation
```
public boolean isEnhanceVegetation()
```
    返回:
    
    返回是否增强植被，默认为 false
  - setEnhanceVegetation
```
public ComposeTrueColorParameter setEnhanceVegetation(boolean value)
```
    设置是否增强植被。增强植被需要4个波段，且必须正确设置近红外波段。
    
    参数:
    
    value - 是否增强植被
    
    返回:
    
    当前对象
  - getNDVIThreshold
```
public double getNDVIThreshold()
```
    返回:
    
    返回 NDVI 阈值，默认为 0.0
  - setNDVIThreshold
```
public ComposeTrueColorParameter setNDVIThreshold(double value)
```
    设置 NDVI 阈值。在进行植被增强时，使用 NDVI 值进行判断进行植被增强的区域。当计算影像的NDVI 指数大于设定的阈值时才进行增强。小于或等于指定当前设定的阈值时不做处理。 NDVI指数即归一化差异植被指数，通过分析红光和近红外波段的反射率来计算，其计算公式为 NDVI = (NIR-Red)/(NIR+Red),其中，NIR代表近红外波段的反射率，Red代表红光波段的反射率。NDVI的值通常在-1到1之间，较高的正值（接近1）表示健康、密集的植被，较低的正值或负值则表示较少的或无植被。
    
    参数:
    
    value - NDVI 阈值
    
    返回:
    
    当前对象
  - getGreenWeight
```
public double getGreenWeight()
```
    返回:
    
    返回植被增强时绿色波段权重值，默认为 0.7
  - setGreenWeight
```
public ComposeTrueColorParameter setGreenWeight(double greenWeight)
```
    当进行植被增强时，绿色波段的权重值。在进行植被增强时，Out_Green = Green * GreenWeight + Nir * NirWeight，其中 Out_Green 表示绿色波段结果DN值，Green 表示绿色波段原DN值，GreenWeight为绿色波段权重，Nir 表示近红外波段DN值，NirWeight表示近红外波段权重。一般 GreenWeight + NirWeight = 1.0
    
    参数:
    
    greenWeight - 绿色波段权重值
    
    返回:
    
    当前对象
  - getNirWeight
```
public double getNirWeight()
```
    返回:
    
    返回植被增强时近红外波段权重值，默认为 0.3
  - setNirWeight
```
public ComposeTrueColorParameter setNirWeight(double nirWeight)
```
    当进行植被增强时，近红外波段的权重值。参考setGreenWeight
    
    参数:
    
    nirWeight - 近红外波段权重值
    
    返回:
    
    当前对象
  - isEnhanceContrast
```
public boolean isEnhanceContrast()
```
    返回:
    
    返回是否增强对比度，默认为 false
  - setEnhanceContrast
```
public ComposeTrueColorParameter setEnhanceContrast(boolean value)
```
    设置是否增强对比度。当影像的对比度比较低，或者使用自动计算线性截断百分比时，建议进行对比度增强。
    
    参数:
    
    value - 是否进行对比度增强
    
    返回:
  - getClipLimit
```
public double getClipLimit()
```
    返回:
    
    返回对比度限制参数，默认为 2.0
  - setClipLimit
```
public ComposeTrueColorParameter setClipLimit(double value)
```
    设置对比度限制参数，该参数为对比度限制参数又叫裁剪阈值，表示对比度增强的程度，该参数不应过大。对于大部分卫星影像，1.5到2.0之前较为合适
    
    参数:
    
    value - 对比度限制参数
    
    返回:
    
    当前对象
  - getHighLightAreaThreshold
```
public double getHighLightAreaThreshold()
```
    返回:
    
    返回高亮区域面积阈值
  - setHighLightAreaThreshold
```
public ComposeTrueColorParameter setHighLightAreaThreshold(double value)
```
    设置高亮区域面积阈值。单位为米，用于自动计算截断百分比。当使用截断百分比进行影像拉伸时，如果影像的高亮白斑区域面积大于指定面积阈值时，则认为截断百分比过大。否则认为还可以进一步提高截断百分比。默认为20000平方米。如果影像内高亮区域比较少，可以提高此参数，以获取更高的对比度。
    
    参数:
    
    value - 高亮区域面积阈值
    
    返回:
    
    当前对象

类 ComposeTrueColorParameter

构造器概要

方法概要

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

构造器详细资料

ComposeTrueColorParameter

方法详细资料

getRedBand

setRedBand

getGreenBand

setGreenBand

getBlueBand

setBlueBand

getNirBand

setNirBand

isAdaptivePercent

setAdaptivePercent

getPercent

setPercent

isEnhanceVegetation

setEnhanceVegetation

getNDVIThreshold

setNDVIThreshold

getGreenWeight

setGreenWeight

getNirWeight

setNirWeight

isEnhanceContrast

setEnhanceContrast

getClipLimit

setClipLimit

getHighLightAreaThreshold

setHighLightAreaThreshold