对raster对象进行裁剪操作。

语法

bytea ST_Clip(raster raster_obj,integer pyramidLevel,  box extent, BoxType boxType);
bytea ST_Clip(raster raster_obj,integer pyramidLevel,  box extent, BoxType boxType, integer destSrid);
record ST_Clip(raster raster_obj,
                     geometry geom,
                     integer pyramidLevel default 0,
                     cstring bands default '',
                     float8[] nodata default NULL,
                     cstring clipOption default '',
                     cstring storageOption default '',
                     out box outwindow,
                     out bytea rasterblob)

参数

参数名称描述
raster_obj需要裁剪的raster对象。
pyramidLevel金字塔层级。
extent需要裁剪的范围，格式为'((minX,minY),(maxX,maxY))'。
boxType范围的类型，只能是以下一种：
  • Raster （像元坐标）
  • World （世界坐标）
destSrid指定输出像元子集的空间参考值。
geom需要裁剪的geometry对象。
bands需要裁剪的波段，用'0-2'或者‘1,2,3’这种形式表示，以0开始。 默认为'', 表示裁剪所有的波段。
nodata用float8[]表示的nodata数值。 如果数值个数少于波段数量，则使用波段设置的nodata值填充。如果波段未设置nodata，则用0填充。
clipOption表示裁剪选项。
storageOption表示返回结果的存储选项。
outwindow表示结果raster对象的大小。
rasterblob表示二进制像素矩阵。

clipOption参数如下。

参数名称类型默认值描述
window_clipboolfalse是否使用geometry的外包框进行裁剪。取值：
  • true：使用geometry的MBR裁剪。
  • false：使用geometry对象裁剪。
rast_coordboolfalse传入的geometry是否使用的是象元坐标。如果是象元坐标，横坐标x表示象元的列号（起始为0），纵坐标y表示象元的行号（起始为0）。

storageOption参数如下。

参数名称类型默认值描述
compressionstringlz4压缩算法类型。取值：
  • none
  • jpeg
  • zlib
  • png
  • lzo
  • lz4
qualityinteger75压缩质量，只针对jpeg压缩算法。
interleavingstring和原始raster一致交错方式。取值：
  • bip：Band interleaved by pixel。
  • bil：Band interleaved by pixel。
  • bsq：Band Sequential。
endianstring和原始raster一致字节序。取值：
  • NDR：Little endian。
  • XDR：Big endian。

描述

默认的裁剪缓存为100 MB，代表最多只能裁剪出100 MB大小的结果数据，如果需要调整返回结果大小，可使用参数ganos.raster.clip_max_buffer_size设置缓存的大小。

示例

DO $$
declare
    rast raster;
begin
    select raster_obj into rast from raster_table where id = 1;
    Select ST_Clip(rast, 0, '((128.980,30.0),(129.0,30.2))', 'World');
end;    
$$ LANGUAGE 'plpgsql';