DomProject (iObjects Java Help)

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

所有已实现的接口:

IDisposable
```
public class DomProject
extends com.supermap.data.InternalHandleDisposable
```
DOM 工程，输入原始影像（正射影像或RPC影像）进行DOM处理（影像融合、拉伸、对比度增强、植被增强等），得到目标结果影像。

嵌套类概要

嵌套类
限定符和类型类和说明

static class DomProject.Creator
DOM 工程创建类，用于创建DOM工程

static class DomProject.Loader
加载 DOM 工程

嵌套类
限定符和类型	类和说明
`static class`	`DomProject.Creator` DOM 工程创建类，用于创建DOM工程
`static class`	`DomProject.Loader` 加载 DOM 工程

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`DomProject`	`addSteppedListener(SteppedListener l)` 添加进度信息监听对象
`boolean`	`applyParameters()` 应用设置的DOM处理参数。
`void`	`dispose()` 释放对象所占用的资源。
`DomProjectConfig`	`getConfig()` 获取 DOM 工程的配置选项，获取的是副本，修改 DomProjectConfig 中的值对当前 DomProject 无效。
`static DomProject.Creator`	`getCreator()` 获取创建 DOM 工程的对象。
`EnhanceContrastParameter`	`getEnhanceContrastParameter()` 获取对比度增强参数
`EnhanceVegetationParameter`	`getEnhanceVegetationParameter()` 获取植被增强参数
`ImageDehzParameter`	`getImageDehzParameter()` 获取影像去雾参数
`ImageFuseParameter`	`getImageFuseParameter()` 获取影像融合参数
`ImageStretchParameter`	`getImageStretchParameter()` 获取影像拉伸参数
`static DomProject.Loader`	`getLoader()` 获取加载 DOM 工程的对象，每次返回一个新的对象。
`int[]`	`getOutputBands()` 获取输出到结果影像的波段索引
`int`	`getParallelNumber()` 获取影像处理中 CPU 并行线程数目
`ParallelStrategy`	`getParallelStrategy()` 获取影像处理中并行方式。
`String`	`getProjectRootPath()` 获取 DOM 工程的目录
`DatasetRaster`	`getRasterDataset(String packageName)` 根据影像的组名，获取对应的栅格数据集
`DatasetRaster[]`	`getRasterDatasets()` 获取当前 DOM 工程中所有待处理影像的栅格数据集
`InputImagePackage[]`	`getSourceImages()` 获取当前 DOM 工程待处理的影像。
`boolean`	`isEnableEnhanceContrast()` 返回是否进行对比度增强
`boolean`	`isEnableEnhanceVegetation()` 返回是否进行植被增强
`boolean`	`isEnableImageDehz()` 返回是否进行影像去雾
`boolean`	`isEnableImageStretch()` 返回是否进行影像拉伸
`DomProject`	`removeSteppedListener(SteppedListener l)` 移除进度信息监听对象
`String`	`save()` 保存并将 DOM 工程序列化到工程目录中
`DomProject`	`setEnhanceContrastParameter(boolean isEnableEnhanceContrast, EnhanceContrastParameter parameter)` 设置对比度增强参数。
`DomProject`	`setEnhanceVegetationParameter(boolean isEnableEnhanceVegetation, EnhanceVegetationParameter parameter)` 设置植被增强参数。
`DomProject`	`setImageDehzParameter(boolean isEnableImageDehz, ImageDehzParameter parameter)` 设置影像去雾参数。
`DomProject`	`setImageFuseParameter(ImageFuseParameter parameter)` 设置影像融合参数。
`DomProject`	`setImageStretchParameter(boolean isEnableImageStretch, ImageStretchParameter parameter)` 设置影像拉伸参数。
`static void`	`setIsDisposable(com.supermap.data.InternalHandleDisposable obj, boolean disposable)`
`DomProject`	`setOutputBands(int[] bands)` 设置输出到结果的波段索引，波段索引为原始影像的波段的索引，且有严格的先后顺序
`DomProject`	`setParallelNumber(int parallelNumber)` 设置影像处理中 CPU 并行线程数目。
`DomProject`	`setParallelStrategy(ParallelStrategy parallelStrategy)` 设置影像处理并行方式。
`String[]`	`writeImageToFile()` 写出结果到影像文件
`String[]`	`writeImageToFile(DomProjectWriteParameter writeParameter, String outputDirectory, ImageOutputOption outputOption, String[] outputImagePackageNames)` 写出结果到影像文件。
`String[]`	`writeImageToFile(double resolution, boolean isResolutionInMeters, String outputDirectory, ImageOutputOption outputOption)` 写出结果到影像文件

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

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

- 方法详细资料
  - dispose
```
public void dispose()
```
    释放对象所占用的资源。调用该方法之后，此对象不再可用。
  - getCreator
```
public static DomProject.Creator getCreator()
```
    获取创建 DOM 工程的对象。每次返回一个新的对象。
    
    返回:
    
    创建 DOM 工程对象
  - getLoader
