Package osgeo :: Module gdal
[hide private]
[frames] | no frames]

Module gdal

source code

Classes [hide private]
  _swig_property
property(fget=None, fset=None, fdel=None, doc=None) -> property attribute
  _object
  StatBuf
Proxy of C++ StatBuf class
  MajorObject
Proxy of C++ GDALMajorObjectShadow class
  Driver
Proxy of C++ GDALDriverShadow class
  ColorEntry
Proxy of C++ GDALColorEntry class
  GCP
Proxy of C++ GDAL_GCP class
  VirtualMem
Proxy of C++ CPLVirtualMemShadow class
  AsyncReader
Proxy of C++ GDALAsyncReaderShadow class
  Dataset
Proxy of C++ GDALDatasetShadow class
  Band
Proxy of C++ GDALRasterBandShadow class
  ColorTable
Proxy of C++ GDALColorTableShadow class
  RasterAttributeTable
Proxy of C++ GDALRasterAttributeTableShadow class
  Transformer
Proxy of C++ GDALTransformerInfoShadow class
  GDALInfoOptions
Proxy of C++ GDALInfoOptions class
  GDALTranslateOptions
Proxy of C++ GDALTranslateOptions class
  GDALWarpAppOptions
Proxy of C++ GDALWarpAppOptions class
  GDALVectorTranslateOptions
Proxy of C++ GDALVectorTranslateOptions class
  GDALDEMProcessingOptions
Proxy of C++ GDALDEMProcessingOptions class
  GDALNearblackOptions
Proxy of C++ GDALNearblackOptions class
  GDALGridOptions
Proxy of C++ GDALGridOptions class
  GDALRasterizeOptions
Proxy of C++ GDALRasterizeOptions class
  GDALBuildVRTOptions
Proxy of C++ GDALBuildVRTOptions class
Functions [hide private]
 
_swig_setattr_nondynamic(self, class_type, name, value, static=1) source code
 
_swig_setattr(self, class_type, name, value) source code
 
_swig_getattr(self, class_type, name) source code
 
_swig_repr(self) source code
 
deprecation_warn(module) source code
 
RGBFile2PCTFile(src_filename, dst_filename) source code
int
GetUseExceptions() source code
 
UseExceptions() source code
 
DontUseExceptions() source code
 
VSIFReadL(*args)
VSIFReadL(int nMembSize, int nMembCount, VSILFILE fp) -> int
source code
 
_is_str_or_unicode(o) source code
 
InfoOptions(options=[], format='text', deserialize=True, computeMinMax=False, reportHistograms=False, reportProj4=False, stats=False, approxStats=False, computeChecksum=False, showGCPs=True, showMetadata=True, showRAT=True, showColorTable=True, listMDD=False, showFileList=True, allMetadata=False, extraMDDomains=None)
Create a InfoOptions() object that can be passed to gdal.Info() options can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Info(ds, **kwargs)
Return information on a dataset.
source code
 
TranslateOptions(options=[], format='GTiff', outputType=GDT_Unknown, bandList=None, maskBand=None, width=0, height=0, widthPct=0.0, heightPct=0.0, xRes=0.0, yRes=0.0, creationOptions=None, srcWin=None, projWin=None, projWinSRS=None, strict=False, unscale=False, scaleParams=None, exponents=None, outputBounds=None, metadataOptions=None, outputSRS=None, GCPs=None, noData=None, rgbExpand=None, stats=False, rat=True, resampleAlg=None, callback=None, callback_data=None)
Create a TranslateOptions() object that can be passed to gdal.Translate() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Translate(destName, srcDS, **kwargs)
Convert a dataset.
source code
 
WarpOptions(options=[], format='GTiff', outputBounds=None, outputBoundsSRS=None, xRes=None, yRes=None, targetAlignedPixels=False, width=0, height=0, srcSRS=None, dstSRS=None, srcAlpha=False, dstAlpha=False, warpOptions=None, errorThreshold=None, warpMemoryLimit=None, creationOptions=None, outputType=GDT_Unknown, workingType=GDT_Unknown, resampleAlg=None, srcNodata=None, dstNodata=None, multithread=False, tps=False, rpc=False, geoloc=False, polynomialOrder=None, transformerOptions=None, cutlineDSName=None, cutlineLayer=None, cutlineWhere=None, cutlineSQL=None, cutlineBlend=None, cropToCutline=False, copyMetadata=True, metadataConflictValue=None, setColorInterpretation=False, callback=None, callback_data=None)
Create a WarpOptions() object that can be passed to gdal.Warp() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Warp(destNameOrDestDS, srcDSOrSrcDSTab, **kwargs)
Warp one or several datasets.
source code
 
