Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

gdalwarper.h File Reference

#include "gdal_alg.h"

Go to the source code of this file.

Classes

struct  GDALWarpOptions
class  GDALWarpKernel
class  GDALWarpOperation

Typedefs

typedef int(* GDALMaskFunc )(void *pMaskFuncArg, int nBandCount, GDALDataType eType, int nXOff, int nYOff, int nXSize, int nYSize, GByte **papabyImageData, int bMaskIsFloat, void *pMask)
typedef void * GDALWarpOperationH

Enumerations

enum  GDALResampleAlg { GRA_NearestNeighbour = 0, GRA_Bilinear = 1, GRA_Cubic = 2, GRA_CubicSpline = 3 }

Functions

CPLErr GDALWarpNoDataMasker (void *pMaskFuncArg, int nBandCount, GDALDataType eType, int nXOff, int nYOff, int nXSize, int nYSize, GByte **papabyImageData, int bMaskIsFloat, void *pValidityMask)
GDALWarpOptions * GDALCreateWarpOptions ()
void GDALDestroyWarpOptions (GDALWarpOptions *)
GDALWarpOptions * GDALCloneWarpOptions (const GDALWarpOptions *)
CPLErr GDALReprojectImage (GDALDatasetH hSrcDS, const char *pszSrcWKT, GDALDatasetH hDstDS, const char *pszDstWKT, GDALResampleAlg eResampleAlg, double dfWarpMemoryLimit, double dfMaxError, GDALProgressFunc pfnProgress, void *pProgressArg, GDALWarpOptions *psOptions)
CPLErr GDALCreateAndReprojectImage (GDALDatasetH hSrcDS, const char *pszSrcWKT, const char *pszDstFilename, const char *pszDstWKT, GDALDriverH hDstDriver, char **papszCreateOptions, GDALResampleAlg eResampleAlg, double dfWarpMemoryLimit, double dfMaxError, GDALProgressFunc pfnProgress, void *pProgressArg, GDALWarpOptions *psOptions)
GDALWarpOperationH GDALCreateWarpOperation (const GDALWarpOptions *)
void GDALDestroyWarpOperation (GDALWarpOperationH)
CPLErr GDALChunkAndWarpImage (GDALWarpOperationH, int, int, int, int)
CPLErr GDALChunkAndWarpMulti (GDALWarpOperationH, int, int, int, int)
CPLErr GDALWarpRegion (GDALWarpOperationH, int, int, int, int, int, int, int, int)
CPLErr GDALWarpRegionToBuffer (GDALWarpOperationH, int, int, int, int, void *, GDALDataType, int, int, int, int)

Detailed Description

GDAL warper related entry points and definitions. Eventually it is expected that this file will be mostly private to the implementation, and the public C entry points will be available in gdal_alg.h.

Enumeration Type Documentation

enum GDALResampleAlg
 

Warp Resampling Algorithm

Enumeration values:
GRA_NearestNeighbour  Nearest neighbour (select on one input pixel)
GRA_Bilinear  Bilinear (2x2 kernel)
GRA_Cubic  Cubic Convolution Approximation (4x4 kernel)
GRA_CubicSpline  Cubic B-Spline Approximation (4x4 kernel)

Function Documentation

CPLErr GDALChunkAndWarpImage (  GDALWarpOperationH  hOperation,
int  nDstXOff,
int  nDstYOff,
int  nDstXSize,
int  nDstYSize
) 
 

See also:
GDALWarpOperation::ChunkAndWarpImage()

CPLErr GDALChunkAndWarpMulti (  GDALWarpOperationH  hOperation,
int  nDstXOff,
int  nDstYOff,
int  nDstXSize,
int  nDstYSize
) 
 

See also:
GDALWarpOperation::ChunkAndWarpMulti()

GDALWarpOperationH GDALCreateWarpOperation (  const GDALWarpOptions *  psNewOptions  ) 
 

See also:
GDALWarpOperation::Initialize()

void GDALDestroyWarpOperation (  GDALWarpOperationH  hOperation  ) 
 

See also:
GDALWarpOperation::~GDALWarpOperation()

CPLErr GDALReprojectImage (  GDALDatasetH  hSrcDS,
const char *  pszSrcWKT,
GDALDatasetH  hDstDS,
const char *  pszDstWKT,
GDALResampleAlg  eResampleAlg,
double  dfWarpMemoryLimit,
double  dfMaxError,
GDALProgressFunc  pfnProgress,
void *  pProgressArg,
GDALWarpOptions *  psOptions
) 
 

Reproject image.

This is a convenience function utilizing the GDALWarpOperation class to reproject an image from a source to a destination. In particular, this function takes care of establishing the transformation function to implement the reprojection, and will default a variety of other warp options.

By default all bands are transferred, with no masking or nodata values in effect. No metadata, projection info, or color tables are transferred to the output file.

Parameters:
hSrcDS the source image file.
pszSrcWKT the source projection. If NULL the source projection is read from from hSrcDS.
hDstDS the destination image file.
pszDstWKT the destination projection. If NULL the destination projection will be read from hDstDS.
eResampleAlg the type of resampling to use.
dfWarpMemoryLimit the amount of memory (in bytes) that the warp API is allowed to use for caching. This is in addition to the memory already allocated to the GDAL caching (as per GDALSetCacheMax()). May be 0.0 to use default memory settings.
dfMaxError maximum error measured in input pixels that is allowed in approximating the transformation (0.0 for exact calculations).
pfnProgress a GDALProgressFunc() compatible callback function for reporting progress or NULL.
pProgressArg argument to be passed to pfnProgress. May be NULL.
psOptions warp options, normally NULL.
Returns:
CE_None on success or CE_Failure if something goes wrong.

CPLErr GDALWarpRegion (  GDALWarpOperationH  hOperation,
int  nDstXOff,
int  nDstYOff,
int  nDstXSize,
int  nDstYSize,
int  nSrcXOff,
int  nSrcYOff,
int  nSrcXSize,
int  nSrcYSize
) 
 

See also:
GDALWarpOperation::WarpRegion()

CPLErr GDALWarpRegionToBuffer (  GDALWarpOperationH  hOperation,
int  nDstXOff,
int  nDstYOff,
int  nDstXSize,
int  nDstYSize,
void *  pDataBuf,
GDALDataType  eBufDataType,
int  nSrcXOff,
int  nSrcYOff,
int  nSrcXSize,
int  nSrcYSize
) 
 

See also:
GDALWarpOperation::WarpRegionToBuffer()

Generated on Mon Aug 9 12:09:06 2004 for GDAL by doxygen 1.3.8