```
public static DomProject.Loader getLoader()
```
    获取加载 DOM 工程的对象，每次返回一个新的对象。
    
    返回:
    
    加载 DOM 工程对象
  - save
```
public String save()
```
    保存并将 DOM 工程序列化到工程目录中
    
    返回:
    
    DOM 工程序列化文本信息
  - getProjectRootPath
```
public String getProjectRootPath()
```
    获取 DOM 工程的目录
    
    返回:
    
    DOM 工程目录
  - getConfig
```
public DomProjectConfig getConfig()
```
    获取 DOM 工程的配置选项，获取的是副本，修改 DomProjectConfig 中的值对当前 DomProject 无效。
    
    返回:
    
    DOM 工程的配置选项
  - getSourceImages
```
public InputImagePackage[] getSourceImages()
```
    获取当前 DOM 工程待处理的影像。
    
    返回:
    
    当前 DOM 工程待处理的影像
  - getRasterDatasets
```
public DatasetRaster[] getRasterDatasets()
```
    获取当前 DOM 工程中所有待处理影像的栅格数据集
    
    返回:
    
    所有待处理影像的栅格数据集
  - getRasterDataset
```
public DatasetRaster getRasterDataset(String packageName)
```
    根据影像的组名，获取对应的栅格数据集
    
    参数:
    
    packageName - 影像的组名，具体参考 InputImagePackage.getPackageName()
    
    返回:
    
    栅格数据集
  - writeImageToFile
```
public String[] writeImageToFile()
```
    写出结果到影像文件
    
    返回:
    
    结果影像文件路径列表
  - writeImageToFile
```
public String[] writeImageToFile(double resolution,
                                 boolean isResolutionInMeters,
                                 String outputDirectory,
                                 ImageOutputOption outputOption)
```
    写出结果到影像文件
    
    参数:
    
    resolution - 结果影像空间分辨率
    
    isResolutionInMeters - 空间分辨率单位是否为米。如果为 false，输入的空间分辨率单位与原始影像分辨率单位相同。
    
    outputDirectory - 结果影像目录。如果指定目录为空，则默认将影像写出到工程目录下
    
    outputOption - 影像写出选项
    
    返回:
    
    结果影像文件路径列表
  - writeImageToFile
```
public String[] writeImageToFile(DomProjectWriteParameter writeParameter,
                                 String outputDirectory,
                                 ImageOutputOption outputOption,
                                 String[] outputImagePackageNames)
```
    写出结果到影像文件。可以通过 DomProjectWriteParameter 对象，选择是否输出中间影像。
    
    参数:
    
    writeParameter - 写出影像的参数
    
    outputDirectory - 结果影像目录。如果指定目录为空，则默认将影像写出到工程目录
    
    outputOption - 影像写出选项
    
    outputImagePackageNames - 输出的影像组名，如果为空，则输出所有影像
    
    返回:
    
    结果影像文件路径列表
  - applyParameters
```
public boolean applyParameters()
```
    应用设置的DOM处理参数。当设置或修改了DOM处理参数后，需要调用当前接口应用设置的参数，DOM工程将根据设置的参数计算结果影像信息。
    
    返回:
    
    成功返回true，失败返回false
  - setImageFuseParameter
```
public DomProject setImageFuseParameter(ImageFuseParameter parameter)
```
    设置影像融合参数。只有当 DomProjectConfig.getDomTemplateType() 为 DomTemplateType.FUSE 时才需要设置
    
    参数:
    
    parameter - 影像融合参数
    
    返回:
    
    当前对象
  - getImageFuseParameter
```
public ImageFuseParameter getImageFuseParameter()
```
    获取影像融合参数
    
    返回:
    
    影像融合参数
  - setImageStretchParameter
```
public DomProject setImageStretchParameter(boolean isEnableImageStretch,
                                           ImageStretchParameter parameter)
```
    设置影像拉伸参数。当 isEnableImageStretch 为 true 时，需要设置影像拉伸参数
    
    参数:
    
    isEnableImageStretch - 是否进行影像拉伸
    
    parameter - 影像拉伸参数
    
    返回:
    
    当前对象
  - isEnableImageStretch
```
public boolean isEnableImageStretch()
```
    返回是否进行影像拉伸
    
    返回:
    
    是否进行影像拉伸
  - getImageStretchParameter
```
public ImageStretchParameter getImageStretchParameter()
```
    获取影像拉伸参数
    
    返回:
    
    影像拉伸参数
  - setEnhanceContrastParameter
```
public DomProject setEnhanceContrastParameter(boolean isEnableEnhanceContrast,
                                              EnhanceContrastParameter parameter)
```
    设置对比度增强参数。当 isEnableEnhanceContrast 为 true 时，需要设置对比度增强参数
    
    参数:
    
    isEnableEnhanceContrast - 是否进行对比度增强
    
    parameter - 对比度增强参数
    
    返回:
    
    当前对象
  - isEnableEnhanceContrast
