com.supermap.data
类 MosaicToolkit

java.lang.Object
  继承者 com.supermap.data.MosaicToolkit

public class MosaicToolkit
extends java.lang.Object

镶嵌数据集工具包。


构造方法摘要
MosaicToolkit()
           
 
方法摘要
static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset, java.lang.String filePath, java.lang.String clipFileType)
          使用清单文件向镶嵌数据集添加文件。
static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset, java.lang.String filePath, java.lang.String clipFileType, java.lang.StringBuilder resultJson)
          使用清单文件向镶嵌数据集添加文件。
static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset, java.lang.String filePath, java.lang.String clipFileType, java.lang.StringBuilder resultJson, MosaicSteppedListener listener)
          使用清单文件向镶嵌数据集添加文件。
static boolean buildPyramid(java.lang.String filePath, PyramidResampleType type)
          已过时。 为指定影像数据创建金字塔。
static java.lang.String checkDatasetMosaic(DatasetMosaic datasetMosaic, boolean outputJsonOrXML)
          检查镶嵌数据集。
static java.lang.String checkDatasetMosaic(DatasetMosaic datasetMosaic, boolean outputJsonOrXML, MosaicSteppedListener listener)
          检查镶嵌数据集。
static int defineOverview(DatasetMosaic datasetMosaic, java.lang.String path, int maxWidth, int maxHeight, int ratio, boolean hasNoValue, double noValue, java.lang.String defineFolder)
          定义镶嵌数据集的概视图(Overview)。
static int defineOverview(DatasetMosaic datasetMosaic, java.lang.String path, int maxWidth, int maxHeight, int ratio, boolean hasNoValue, double noValue, java.lang.String defineFolder, MosaicSteppedListener listener)
          定义镶嵌数据集的概视图(Overview)。
static java.util.HashMap<java.lang.Integer,java.lang.String> getAllFiles(DatasetMosaic datasetMosaic, java.lang.Boolean containsOverviews)
          返回镶嵌数据集中所添加的所有影像信息。
static java.lang.String getFileInfo(java.lang.String filePath)
          返回指定影像文件的信息,如波段数、位深等。
static java.util.HashMap<java.lang.Integer,java.lang.String> getFilesByBounds(DatasetMosaic datasetMosaic, Rectangle2D extractBounds, java.lang.Boolean containsOverviews)
          返回镶嵌数据集指定范围内的所有影像信息。
static java.util.HashMap<java.lang.Integer,java.lang.String> getFilesByGeoRegion(DatasetMosaic datasetMosaic, GeoRegion extractRegion, java.lang.Boolean containsOverviews)
          通过空间查询出与指定对象相交的影像文件。
static MosaicPixelValues getValue(DatasetMosaic datasetMosaic, Point2D point2D)
          返回镶嵌数据集指定点的栅格信息。
static boolean hasPyramid(java.lang.String filePath)
          返回文件是否已创建了金字塔。
 
从类 java.lang.Object 继承的方法
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

MosaicToolkit

public MosaicToolkit()
方法详细信息

getAllFiles

public static java.util.HashMap<java.lang.Integer,java.lang.String> getAllFiles(DatasetMosaic datasetMosaic,
                                                                                java.lang.Boolean containsOverviews)
返回镶嵌数据集中所添加的所有影像信息。

参数:
datasetMosaic - 指定的镶嵌数据集。
containsOverviews - 返回信息是否包含概视图信息。
返回:
返回镶嵌数据集中所添加的所有影像信息。信息为一个字典类,其中的键为图幅ID号,键对应得值为该图幅的影像路径信息。

getFilesByBounds

public static java.util.HashMap<java.lang.Integer,java.lang.String> getFilesByBounds(DatasetMosaic datasetMosaic,
                                                                                     Rectangle2D extractBounds,
                                                                                     java.lang.Boolean containsOverviews)
返回镶嵌数据集指定范围内的所有影像信息。

