第一部分:GDAL DEVELOPER GUIDE
翻译:柴树杉(chaishushan@gmail.com)
原文:http://www.gdal.org/gdal_tutorial.html
1. GDAL API 入门
1.1. 打开文件
在打开 GDAL 所支持的光栅数据之前需要注册驱动。这里的驱动是针对 GDAL 支持
的所有 数据格式。通常可以通过调用 GDALAllRegister() 函数来注册所有已知
的驱动,同时 也包含那些用 GDALDriverManager::AutoLoadDrivers() 从.so
文件中自动装载驱动。 如果程序需要对某些驱动做限制,可以参考
gdalallregister.cpp 代码。
当驱动被注册之后,我们就可以用 GDALOpen() 函数来打开一个数据集。打开的
方式 可以是 GA_ReadOnly 或者 GA_Update。
In C++:
#include "gdal_priv.h"
int main()
{
GDALDataset
*poDataset;
GDALAllRegister();
poDataset = (GDALDataset *) GDALOpen( pszFilename, GA_ReadOnly );
if( poDataset == NULL )
{
...;
}
In C:
#include "gdal.h"
int main()
{
GDALDatasetH
hDataset;
GDALAllRegister();
hDataset = GDALOpen( pszFilename, GA_ReadOnly );
if( hDataset == NULL )
{
...;
}
In Python:
import gdal
from gdalconst import *
dataset = gdal.Open( filename, GA_ReadOnly )
if dataset is None:
...
如果 GDALOpen() 函数返回 NULL 则表示打开失败,同时 CPLError() 函数产生
相应的错误信息。 如果您需要对错误进行处理可以参考 CPLError() 相关文档。
通常情况下,所有的 GDAL 函数都通过 CPLError()报 告错误。另外需要注意的
是 pszFilename 并不一定对应一个 实际的文件名(当然也可以就是一个文件
名)。它的具体解释由相应的驱动程序负责。 它可能是一个 URL,或者是文件
名以后后面带有许多用于控制打开方式的参数。通常建议, 不要在打开文件的
选择对话框中对文件的类型做太多的限制。
1.2. 获取 Dataset 信息
如果 GDAL 数据模型一节所描述的,一个 GDALDataset 包含了光栅数据的一系列
的波段信息。 同时它还包含元数据、一个坐标系统、投影类型、光栅的大小以
及其他许多信息。
adfGeoTransform[0] /* 左上角 x */
adfGeoTransform[1] /* 东西方向一个像素对应的距离 */
adfGeoTransform[2] /* 旋转, 0 表示上面为北方 */
adfGeoTransform[3] /* 左上角 y */
adfGeoTransform[4] /* 旋转, 0 表示上面为北方 */
adfGeoTransform[5] /* 南北方向一个像素对应的距离 */
如果需要输出 dataset 的基本信息,可以这样:
In C++:
double
adfGeoTransform[6];
printf( "Driver: %s/%s\n",
poDataset->GetDriver()->GetDescription(),
poDataset->GetDriver()->GetMetadataItem( GDAL_DMD_LONGNAME ) );
printf( "Size is %dx%dx%d\n",
poDataset->GetRasterXSize(), poDataset->GetRasterYSize(),
poDataset->GetRasterCount() );
if( poDataset->GetProjectionRef()
!= NULL )
printf( "Projection is `%s'\n",
poDataset->GetProjectionRef() );
if( poDataset->GetGeoTransform( adfGeoTransform ) == CE_None )
{
printf( "Origin = (%.6f,%.6f)\n",
adfGeoTransform[0], adfGeoTransform[3] );
printf( "Pixel Size = (%.6f,%.6f)\n",
adfGeoTransform[1], adfGeoTransform[5] );
}
In C:
GDALDriverH
double
hDriver;
adfGeoTransform[6];
hDriver = GDALGetDatasetDriver( hDataset );
printf( "Driver: %s/%s\n",
GDALGetDriverShortName( hDriver ),
GDALGetDriverLongName( hDriver ) );
printf( "Size is %dx%dx%d\n",
GDALGetRasterXSize( hDataset ),
GDALGetRasterYSize( hDataset ),
GDALGetRasterCount( hDataset ) );
if( GDALGetProjectionRef( hDataset ) != NULL )
printf( "Projection is `%s'\n",
GDALGetProjectionRef( hDataset ) );
if( GDALGetGeoTransform( hDataset, adfGeoTransform ) == CE_None )
{
printf( "Origin = (%.6f,%.6f)\n",
adfGeoTransform[0], adfGeoTransform[3] );
printf( "Pixel Size = (%.6f,%.6f)\n",
adfGeoTransform[1], adfGeoTransform[5] );
}
In Python:
print 'Driver: ', dataset.GetDriver().ShortName,'/', \
dataset.GetDriver().LongName
print 'Size is ',dataset.RasterXSize,'x',dataset.RasterYSize, \
'x',dataset.RasterCount
print 'Projection is ',dataset.GetProjection()
geotransform = dataset.GetGeoTransform()
if not geotransform is None:
print 'Origin = (',geotransform[0], ',',geotransform[3],')'
print 'Pixel Size = (',geotransform[1], ',',geotransform[5],')'
1.3. 获取一个光栅波段
现在,我们可以通过 GDAL 获取光栅的一个波段。同样每个波段含有元数据、块
大小、 颜色表以前其他一些信息。下面的代码从 dataset 获取一个
GDALRasterBand 对象, 并且显示它的一些信息。
In C++:
GDALRasterBand
int
int
double
*poBand;
nBlockXSize, nBlockYSize;
bGotMin, bGotMax;
adfMinMax[2];
poBand = poDataset->GetRasterBand( 1 );
poBand->GetBlockSize( &nBlockXSize, &nBlockYSize );
printf( "Block=%dx%d Type=%s, ColorInterp=%s\n",
nBlockXSize, nBlockYSize,
GDALGetDataTypeName(poBand->GetRasterDataType()),
GDALGetColorInterpretationName(
poBand->GetColorInterpretation()) );
adfMinMax[0] = poBand->GetMinimum( &bGotMin );
adfMinMax[1] = poBand->GetMaximum( &bGotMax );
if( ! (bGotMin && bGotMax) )
GDALComputeRasterMinMax((GDALRasterBandH)poBand, TRUE,
adfMinMax);
printf( "Min=%.3fd, Max=%.3f\n", adfMinMax[0], adfMinMax[1] );
if( poBand->GetOverviewCount() > 0 )
printf( "Band has %d overviews.\n",
poBand->GetOverviewCount() );
if( poBand->GetColorTable() != NULL )
printf( "Band has a color table with %d entries.\n",
poBand->GetColorTable()->GetColorEntryCount() );
In C:
GDALRasterBandH hBand;
int
int
double
nBlockXSize, nBlockYSize;
bGotMin, bGotMax;
adfMinMax[2];
hBand = GDALGetRasterBand( hDataset, 1 );
GDALGetBlockSize( hBand, &nBlockXSize, &nBlockYSize );
printf( "Block=%dx%d Type=%s, ColorInterp=%s\n",
nBlockXSize, nBlockYSize,
GDALGetDataTypeName(GDALGetRasterDataType(hBand)),
GDALGetColorInterpretationName(
GDALGetRasterColorInterpretation(hBand)) );
adfMinMax[0] = GDALGetRasterMinimum( hBand, &bGotMin );
adfMinMax[1] = GDALGetRasterMaximum( hBand, &bGotMax );
if( ! (bGotMin && bGotMax) )
GDALComputeRasterMinMax( hBand, TRUE, adfMinMax );
printf( "Min=%.3fd, Max=%.3f\n", adfMinMax[0], adfMinMax[1] );
if( GDALGetOverviewCount(hBand) > 0 )
printf( "Band has %d overviews.\n",
GDALGetOverviewCount(hBand));
if( GDALGetRasterColorTable( hBand ) != NULL )
printf( "Band has a color table with %d entries.\n",
GDALGetColorEntryCount(
GDALGetRasterColorTable( hBand ) ) );
In Python:
band = dataset.GetRasterBand(1)
print 'Band Type=',gdal.GetDataTypeName(band.DataType)
min = band.GetMinimum()
max = band.GetMaximum()
if min is not None and max is not None:
(min,max) = ComputeRasterMinMax(1)
print 'Min=%.3f, Max=%.3f' % (min,max)
if band.GetOverviewCount() > 0:
print 'Band has ', band.GetOverviewCount(), ' overviews.'
if not band.GetRasterColorTable() is None:
print 'Band has a color table with ', \
band.GetRasterColorTable().GetCount(), ' entries.'
1.4. 读光栅数据
GDAL 有几种读光栅数据的方法,但是 GDALRasterBand::RasterIO()是最常用的
一种。 该函数可以自动转换数据类型、采样以及裁剪。下面的代码读光栅的第
1 行数据, 同时转换为 float 保存到缓冲。
In C++:
In C:
float *pafScanline;
int
nXSize = poBand->GetXSize();
pafScanline = (float *) CPLMalloc(sizeof(float)*nXSize);
poBand->RasterIO( GF_Read, 0, 0, nXSize, 1,
pafScanline, nXSize, 1, GDT_Float32,
0, 0 );
float *pafScanline;
int
nXSize = GDALGetRasterBandXSize( hBand );
pafScanline = (float *) CPLMalloc(sizeof(float)*nXSize);
GDALRasterIO( hBand, GF_Read, 0, 0, nXSize, 1,
pafScanline, nXSize, 1, GDT_Float32,
0, 0 );
In Python:
scanline = band.ReadRaster( 0, 0, band.XSize, 1, \
band.XSize, 1, GDT_Float32 )
返回的是一个 string,包含了 xsize*4 大小的二进制数据,是 float 类型指针。
可以使用 python 的 struct 模块转换为 python 数据类型:
import struct
tuple_of_floats = struct.unpack('f' * b2.XSize, scanline)
RasterIO 函数的完整说明如下:
CPLErr GDALRasterBand::RasterIO( GDALRWFlag eRWFlag,
nYSize,
nBufYSize,
int nXOff, int nYOff, int nXSize, int
void * pData, int nBufXSize, int
GDALDataType eBufType,
int nPixelSpace,
int nLineSpace )
RasterIO()可以通过指定 eRWFlag 参数来确定是读/写数据(GF_Read 或
GF_Write)。 参数 nXOff/nYOff/nXSize/nYSize 描述了要读的影象范围(或者
是写)。同时它也可以 自动处理边界等特殊情况。
参数 pData 指定读/写对应的缓冲。缓冲的类型必须是 eBufType 中定义的, 例
如 GDT_Float32、GDT_Byte 等。RasterIO ()会自动转换缓冲和波段的类型, 使
它们一致。当数据向下转换时,或者是数据超出转换后的数据类型可以表示的范
围时, 将会用最接近的数据来代替。例如一个 16 位的整数被转换为 GDT_Byte
时,所有大于 255 的 值都会用 255 代替(数据并不会被缩放)。
参数 nBufXSize 和 nBufYSize 描述了缓冲的大小。当时读写是是全部数据时,该
值和影象的大小相同。当需要对影象抽样的时候,缓冲也可以比真实的影象小。
因此,利用 RasterIO()实现预览功能是很方便的。
参数 nPixelSpace 和 nLineSpace 通常被设置为 0。当然,也可以使用他们来控
制内存中的数据。 关闭 Dataset
需要强调的一点是:GDALRasterBand 对象属于相应的 dataset,用户不能私自
delete 任何 GDALRasterBand 对象。GDALDataset 可以用 GDALClose()关闭数据,
或者是直接 delete GDALDataset 对象。关闭 GDALDataset 的时候会进行相关的
清除操作和刷新一些写操作。
1.5. 创建文件的技巧
如果相应格式的驱动支持写操作的话,则可以创建文件。GDAL 有两函数可以创
建文件: CreateCopy()和 Create()。 CreateCopy()函数直接从参数给定的数
据集复制数据。 Create()函数则需要用户明确地写入各种数据(元数据、光栅
数据等)。所有支持创建 的格式驱动都支持 CreateCopy()函数,但是并不一定
支持 Create()函数。
为了确定数据格式是否支持 Create 或 CreateCopy,可以检查驱动对象中的
DCAP_CREATE 和 DCAP_CREATECOPY 元数据。在使用 GetDriverByName()函数之前
确保 GDALAllRegister() 已经被调用过。
In C++:
#include "cpl_string.h"
...
const char *pszFormat = "GTiff";
GDALDriver *poDriver;
char **papszMetadata;
poDriver = GetGDALDriverManager()->GetDriverByName(pszFormat);
if( poDriver == NULL )
exit( 1 );
papszMetadata = poDriver->GetMetadata();
if( CSLFetchBoolean( papszMetadata, GDAL_DCAP_CREATE, FALSE ) )
printf( "Driver %s supports Create() method.\n", pszFormat );
if( CSLFetchBoolean( papszMetadata, GDAL_DCAP_CREATECOPY, FALSE ) )
printf( "Driver %s supports CreateCopy() method.\n",
pszFormat );
In C:
#include "cpl_string.h"
...
const char *pszFormat = "GTiff";
GDALDriver hDriver = GDALGetDriverByName( pszFormat );
char **papszMetadata;
if( hDriver == NULL )
exit( 1 );
papszMetadata = GDALGetMetadata( hDriver, NULL );
if( CSLFetchBoolean( papszMetadata, GDAL_DCAP_CREATE, FALSE ) )
printf( "Driver %s supports Create() method.\n", pszFormat );
if( CSLFetchBoolean( papszMetadata, GDAL_DCAP_CREATECOPY, FALSE ) )