VectorTranslateOptions(options=[], format='ESRI Shapefile', accessMode=None, srcSRS=None, dstSRS=None, reproject=True, SQLStatement=None, SQLDialect=None, where=None, selectFields=None, spatFilter=None, datasetCreationOptions=None, layerCreationOptions=None, layers=None, layerName=None, geometryType=None, dim=None, segmentizeMaxDist=None, zField=None, skipFailures=False, callback=None, callback_data=None)
Create a VectorTranslateOptions() object that can be passed to gdal.VectorTranslate() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
VectorTranslate(destNameOrDestDS, srcDS, **kwargs)
Convert one vector dataset Arguments are : destNameOrDestDS --- Output dataset name or object srcDS --- a Dataset object or a filename Keyword arguments are : options --- return of gdal.InfoOptions(), string or array of strings other keywords arguments of gdal.VectorTranslateOptions() If options is provided as a gdal.VectorTranslateOptions() object, other keywords are ignored.
source code
 
DEMProcessingOptions(options=[], colorFilename=None, format='GTiff', creationOptions=None, computeEdges=False, alg='Horn', band=1, zFactor=None, scale=None, azimuth=None, altitude=None, combined=False, slopeFormat=None, trigonometric=False, zeroForFlat=False, callback=None, callback_data=None)
Create a DEMProcessingOptions() object that can be passed to gdal.DEMProcessing() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
DEMProcessing(destName, srcDS, processing, **kwargs)
Apply a DEM processing.
source code
 
NearblackOptions(options=[], format='GTiff', creationOptions=None, white=False, colors=None, maxNonBlack=None, nearDist=None, setAlpha=False, setMask=False, callback=None, callback_data=None)
Create a NearblackOptions() object that can be passed to gdal.Nearblack() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Nearblack(destNameOrDestDS, srcDS, **kwargs)
Convert nearly black/white borders to exact value.
source code
 
GridOptions(options=[], format='GTiff', outputType=GDT_Unknown, width=0, height=0, creationOptions=None, outputBounds=None, outputSRS=None, noData=None, algorithm=None, layers=None, SQLStatement=None, where=None, spatFilter=None, zfield=None, z_increase=None, z_multiply=None, callback=None, callback_data=None)
Create a GridOptions() object that can be passed to gdal.Grid() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Grid(destName, srcDS, **kwargs)
Create raster from the scattered data.
source code
 
RasterizeOptions(options=[], format=None, creationOptions=None, noData=None, initValues=None, outputBounds=None, outputSRS=None, width=None, height=None, xRes=None, yRes=None, targetAlignedPixels=False, bands=None, inverse=False, allTouched=False, burnValues=None, attribute=None, useZ=False, layers=None, SQLStatement=None, SQLDialect=None, where=None, callback=None, callback_data=None)
Create a RasterizeOptions() object that can be passed to gdal.Rasterize() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords.
source code
 
Rasterize(destNameOrDestDS, srcDS, **kwargs)
Burns vector geometries into a raster Arguments are : destNameOrDestDS --- Output dataset name or object srcDS --- a Dataset object or a filename Keyword arguments are : options --- return of gdal.InfoOptions(), string or array of strings other keywords arguments of gdal.RasterizeOptions() If options is provided as a gdal.RasterizeOptions() object, other keywords are ignored.
source code
 
BuildVRTOptions(options=[], resolution=None, outputBounds=None, xRes=None, yRes=None, targetAlignedPixels=None, separate=None, bandList=None, addAlpha=None, resampleAlg=None, outputSRS=None, allowProjectionDifference=None, srcNodata=None, VRTNodata=None, hideNodata=None, callback=None, callback_data=None)
Create a BuildVRTOptions() object that can be passed to gdal.BuildVRT() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords..
source code
 
BuildVRT(destName, srcDSOrSrcDSTab, **kwargs)
Build a VRT from a list of datasets.
source code
 
Debug(*args)
Debug(char msg_class, char message)
source code
 
SetErrorHandler(*args)
SetErrorHandler(char pszCallbackName = None) -> CPLErr
source code
 
PushErrorHandler(*args)
PushErrorHandler(CPLErrorHandler pfnErrorHandler = None) -> CPLErr
source code
 
PopErrorHandler() source code
 
Error(*args)
Error(CPLErr msg_class = CE_Failure, int err_code = 0, char msg = "error")
source code
 
GOA2GetAuthorizationURL(*args)
GOA2GetAuthorizationURL(char pszScope) -> retStringAndCPLFree
source code
 
GOA2GetRefreshToken(*args)
GOA2GetRefreshToken(char pszAuthToken, char pszScope) -> retStringAndCPLFree
source code
 
GOA2GetAccessToken(*args)
GOA2GetAccessToken(char pszRefreshToken, char pszScope) -> retStringAndCPLFree
source code
 
ErrorReset() source code
 
EscapeString(*args, **kwargs)
EscapeString(int len, int scheme = CPLES_SQL) -> retStringAndCPLFree
source code
int
GetLastErrorNo() source code
int
GetLastErrorType() source code
char
GetLastErrorMsg() source code
int
VSIGetLastErrorNo() source code
char
VSIGetLastErrorMsg() source code
 
PushFinderLocation(*args)
PushFinderLocation(char utf8_path)
source code
 
PopFinderLocation() source code
 