参数:
datasetMosaic - 指定的镶嵌数据集。
extractBounds - 指定的范围。
containsOverviews - 查询结果是否包含概视图影像文件。
返回:
返回镶嵌数据集指定范围内的所有影像信息。信息为一个字典类,其中的键为图幅ID号,键对应得值为该图幅的影像路径信息。

getFilesByGeoRegion

public static java.util.HashMap<java.lang.Integer,java.lang.String> getFilesByGeoRegion(DatasetMosaic datasetMosaic,
                                                                                        GeoRegion extractRegion,
                                                                                        java.lang.Boolean containsOverviews)
通过空间查询出与指定对象相交的影像文件。

参数:
datasetMosaic - 查询的镶嵌数据集。
extractRegion - 作为查询范围的几何对象。
containsOverviews - 查询结果是否包含概视图影像文件。
返回:
返回通过空间查询出与指定对象相交的影像文件信息。信息为一个字典类,其中的键为图幅ID号,键对应得值为该图幅的影像路径信息。

hasPyramid

public static boolean hasPyramid(java.lang.String filePath)
返回文件是否已创建了金字塔。

参数:
filePath - 指定的影像文件路径。
返回:
返回文件是否已创建了金字塔,true表示建立了金字塔;false表示没有建立金字塔。

buildPyramid

public static boolean buildPyramid(java.lang.String filePath,
                                   PyramidResampleType type)
已过时。 为指定影像数据创建金字塔。

参数:
filePath - 指定的要创建金字塔的影像文件路径。
type - 金字塔重采样方式。
返回:
成功创建返回true;否则返回false。

getValue

public static MosaicPixelValues getValue(DatasetMosaic datasetMosaic,
                                         Point2D point2D)
返回镶嵌数据集指定点的栅格信息。

参数:
datasetMosaic - 指定的镶嵌数据集。
point2D - 指定的点。
返回:
返回镶嵌数据集指定点的栅格信息。

getFileInfo

public static java.lang.String getFileInfo(java.lang.String filePath)
返回指定影像文件的信息,如波段数、位深等。

参数:
filePath - 指定影像文件的全路径。
返回:
返回指定影像文件的信息,如波段数、位深等。

checkDatasetMosaic

public static java.lang.String checkDatasetMosaic(DatasetMosaic datasetMosaic,
                                                  boolean outputJsonOrXML,
                                                  MosaicSteppedListener listener)
检查镶嵌数据集。

参数:
datasetMosaic - 指定待检查的镶嵌数据集。
outputJsonOrXML - 检查结果可以使用JSON或者XML格式化字符串显示。该参数为 true,检查结果输出JSON格式字符串;false,检查结果输出XML格式字符串。
listener - 事件监听,用于获取方法执行的进度与取消操作。
返回:
返回检查结果报告。

checkDatasetMosaic

public static java.lang.String checkDatasetMosaic(DatasetMosaic datasetMosaic,
                                                  boolean outputJsonOrXML)
检查镶嵌数据集。

参数:
datasetMosaic - 指定待检查的镶嵌数据集。
outputJsonOrXML - 检查结果可以使用JSON或者XML格式化字符串显示。该参数为 true,检查结果输出JSON格式字符串;false,检查结果输出XML格式字符串。
返回:
返回检查结果报告。

defineOverview

public static int defineOverview(DatasetMosaic datasetMosaic,
                                 java.lang.String path,
                                 int maxWidth,
                                 int maxHeight,
                                 int ratio,
                                 boolean hasNoValue,
                                 double noValue,
                                 java.lang.String defineFolder)
定义镶嵌数据集的概视图(Overview)。

参数:
datasetMosaic - 指定待定义概视图的镶嵌数据集。
path - 概视图的输出路径。
maxWidth - 每幅概视图影像文件的宽度,单位为像素。
maxHeight - 每幅概视图影像文件的高度,单位为像素。
ratio - 相邻概视图层级间的比率。
hasNoValue - 影像中是否有无值区域。
noValue - 指定无值的具体数值。在生成概视图时,将去除指定的无值。
defineFolder - 概视图定义文件的输出路径。
返回:
成功返回0;否则返回一个非零的错误码。

