My Project
Public Attributes | List of all members
GDALWarpAppOptions Struct Reference

Public Attributes

double dfMinX
 
double dfMinY
 
double dfMaxX
 
double dfMaxY
 
char * pszTE_SRS
 
double dfXRes
 
double dfYRes
 
int bTargetAlignedPixels
 
int nForcePixels
 
int nForceLines
 
int bQuiet
 
GDALProgressFunc pfnProgress
 
void * pProgressData
 
bool bEnableDstAlpha
 
bool bEnableSrcAlpha
 
bool bDisableSrcAlpha
 
char * pszFormat
 
int bCreateOutput
 
char ** papszWarpOptions
 
double dfErrorThreshold
 
double dfWarpMemoryLimit
 
char ** papszCreateOptions
 
GDALDataType eOutputType
 
GDALDataType eWorkingType
 
GDALResampleAlg eResampleAlg
 
char * pszSrcNodata
 
char * pszDstNodata
 
int bMulti
 
char ** papszTO
 
char * pszCutlineDSName
 
char * pszCLayer
 
char * pszCWHERE
 
char * pszCSQL
 
int bCropToCutline
 
int bCopyMetadata
 
int bCopyBandInfo
 
char * pszMDConflictValue
 
bool bSetColorInterpretation
 
int nOvLevel
 
bool bNoVShiftGrid
 

Detailed Description

Options for use with GDALWarp(). GDALWarpAppOptions* must be allocated and freed with GDALWarpAppOptionsNew() and GDALWarpAppOptionsFree() respectively.

Member Data Documentation

◆ bCopyBandInfo

int GDALWarpAppOptions::bCopyBandInfo

copy band information from the first source dataset

◆ bCopyMetadata

int GDALWarpAppOptions::bCopyMetadata

copy dataset and band metadata will be copied from the first source dataset. Items that differ between source datasets will be set "*" (see GDALWarpAppOptions::pszMDConflictValue)

◆ bCropToCutline

int GDALWarpAppOptions::bCropToCutline

crop the extent of the target dataset to the extent of the cutline

◆ bDisableSrcAlpha

bool GDALWarpAppOptions::bDisableSrcAlpha

Prevent a source alpha band from being considered as such

◆ bEnableDstAlpha

bool GDALWarpAppOptions::bEnableDstAlpha

creates an output alpha band to identify nodata (unset/transparent) pixels when set to true

◆ bEnableSrcAlpha

bool GDALWarpAppOptions::bEnableSrcAlpha

forces the last band of an input file to be considered as alpha band.

◆ bMulti

int GDALWarpAppOptions::bMulti

use multithreaded warping implementation. Multiple threads will be used to process chunks of image and perform input/output operation simultaneously.

◆ bNoVShiftGrid

bool GDALWarpAppOptions::bNoVShiftGrid

Whether to disable vertical grid shift adjustment

◆ bQuiet

int GDALWarpAppOptions::bQuiet

allow or suppress progress monitor and other non-error output

◆ bSetColorInterpretation

bool GDALWarpAppOptions::bSetColorInterpretation

set the color interpretation of the bands of the target dataset from the source dataset

◆ bTargetAlignedPixels

int GDALWarpAppOptions::bTargetAlignedPixels

align the coordinates of the extent of the output file to the values of the GDALWarpAppOptions::dfXRes and GDALWarpAppOptions::dfYRes, such that the aligned extent includes the minimum extent.

◆ dfMinX

double GDALWarpAppOptions::dfMinX

set georeferenced extents of output file to be created (in target SRS by default, or in the SRS specified with pszTE_SRS)

◆ dfWarpMemoryLimit

double GDALWarpAppOptions::dfWarpMemoryLimit

the amount of memory (in megabytes) that the warp API is allowed to use for caching.

◆ dfXRes

double GDALWarpAppOptions::dfXRes

set output file resolution (in target georeferenced units)

◆ eOutputType

