GDALWarpOptions Struct Reference

#include <gdalwarper.h>

List of all members.

Public Attributes

char ** papszWarpOptions
double dfWarpMemoryLimit
GDALResampleAlg eResampleAlg
GDALDataType eWorkingDataType
GDALDatasetH hSrcDS
GDALDatasetH hDstDS
int nBandCount
int * panSrcBands
int * panDstBands
int nSrcAlphaBand
int nDstAlphaBand
double * padfSrcNoDataReal
double * padfSrcNoDataImag
double * padfDstNoDataReal
double * padfDstNoDataImag
GDALProgressFunc pfnProgress
void * pProgressArg
GDALTransformerFunc pfnTransformer
void * pTransformerArg
GDALMaskFunc * papfnSrcPerBandValidityMaskFunc
void ** papSrcPerBandValidityMaskFuncArg
GDALMaskFunc pfnSrcValidityMaskFunc
void * pSrcValidityMaskFuncArg
GDALMaskFunc pfnSrcDensityMaskFunc
void * pSrcDensityMaskFuncArg
GDALMaskFunc pfnDstDensityMaskFunc
void * pDstDensityMaskFuncArg
GDALMaskFunc pfnDstValidityMaskFunc
void * pDstValidityMaskFuncArg
CPLErr(* pfnPreWarpChunkProcessor )(void *pKern, void *pArg)
void * pPreWarpProcessorArg
CPLErr(* pfnPostWarpChunkProcessor )(void *pKern, void *pArg)
void * pPostWarpProcessorArg


Detailed Description

Warp control options for use with GDALWarpOperation::Initialize()


Member Data Documentation

double GDALWarpOptions::dfWarpMemoryLimit

In bytes, 0.0 for internal default

GDALResampleAlg GDALWarpOptions::eResampleAlg

Resampling algorithm to use

GDALDataType GDALWarpOptions::eWorkingDataType

data type to use during warp operation, GDT_Unknown lets the algorithm select the type

GDALDatasetH GDALWarpOptions::hDstDS

Destination image dataset - may be NULL if only using GDALWarpOperation::WarpRegionToBuffer().

GDALDatasetH GDALWarpOptions::hSrcDS

Source image dataset.

int GDALWarpOptions::nBandCount

Number of bands to process, may be 0 to select all bands.

int GDALWarpOptions::nDstAlphaBand

The dest. band so use as an alpha (transparency) value, 0=disabled

int GDALWarpOptions::nSrcAlphaBand

The source band so use as an alpha (transparency) value, 0=disabled

double* GDALWarpOptions::padfDstNoDataImag

The "nodata" value imaginary component - may be NULL even if real component is provided.

double* GDALWarpOptions::padfDstNoDataReal

The "nodata" value real component for each output band, if NULL there isn't one

double* GDALWarpOptions::padfSrcNoDataImag

The "nodata" value imaginary component - may be NULL even if real component is provided.

double* GDALWarpOptions::padfSrcNoDataReal

The "nodata" value real component for each input band, if NULL there isn't one

int* GDALWarpOptions::panDstBands

The band numbers for the destination bands to process (1 based)

int* GDALWarpOptions::panSrcBands

The band numbers for the source bands to process (1 based)

char ** GDALWarpOptions::papszWarpOptions

A string list of additional options controlling the warp operation in name=value format. A suitable string list can be prepared with CSLSetNameValue().

The following values are currently supported:

Normally when computing the source raster data to load to generate a particular output area, the warper samples transforms 21 points along each edge of the destination region back onto the source file, and uses this to compute a bounding window on the source image that is sufficient. Depending on the transformation in effect, the source window may be a bit too small, or even missing large areas. Problem situations are those where the transformation is very non-linear or "inside out". Examples are transforming from WGS84 to Polar Steregraphic for areas around the pole, or transformations where some of the image is untransformable. The following options provide some additional control to deal with errors in computing the source window:

GDALProgressFunc GDALWarpOptions::pfnProgress

GDALProgressFunc() compatible progress reporting function, or NULL if there isn't one.

GDALTransformerFunc GDALWarpOptions::pfnTransformer

Type of spatial point transformer function

void* GDALWarpOptions::pProgressArg

Callback argument to be passed to pfnProgress.

void* GDALWarpOptions::pTransformerArg

Handle to image transformer setup structure


The documentation for this struct was generated from the following files:
Generated for GDAL by doxygen 1.4.7.