FinderClean() source code
 
FindFile(*args)
FindFile(char pszClass, char utf8_path) -> char
source code
 
ReadDir(*args)
ReadDir(char utf8_path, int nMaxFiles = 0) -> char
source code
 
ReadDirRecursive(*args)
ReadDirRecursive(char utf8_path) -> char
source code
 
SetConfigOption(*args)
SetConfigOption(char pszKey, char pszValue)
source code
 
GetConfigOption(*args)
GetConfigOption(char pszKey, char pszDefault = None) -> char
source code
 
CPLBinaryToHex(*args)
CPLBinaryToHex(int nBytes) -> retStringAndCPLFree
source code
 
CPLHexToBinary(*args)
CPLHexToBinary(char pszHex, int pnBytes) -> GByte
source code
 
FileFromMemBuffer(*args)
FileFromMemBuffer(char utf8_path, int nBytes)
source code
 
Unlink(*args)
Unlink(char utf8_path) -> VSI_RETVAL
source code
int
HasThreadSupport() source code
 
Mkdir(*args)
Mkdir(char utf8_path, int mode) -> VSI_RETVAL
source code
 
Rmdir(*args)
Rmdir(char utf8_path) -> VSI_RETVAL
source code
 
Rename(*args)
Rename(char pszOld, char pszNew) -> VSI_RETVAL
source code
 
VSIStatL(*args)
VSIStatL(char utf8_path, int nFlags = 0) -> int
source code
 
VSIFOpenL(*args)
VSIFOpenL(char utf8_path, char pszMode) -> VSILFILE
source code
 
VSIFOpenExL(*args)
VSIFOpenExL(char utf8_path, char pszMode, int bSetError) -> VSILFILE
source code
 
VSIFCloseL(*args)
VSIFCloseL(VSILFILE fp) -> VSI_RETVAL
source code
 
VSIFSeekL(*args)
VSIFSeekL(VSILFILE fp, GIntBig offset, int whence) -> int
source code
 
VSIFTellL(*args)
VSIFTellL(VSILFILE fp) -> GIntBig
source code
 
VSIFTruncateL(*args)
VSIFTruncateL(VSILFILE fp, GIntBig length) -> int
source code
 
VSIFWriteL(*args)
VSIFWriteL(int nLen, int size, int memb, VSILFILE fp) -> int
source code
 
ParseCommandLine(*args)
ParseCommandLine(char utf8_path) -> char
source code
 
GDAL_GCP_GCPX_get(*args)
GDAL_GCP_GCPX_get(GCP gcp) -> double
source code
 
GDAL_GCP_GCPX_set(*args)
GDAL_GCP_GCPX_set(GCP gcp, double dfGCPX)
source code
 
GDAL_GCP_GCPY_get(*args)
GDAL_GCP_GCPY_get(GCP gcp) -> double
source code
 
GDAL_GCP_GCPY_set(*args)
GDAL_GCP_GCPY_set(GCP gcp, double dfGCPY)
source code
 
GDAL_GCP_GCPZ_get(*args)
GDAL_GCP_GCPZ_get(GCP gcp) -> double
source code
 
GDAL_GCP_GCPZ_set(*args)
GDAL_GCP_GCPZ_set(GCP gcp, double dfGCPZ)
source code
 
GDAL_GCP_GCPPixel_get(*args)
GDAL_GCP_GCPPixel_get(GCP gcp) -> double
source code
 
GDAL_GCP_GCPPixel_set(*args)
GDAL_GCP_GCPPixel_set(GCP gcp, double dfGCPPixel)
source code
 
GDAL_GCP_GCPLine_get(*args)
GDAL_GCP_GCPLine_get(GCP gcp) -> double
source code
 
GDAL_GCP_GCPLine_set(*args)
GDAL_GCP_GCPLine_set(GCP gcp, double dfGCPLine)
source code
 
GDAL_GCP_Info_get(*args)
GDAL_GCP_Info_get(GCP gcp) -> char
source code
 
GDAL_GCP_Info_set(*args)
GDAL_GCP_Info_set(GCP gcp, char pszInfo)
source code
 
GDAL_GCP_Id_get(*args)
GDAL_GCP_Id_get(GCP gcp) -> char
source code
 
GDAL_GCP_Id_set(*args)
GDAL_GCP_Id_set(GCP gcp, char pszId)
source code
 
GCPsToGeoTransform(*args)
GCPsToGeoTransform(int nGCPs, int bApproxOK = 1) -> RETURN_NONE
source code
 