```
public boolean isEnableEnhanceContrast()
```
    返回是否进行对比度增强
    
    返回:
    
    是否进行对比度增强
  - getEnhanceContrastParameter
```
public EnhanceContrastParameter getEnhanceContrastParameter()
```
    获取对比度增强参数
    
    返回:
    
    对比度增强参数
  - setEnhanceVegetationParameter
```
public DomProject setEnhanceVegetationParameter(boolean isEnableEnhanceVegetation,
                                                EnhanceVegetationParameter parameter)
```
    设置植被增强参数。当 isEnableEnhanceVegetation 为 true 时，需要设置植被增强参数
    
    参数:
    
    isEnableEnhanceVegetation - 是否进行植被增强
    
    parameter - 植被增强参数
    
    返回:
    
    当前对象
  - isEnableEnhanceVegetation
```
public boolean isEnableEnhanceVegetation()
```
    返回是否进行植被增强
    
    返回:
    
    是否进行植被增强
  - getEnhanceVegetationParameter
```
public EnhanceVegetationParameter getEnhanceVegetationParameter()
```
    获取植被增强参数
    
    返回:
    
    植被增强参数
  - setImageDehzParameter
```
public DomProject setImageDehzParameter(boolean isEnableImageDehz,
                                        ImageDehzParameter parameter)
```
    设置影像去雾参数。当 isEnableImageDehz 为 true 时，需要设置影像去雾参数
    
    参数:
    
    isEnableImageDehz - 是否进行影像去雾
    
    parameter - 影像去雾参数
    
    返回:
    
    当前对象
  - isEnableImageDehz
```
public boolean isEnableImageDehz()
```
    返回是否进行影像去雾
    
    返回:
    
    是否进行影像去雾
  - getImageDehzParameter
```
public ImageDehzParameter getImageDehzParameter()
```
    获取影像去雾参数
    
    返回:
    
    影像去雾参数
  - setOutputBands
```
public DomProject setOutputBands(int[] bands)
```
    设置输出到结果的波段索引，波段索引为原始影像的波段的索引，且有严格的先后顺序
    
    参数:
    
    bands - 波段索引
    
    返回:
    
    当前对象
  - getOutputBands
```
public int[] getOutputBands()
```
    获取输出到结果影像的波段索引
    
    返回:
    
    输出到结果影像的波段索引
  - setParallelNumber
```
public DomProject setParallelNumber(int parallelNumber)
```
    设置影像处理中 CPU 并行线程数目。当小于等于0时，并行数目为当前计算机的所有逻辑处理器数目。
    
    参数:
    
    parallelNumber - 并行数目。
    
    返回:
    
    当前对象
  - getParallelNumber
```
public int getParallelNumber()
```
    获取影像处理中 CPU 并行线程数目
    
    返回:
    
    影像处理中 CPU 并行线程数目
  - setParallelStrategy
```
public DomProject setParallelStrategy(ParallelStrategy parallelStrategy)
```
    设置影像处理并行方式。如果存放原始影像或写出结果影像的磁盘性能较低（例如机械硬盘），建议使用块并行，如果磁盘性能较高，建议使用文件并行。
    
    参数:
    
    parallelStrategy - 并行处理方式
    
    返回:
    
    当前对象
  - getParallelStrategy
```
public ParallelStrategy getParallelStrategy()
```
    获取影像处理中并行方式。
    
    返回:
    
    影像处理并行方式
  - addSteppedListener
```
public DomProject addSteppedListener(SteppedListener l)
```
    添加进度信息监听对象
    
    参数:
    
    l - 进度信息监听对象
  - removeSteppedListener
```
public DomProject removeSteppedListener(SteppedListener l)
```
    移除进度信息监听对象
    
    参数:
    
    l - 进度信息监听对象
  - setIsDisposable
```
public static void setIsDisposable(com.supermap.data.InternalHandleDisposable obj,
                                   boolean disposable)
```

类 DomProject

嵌套类概要

方法概要

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

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

方法详细资料

dispose

getCreator

getLoader

save

getProjectRootPath

getConfig

getSourceImages

getRasterDatasets

getRasterDataset

writeImageToFile

writeImageToFile

writeImageToFile

applyParameters

setImageFuseParameter

getImageFuseParameter

setImageStretchParameter

isEnableImageStretch

getImageStretchParameter

setEnhanceContrastParameter

isEnableEnhanceContrast

getEnhanceContrastParameter

setEnhanceVegetationParameter

isEnableEnhanceVegetation

getEnhanceVegetationParameter

setImageDehzParameter

isEnableImageDehz

getImageDehzParameter

setOutputBands

getOutputBands

setParallelNumber

getParallelNumber

setParallelStrategy

getParallelStrategy

addSteppedListener

removeSteppedListener

setIsDisposable