defineOverview

public static int defineOverview(DatasetMosaic datasetMosaic,
                                 java.lang.String path,
                                 int maxWidth,
                                 int maxHeight,
                                 int ratio,
                                 boolean hasNoValue,
                                 double noValue,
                                 java.lang.String defineFolder,
                                 MosaicSteppedListener listener)
定义镶嵌数据集的概视图(Overview)。

参数:
datasetMosaic - 指定待定义概视图的镶嵌数据集。
path - 概视图的输出路径。
maxWidth - 每幅概视图影像文件的宽度,单位为像素。
maxHeight - 每幅概视图影像文件的高度,单位为像素。
ratio - 相邻概视图层级间的比率。
hasNoValue - 影像中是否有无值区域。
noValue - 指定无值的具体数值。在生成概视图时,将去除指定的无值。
defineFolder - 概视图定义文件的输出路径。
listener - 事件监听,用于获取方法执行的进度与取消操作。
返回:

addMosaicFilesWithFile

public static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset,
                                             java.lang.String filePath,
                                             java.lang.String clipFileType)
使用清单文件向镶嵌数据集添加文件。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。

参数:
sourceDataset - 待添加影像文件的镶嵌数据集。
filePath - 清单文件路径。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。
clipFileType - 用于影像裁剪显示的裁剪区形状文件的扩展名。影像裁剪区的矢量文件类型。影像的裁剪区为影像的有效值范围,若影像有配套的限定其裁剪区的矢量文件,通过指定该参数,影像添加时,将影像的裁剪区将更新到镶嵌数据集的裁剪子数据集中,后续用于去除无值的显示设置。若裁剪区的矢量文件类型为shapefile,该参数值为.shp。
返回:
添加成功返回true;否则,返回false。

addMosaicFilesWithFile

public static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset,
                                             java.lang.String filePath,
                                             java.lang.String clipFileType,
                                             java.lang.StringBuilder resultJson)
使用清单文件向镶嵌数据集添加文件。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。

参数:
sourceDataset - 待添加影像文件的镶嵌数据集。
filePath - 清单文件路径。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。
clipFileType - 用于影像裁剪显示的裁剪区形状文件的扩展名。影像裁剪区的矢量文件类型。影像的裁剪区为影像的有效值范围,若影像有配套的限定其裁剪区的矢量文件,通过指定该参数,影像添加时,将影像的裁剪区将更新到镶嵌数据集的裁剪子数据集中,后续用于去除无值的显示设置。若裁剪区的矢量文件类型为shapefile,该参数值为.shp。
resultJson - 添加结果报告。
返回:
添加成功返回true;否则,返回false。

addMosaicFilesWithFile

public static boolean addMosaicFilesWithFile(DatasetMosaic sourceDataset,
                                             java.lang.String filePath,
                                             java.lang.String clipFileType,
                                             java.lang.StringBuilder resultJson,
                                             MosaicSteppedListener listener)
使用清单文件向镶嵌数据集添加文件。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。

参数:
sourceDataset - 待添加影像文件的镶嵌数据集。
filePath - 清单文件路径。清单文件为一个.txt 文本文件,清单文件中一行记录为一个影像文件的全路径,全路径写法:Linux系统的写法,如:/home/data/images/H48C002002.tif;Windows系统的写法,如: E:\data\imageChina\H48C002002.tif。
clipFileType - 用于影像裁剪显示的裁剪区形状文件的扩展名。影像裁剪区的矢量文件类型。影像的裁剪区为影像的有效值范围,若影像有配套的限定其裁剪区的矢量文件,通过指定该参数,影像添加时,将影像的裁剪区将更新到镶嵌数据集的裁剪子数据集中,后续用于去除无值的显示设置。若裁剪区的矢量文件类型为shapefile,该参数值为.shp。
resultJson - 添加结果报告。
listener - 事件监听,用于获取方法执行的进度与取消操作。
返回:
添加成功返回true;否则,返回false。