TermProgress_nocb(*args, **kwargs)
TermProgress_nocb(double dfProgress, char pszMessage = None, void pData = None) -> int
source code
Variables [hide private]
  _newclass = 0
  have_warned = 0
  byteorders = {"little": "<", "big": ">"}
  array_modes = {gdalconst.GDT_Int16:("%si2" % byteorders [sys.b...
  VSI_STAT_EXISTS_FLAG = _gdal.VSI_STAT_EXISTS_FLAG
  VSI_STAT_NATURE_FLAG = _gdal.VSI_STAT_NATURE_FLAG
  VSI_STAT_SIZE_FLAG = _gdal.VSI_STAT_SIZE_FLAG
  StatBuf_swigregister = _gdal.StatBuf_swigregister
  MajorObject_swigregister = _gdal.MajorObject_swigregister
  Driver_swigregister = _gdal.Driver_swigregister
  ColorEntry_swigregister = _gdal.ColorEntry_swigregister
  GCP_swigregister = _gdal.GCP_swigregister
  VirtualMem_swigregister = _gdal.VirtualMem_swigregister
  AsyncReader_swigregister = _gdal.AsyncReader_swigregister
  Dataset_swigregister = _gdal.Dataset_swigregister
  Band_swigregister = _gdal.Band_swigregister
  ColorTable_swigregister = _gdal.ColorTable_swigregister
  RasterAttributeTable_swigregister = _gdal.RasterAttributeTable...
  TermProgress = _gdal.TermProgress
  ComputeMedianCutPCT = _gdal.ComputeMedianCutPCT
  DitherRGB2PCT = _gdal.DitherRGB2PCT
  ReprojectImage = _gdal.ReprojectImage
  ComputeProximity = _gdal.ComputeProximity
  RasterizeLayer = _gdal.RasterizeLayer
  Polygonize = _gdal.Polygonize
  FPolygonize = _gdal.FPolygonize
  FillNodata = _gdal.FillNodata
  SieveFilter = _gdal.SieveFilter
  RegenerateOverviews = _gdal.RegenerateOverviews
  RegenerateOverview = _gdal.RegenerateOverview
  ContourGenerate = _gdal.ContourGenerate
  AutoCreateWarpedVRT = _gdal.AutoCreateWarpedVRT
  CreatePansharpenedVRT = _gdal.CreatePansharpenedVRT
  Transformer_swigregister = _gdal.Transformer_swigregister
  ApplyGeoTransform = _gdal.ApplyGeoTransform
  InvGeoTransform = _gdal.InvGeoTransform
  VersionInfo = _gdal.VersionInfo
  AllRegister = _gdal.AllRegister
  GDALDestroyDriverManager = _gdal.GDALDestroyDriverManager
  GetCacheMax = _gdal.GetCacheMax
  GetCacheUsed = _gdal.GetCacheUsed
  SetCacheMax = _gdal.SetCacheMax
  GetDataTypeSize = _gdal.GetDataTypeSize
  DataTypeIsComplex = _gdal.DataTypeIsComplex
  GetDataTypeName = _gdal.GetDataTypeName
  GetDataTypeByName = _gdal.GetDataTypeByName
  GetColorInterpretationName = _gdal.GetColorInterpretationName
  GetPaletteInterpretationName = _gdal.GetPaletteInterpretationName
  DecToDMS = _gdal.DecToDMS
  PackedDMSToDec = _gdal.PackedDMSToDec
  DecToPackedDMS = _gdal.DecToPackedDMS
  ParseXMLString = _gdal.ParseXMLString
  SerializeXMLTree = _gdal.SerializeXMLTree
  GetJPEG2000Structure = _gdal.GetJPEG2000Structure
  GetJPEG2000StructureAsString = _gdal.GetJPEG2000StructureAsString
  GetDriverCount = _gdal.GetDriverCount
  GetDriverByName = _gdal.GetDriverByName
  GetDriver = _gdal.GetDriver
  Open = _gdal.Open
  OpenEx = _gdal.OpenEx
  OpenShared = _gdal.OpenShared
  IdentifyDriver = _gdal.IdentifyDriver
  GeneralCmdLineProcessor = _gdal.GeneralCmdLineProcessor
  GDALInfoOptions_swigregister = _gdal.GDALInfoOptions_swigregister
  InfoInternal = _gdal.InfoInternal
  GDALTranslateOptions_swigregister = _gdal.GDALTranslateOptions...
  TranslateInternal = _gdal.TranslateInternal
  GDALWarpAppOptions_swigregister = _gdal.GDALWarpAppOptions_swi...
  wrapper_GDALWarpDestDS = _gdal.wrapper_GDALWarpDestDS
  wrapper_GDALWarpDestName = _gdal.wrapper_GDALWarpDestName
  GDALVectorTranslateOptions_swigregister = _gdal.GDALVectorTran...
  wrapper_GDALVectorTranslateDestDS = _gdal.wrapper_GDALVectorTr...
  wrapper_GDALVectorTranslateDestName = _gdal.wrapper_GDALVector...
  GDALDEMProcessingOptions_swigregister = _gdal.GDALDEMProcessin...
  DEMProcessingInternal = _gdal.DEMProcessingInternal
  GDALNearblackOptions_swigregister = _gdal.GDALNearblackOptions...
  wrapper_GDALNearblackDestDS = _gdal.wrapper_GDALNearblackDestDS
  wrapper_GDALNearblackDestName = _gdal.wrapper_GDALNearblackDes...
  GDALGridOptions_swigregister = _gdal.GDALGridOptions_swigregister
  GridInternal = _gdal.GridInternal
  GDALRasterizeOptions_swigregister = _gdal.GDALRasterizeOptions...
  wrapper_GDALRasterizeDestDS = _gdal.wrapper_GDALRasterizeDestDS
  wrapper_GDALRasterizeDestName = _gdal.wrapper_GDALRasterizeDes...
  GDALBuildVRTOptions_swigregister = _gdal.GDALBuildVRTOptions_s...
  BuildVRTInternalObjects = _gdal.BuildVRTInternalObjects
  BuildVRTInternalNames = _gdal.BuildVRTInternalNames
Function Details [hide private]

Info(ds, **kwargs)

source code 
Return information on a dataset.
Arguments are :
  ds --- a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.InfoOptions()
If options is provided as a gdal.InfoOptions() object, other keywords are ignored. 

TranslateOptions(options=[], format='GTiff', outputType=GDT_Unknown, bandList=None, maskBand=None, width=0, height=0, widthPct=0.0, heightPct=0.0, xRes=0.0, yRes=0.0, creationOptions=None, srcWin=None, projWin=None, projWinSRS=None, strict=False, unscale=False, scaleParams=None, exponents=None, outputBounds=None, metadataOptions=None, outputSRS=None, GCPs=None, noData=None, rgbExpand=None, stats=False, rat=True, resampleAlg=None, callback=None, callback_data=None)

source code 
Create a TranslateOptions() object that can be passed to gdal.Translate()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("GTiff", etc...)
  outputType --- output type (gdal.GDT_Byte, etc...)
  bandList --- array of band numbers (index start at 1)
  maskBand --- mask band to generate or not ("none", "auto", "mask", 1, ...)
  width --- width of the output raster in pixel
  height --- height of the output raster in pixel
  widthPct --- width of the output raster in percentage (100 = original width)
  heightPct --- height of the output raster in percentage (100 = original height)
  xRes --- output horizontal resolution
  yRes --- output vertical resolution
  creationOptions --- list of creation options
  srcWin --- subwindow in pixels to extract: [left_x, top_y, width, height]
  projWin --- subwindow in projected coordinates to extract: [ulx, uly, lrx, lry]
  projWinSRS --- SRS in which projWin is expressed
  strict --- strict mode
  unscale --- unscale values with scale and offset metadata
  scaleParams --- list of scale parameters, each of the form [src_min,src_max] or [src_min,src_max,dst_min,dst_max]
  exponents --- list of exponentiation parameters
  outputBounds --- assigned output bounds: [ulx, uly, lrx, lry]
  metadataOptions --- list of metadata options
  outputSRS --- assigned output SRS
  GCPs --- list of GCPs
  noData --- nodata value (or "none" to unset it)
  rgbExpand --- Color palette expansion mode: "gray", "rgb", "rgba"
  stats --- whether to calculate statistics
  rat --- whether to write source RAT
  resampleAlg --- resampling mode
  callback --- callback method
  callback_data --- user data for callback

Translate(destName, srcDS, **kwargs)

source code 
Convert a dataset.
Arguments are :
  destName --- Output dataset name
  srcDS --- a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.TranslateOptions()
If options is provided as a gdal.TranslateOptions() object, other keywords are ignored. 

WarpOptions(options=[], format='GTiff', outputBounds=None, outputBoundsSRS=None, xRes=None, yRes=None, targetAlignedPixels=False, width=0, height=0, srcSRS=None, dstSRS=None, srcAlpha=False, dstAlpha=False, warpOptions=None, errorThreshold=None, warpMemoryLimit=None, creationOptions=None, outputType=GDT_Unknown, workingType=GDT_Unknown, resampleAlg=None, srcNodata=None, dstNodata=None, multithread=False, tps=False, rpc=False, geoloc=False, polynomialOrder=None, transformerOptions=None, cutlineDSName=None, cutlineLayer=None, cutlineWhere=None, cutlineSQL=None, cutlineBlend=None, cropToCutline=False, copyMetadata=True, metadataConflictValue=None, setColorInterpretation=False, callback=None, callback_data=None)

source code 
Create a WarpOptions() object that can be passed to gdal.Warp()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("GTiff", etc...)
  outputBounds --- output bounds as (minX, minY, maxX, maxY) in target SRS
  outputBoundsSRS --- SRS in which output bounds are expressed, in the case they are not expressed in dstSRS
  xRes, yRes --- output resolution in target SRS
  targetAlignedPixels --- whether to force output bounds to be multiple of output resolution
  width --- width of the output raster in pixel
  height --- height of the output raster in pixel
  srcSRS --- source SRS
  dstSRS --- output SRS
  srcAlpha --- whether to force the last band of the input dataset to be considered as an alpha band
  dstAlpha --- whether to force the creation of an output alpha band
  outputType --- output type (gdal.GDT_Byte, etc...)
  workingType --- working type (gdal.GDT_Byte, etc...)
  warpOptions --- list of warping options
  errorThreshold --- error threshold for approximation transformer (in pixels)
  warpMemoryLimit --- size of working buffer in bytes
  resampleAlg --- resampling mode
  creationOptions --- list of creation options
  srcNodata --- source nodata value(s)
  dstNodata --- output nodata value(s)
  multithread --- whether to multithread computation and I/O operations
  tps --- whether to use Thin Plate Spline GCP transformer
  rpc --- whether to use RPC transformer
  geoloc --- whether to use GeoLocation array transformer
  polynomialOrder --- order of polynomial GCP interpolation
  transformerOptions --- list of transformer options
  cutlineDSName --- cutline dataset name
  cutlineLayer --- cutline layer name
  cutlineWhere --- cutline WHERE clause
  cutlineSQL --- cutline SQL statement
  cutlineBlend --- cutline blend distance in pixels
  cropToCutline --- whether to use cutline extent for output bounds
  copyMetadata --- whether to copy source metadata
  metadataConflictValue --- metadata data conflict value
  setColorInterpretation --- whether to force color interpretation of input bands to output bands
  callback --- callback method
  callback_data --- user data for callback

Warp(destNameOrDestDS, srcDSOrSrcDSTab, **kwargs)

source code 
Warp one or several datasets.
Arguments are :
  destNameOrDestDS --- Output dataset name or object
  srcDSOrSrcDSTab --- an array of Dataset objects or filenames, or a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.WarpOptions()
If options is provided as a gdal.WarpOptions() object, other keywords are ignored. 

VectorTranslateOptions(options=[], format='ESRI Shapefile', accessMode=None, srcSRS=None, dstSRS=None, reproject=True, SQLStatement=None, SQLDialect=None, where=None, selectFields=None, spatFilter=None, datasetCreationOptions=None, layerCreationOptions=None, layers=None, layerName=None, geometryType=None, dim=None, segmentizeMaxDist=None, zField=None, skipFailures=False, callback=None, callback_data=None)

source code 
Create a VectorTranslateOptions() object that can be passed to gdal.VectorTranslate()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("ESRI Shapefile", etc...)
  accessMode --- None for creation, 'update', 'append', 'overwrite'
  srcSRS --- source SRS
  dstSRS --- output SRS (with reprojection if reproject = True)
  reproject --- whether to do reprojection
  SQLStatement --- SQL statement to apply to the source dataset
  SQLDialect --- SQL dialect ('OGRSQL', 'SQLITE', ...)
  where --- WHERE clause to apply to source layer(s)
  selectFields --- list of fields to select
  spatFilter --- spatial filter as (minX, minY, maxX, maxY) bounding box
  datasetCreationOptions --- list of dataset creation options
  layerCreationOptions --- list of layer creation options
  layers --- list of layers to convert
  layerName --- output layer name
  geometryType --- output layer geometry type ('POINT', ....)
  dim --- output dimension ('XY', 'XYZ', 'XYM', 'XYZM', 'layer_dim')
  segmentizeMaxDist --- maximum distance between consecutive nodes of a line geometry
  zField --- name of field to use to set the Z component of geometries
  skipFailures --- whether to skip failures
  callback --- callback method
  callback_data --- user data for callback

DEMProcessingOptions(options=[], colorFilename=None, format='GTiff', creationOptions=None, computeEdges=False, alg='Horn', band=1, zFactor=None, scale=None, azimuth=None, altitude=None, combined=False, slopeFormat=None, trigonometric=False, zeroForFlat=False, callback=None, callback_data=None)

source code 
Create a DEMProcessingOptions() object that can be passed to gdal.DEMProcessing()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  colorFilename --- (mandatory for "color-relief") name of file that contains palette definition for the "color-relief" processing.
  format --- output format ("GTiff", etc...)
  creationOptions --- list of creation options
  computeEdges --- whether to compute values at raster edges.
  alg --- 'ZevenbergenThorne' or 'Horn'
  band --- source band number to use
  zFactor --- (hillshade only) vertical exaggeration used to pre-multiply the elevations.
  scale --- ratio of vertical units to horizontal.
  azimuth --- (hillshade only) azimuth of the light, in degrees. 0 if it comes from the top of the raster, 90 from the east, ... The default value, 315, should rarely be changed as it is the value generally used to generate shaded maps.
  altitude ---(hillshade only) altitude of the light, in degrees. 90 if the light comes from above the DEM, 0 if it is raking light.
  combined --- (hillshade only) whether to compute combined shading, a combination of slope and oblique shading.
  slopeformat --- (slope only) "degree" or "percent".
  trigonometric --- (aspect only) whether to return trigonometric angle instead of azimuth. Thus 0deg means East, 90deg North, 180deg West, 270deg South.
  zeroForFlat --- (aspect only) whether to return 0 for flat areas with slope=0, instead of -9999.
  callback --- callback method
  callback_data --- user data for callback

DEMProcessing(destName, srcDS, processing, **kwargs)

source code 
Apply a DEM processing.
Arguments are :
  destName --- Output dataset name
  srcDS --- a Dataset object or a filename
  processing --- one of "hillshade", "slope", "aspect", "color-relief", "TRI", "TPI", "Roughness"
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.DEMProcessingOptions()
If options is provided as a gdal.DEMProcessingOptions() object, other keywords are ignored. 

NearblackOptions(options=[], format='GTiff', creationOptions=None, white=False, colors=None, maxNonBlack=None, nearDist=None, setAlpha=False, setMask=False, callback=None, callback_data=None)

source code 
Create a NearblackOptions() object that can be passed to gdal.Nearblack()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("GTiff", etc...)
  creationOptions --- list of creation options
  white --- whether to search for nearly white (255) pixels instead of nearly black pixels.
  colors --- list of colors  to search for, e.g. ((0,0,0),(255,255,255)). The pixels that are considered as the collar are set to 0
  maxNonBlack --- number of non-black (or other searched colors specified with white / colors) pixels that can be encountered before the giving up search inwards. Defaults to 2.
  nearDist --- select how far from black, white or custom colors the pixel values can be and still considered near black, white or custom color.  Defaults to 15.
  setAlpha --- adds an alpha band if the output file.
  setMask --- adds a mask band to the output file.
  callback --- callback method
  callback_data --- user data for callback

Nearblack(destNameOrDestDS, srcDS, **kwargs)

source code 
Convert nearly black/white borders to exact value.
Arguments are :
  destNameOrDestDS --- Output dataset name or object
  srcDS --- a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.NearblackOptions()
If options is provided as a gdal.NearblackOptions() object, other keywords are ignored. 

GridOptions(options=[], format='GTiff', outputType=GDT_Unknown, width=0, height=0, creationOptions=None, outputBounds=None, outputSRS=None, noData=None, algorithm=None, layers=None, SQLStatement=None, where=None, spatFilter=None, zfield=None, z_increase=None, z_multiply=None, callback=None, callback_data=None)

source code 
Create a GridOptions() object that can be passed to gdal.Grid()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("GTiff", etc...)
  outputType --- output type (gdal.GDT_Byte, etc...)
  width --- width of the output raster in pixel
  height --- height of the output raster in pixel
  creationOptions --- list of creation options
  outputBounds --- assigned output bounds: [ulx, uly, lrx, lry]
  outputSRS --- assigned output SRS
  noData --- nodata value
  algorithm --- e.g "invdist:power=2.0:smoothing=0.0:radius1=0.0:radius2=0.0:angle=0.0:max_points=0:min_points=0:nodata=0.0"
  layers --- list of layers to convert
  SQLStatement --- SQL statement to apply to the source dataset
  where --- WHERE clause to apply to source layer(s)
  spatFilter --- spatial filter as (minX, minY, maxX, maxY) bounding box
  zfield --- Identifies an attribute field on the features to be used to get a Z value from. This value overrides Z value read from feature geometry record.
  z_increase --- Addition to the attribute field on the features to be used to get a Z value from. The addition should be the same unit as Z value. The result value will be Z value + Z increase value. The default value is 0.
  z_multiply - Multiplication ratio for Z field. This can be used for shift from e.g. foot to meters or from  elevation to deep. The result value will be (Z value + Z increase value) * Z multiply value.  The default value is 1.
  callback --- callback method
  callback_data --- user data for callback

Grid(destName, srcDS, **kwargs)

source code 
Create raster from the scattered data.
Arguments are :
  destName --- Output dataset name
  srcDS --- a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.GridOptions()
If options is provided as a gdal.GridOptions() object, other keywords are ignored. 

RasterizeOptions(options=[], format=None, creationOptions=None, noData=None, initValues=None, outputBounds=None, outputSRS=None, width=None, height=None, xRes=None, yRes=None, targetAlignedPixels=False, bands=None, inverse=False, allTouched=False, burnValues=None, attribute=None, useZ=False, layers=None, SQLStatement=None, SQLDialect=None, where=None, callback=None, callback_data=None)

source code 
Create a RasterizeOptions() object that can be passed to gdal.Rasterize()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords.
  format --- output format ("GTiff", etc...)
  creationOptions --- list of creation options
  outputBounds --- assigned output bounds: [minx, miny, maxx, maxy]
  outputSRS --- assigned output SRS
  width --- width of the output raster in pixel
  height --- height of the output raster in pixel
  xRes, yRes --- output resolution in target SRS
  targetAlignedPixels --- whether to force output bounds to be multiple of output resolution
  noData --- nodata value
  initValues --- Value or list of values to pre-initialize the output image bands with.  However, it is not marked as the nodata value in the output file.  If only one value is given, the same value is used in all the bands.
  bands --- list of output bands to burn values into
  inverse --- whether to invert rasterization, i.e. burn the fixed burn value, or the burn value associated  with the first feature into all parts of the image not inside the provided a polygon.
  allTouched -- whether to enable the ALL_TOUCHED rasterization option so that all pixels touched by lines or polygons will be updated, not just those on the line render path, or whose center point is within the polygon.
  burnValues -- list of fixed values to burn into each band for all objects. Excusive with attribute.
  attribute --- identifies an attribute field on the features to be used for a burn-in value. The value will be burned into all output bands. Excusive with burnValues.
  useZ --- whether to indicate that a burn value should be extracted from the "Z" values of the feature. These values are added to the burn value given by burnValues or attribute if provided. As of now, only points and lines are drawn in 3D.
  layers --- list of layers from the datasource that will be used for input features.
  SQLStatement --- SQL statement to apply to the source dataset
  SQLDialect --- SQL dialect ('OGRSQL', 'SQLITE', ...)
  where --- WHERE clause to apply to source layer(s)
  callback --- callback method
  callback_data --- user data for callback

BuildVRTOptions(options=[], resolution=None, outputBounds=None, xRes=None, yRes=None, targetAlignedPixels=None, separate=None, bandList=None, addAlpha=None, resampleAlg=None, outputSRS=None, allowProjectionDifference=None, srcNodata=None, VRTNodata=None, hideNodata=None, callback=None, callback_data=None)

source code 
Create a BuildVRTOptions() object that can be passed to gdal.BuildVRT()
Keyword arguments are :
  options --- can be be an array of strings, a string or let empty and filled from other keywords..
  resolution --- 'highest', 'lowest', 'average', 'user'.
  outputBounds --- output bounds as (minX, minY, maxX, maxY) in target SRS.
  xRes, yRes --- output resolution in target SRS.
  targetAlignedPixels --- whether to force output bounds to be multiple of output resolution.
  separate --- whether each source file goes into a separate stacked band in the VRT band.
  bandList --- array of band numbers (index start at 1).
  addAlpha --- whether to add an alpha mask band to the VRT when the source raster have none.
  resampleAlg --- resampling mode.
  outputSRS --- assigned output SRS.
  allowProjectionDifference --- whether to accept input datasets have not the same projection. Note: they will *not* be reprojected.
  srcNodata --- source nodata value(s).
  VRTNodata --- nodata values at the VRT band level.
  hideNodata --- whether to make the VRT band not report the NoData value.
  callback --- callback method.
  callback_data --- user data for callback.

BuildVRT(destName, srcDSOrSrcDSTab, **kwargs)

source code 
Build a VRT from a list of datasets.
Arguments are :
  destName --- Output dataset name
  srcDSOrSrcDSTab --- an array of Dataset objects or filenames, or a Dataset object or a filename
Keyword arguments are :
  options --- return of gdal.InfoOptions(), string or array of strings
  other keywords arguments of gdal.BuildVRTOptions()
If options is provided as a gdal.BuildVRTOptions() object, other keywords are ignored. 


Variables Details [hide private]

array_modes

Value:
{gdalconst.GDT_Int16:("%si2" % byteorders [sys.byteorder]), gdalconst.\
GDT_UInt16:("%su2" % byteorders [sys.byteorder]), gdalconst.GDT_Int32:\
("%si4" % byteorders [sys.byteorder]), gdalconst.GDT_UInt32:("%su4" % \
byteorders [sys.byteorder]), gdalconst.GDT_Float32:("%sf4" % byteorder\
s [sys.byteorder]), gdalconst.GDT_Float64:("%sf8" % byteorders [sys.by\
teorder]), gdalconst.GDT_CFloat32:("%sf4" % byteorders [sys.byteorder]\
), gdalconst.GDT_CFloat64:("%sf8" % byteorders [sys.byteorder]), gdalc\
onst.GDT_Byte:("%st8" % byteorders [sys.byteorder]),}

RasterAttributeTable_swigregister

Value:
_gdal.RasterAttributeTable_swigregister

GDALTranslateOptions_swigregister

Value:
_gdal.GDALTranslateOptions_swigregister

GDALWarpAppOptions_swigregister

Value:
_gdal.GDALWarpAppOptions_swigregister

GDALVectorTranslateOptions_swigregister

Value:
_gdal.GDALVectorTranslateOptions_swigregister

wrapper_GDALVectorTranslateDestDS

Value:
_gdal.wrapper_GDALVectorTranslateDestDS

wrapper_GDALVectorTranslateDestName

Value:
_gdal.wrapper_GDALVectorTranslateDestName

GDALDEMProcessingOptions_swigregister

Value:
_gdal.GDALDEMProcessingOptions_swigregister

GDALNearblackOptions_swigregister

Value:
_gdal.GDALNearblackOptions_swigregister

wrapper_GDALNearblackDestName

Value:
_gdal.wrapper_GDALNearblackDestName

GDALRasterizeOptions_swigregister

Value:
_gdal.GDALRasterizeOptions_swigregister

wrapper_GDALRasterizeDestName

Value:
_gdal.wrapper_GDALRasterizeDestName

GDALBuildVRTOptions_swigregister

Value:
_gdal.GDALBuildVRTOptions_swigregister