GDALDataType GDALWarpAppOptions::eOutputType

the data type of the output bands

◆ eResampleAlg

GDALResampleAlg GDALWarpAppOptions::eResampleAlg

the resampling method. Available methods are: near, bilinear, cubic, cubicspline, lanczos, average, mode, max, min, med, q1, q3

◆ eWorkingType

GDALDataType GDALWarpAppOptions::eWorkingType

working pixel data type. The data type of pixels in the source image and destination image buffers.

◆ nForcePixels

int GDALWarpAppOptions::nForcePixels

set output file size in pixels and lines. If GDALWarpAppOptions::nForcePixels or GDALWarpAppOptions::nForceLines is set to 0, the other dimension will be guessed from the computed resolution. Note that GDALWarpAppOptions::nForcePixels and GDALWarpAppOptions::nForceLines cannot be used with GDALWarpAppOptions::dfXRes and GDALWarpAppOptions::dfYRes.

◆ nOvLevel

int GDALWarpAppOptions::nOvLevel

overview level of source files to be used

◆ papszCreateOptions

char** GDALWarpAppOptions::papszCreateOptions

list of create options for the output format driver. See format specific documentation for legal creation options for each format.

◆ papszTO

char** GDALWarpAppOptions::papszTO

list of transformer options suitable to pass to GDALCreateGenImgProjTransformer2(). ("NAME1=VALUE1","NAME2=VALUE2",...)

◆ papszWarpOptions

char** GDALWarpAppOptions::papszWarpOptions

list of warp options. ("NAME1=VALUE1","NAME2=VALUE2",...). The GDALWarpOptions::papszWarpOptions docs show all options.

◆ pfnProgress

GDALProgressFunc GDALWarpAppOptions::pfnProgress

the progress function to use

◆ pProgressData

void* GDALWarpAppOptions::pProgressData

pointer to the progress data variable

◆ pszCLayer

char* GDALWarpAppOptions::pszCLayer

the named layer to be selected from the cutline datasource

◆ pszCSQL

char* GDALWarpAppOptions::pszCSQL

SQL query to select the cutline features instead of from a layer with pszCLayer

◆ pszCutlineDSName

char* GDALWarpAppOptions::pszCutlineDSName

enable use of a blend cutline from the name OGR support pszCutlineDSName

◆ pszCWHERE

char* GDALWarpAppOptions::pszCWHERE

restrict desired cutline features based on attribute query

◆ pszDstNodata

char* GDALWarpAppOptions::pszDstNodata

nodata values for output bands (different values can be supplied for each band). ("value1 value2 ..."). New files will be initialized to this value and if possible the nodata value will be recorded in the output file. Use a value of "None" to ensure that nodata is not defined. If this argument is not used then nodata values will be copied from the source dataset.

◆ pszFormat

char* GDALWarpAppOptions::pszFormat

output format. The default is GeoTIFF (GTiff). Use the short format name.

◆ pszMDConflictValue

char* GDALWarpAppOptions::pszMDConflictValue

value to set metadata items that conflict between source datasets (default is "*"). Use "" to remove conflicting items.

◆ pszSrcNodata

char* GDALWarpAppOptions::pszSrcNodata

nodata masking values for input bands (different values can be supplied for each band). ("value1 value2 ..."). Masked values will not be used in interpolation. Use a value of "None" to ignore intrinsic nodata settings on the source dataset.

◆ pszTE_SRS

char* GDALWarpAppOptions::pszTE_SRS

the SRS in which to interpret the coordinates given in GDALWarpAppOptions::dfMinX, GDALWarpAppOptions::dfMinY, GDALWarpAppOptions::dfMaxX and GDALWarpAppOptions::dfMaxY. The SRS may be any of the usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file containing the WKT. It is a convenience e.g. when knowing the output coordinates in a geodetic long/lat SRS, but still wanting a result in a projected coordinate system.


The documentation for this struct was generated from the following file: