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
| DirEntry Proxy of C++ DirEntry class.
| VSILFILE Proxy of C++ VSILFILE class.
| 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.
| Group Proxy of C++ GDALGroupHS class.
| Statistics Proxy of C++ Statistics class.
| MDArray Proxy of C++ GDALMDArrayHS class.
| Attribute Proxy of C++ GDALAttributeHS class.
| Dimension Proxy of C++ GDALDimensionHS class.
| ExtendedDataType Proxy of C++ GDALExtendedDataTypeHS class.
| EDTComponent Proxy of C++ GDALEDTComponentHS class.
| Band Proxy of C++ GDALRasterBandShadow class.
| ColorTable Proxy of C++ GDALColorTableShadow class.
| RasterAttributeTable Proxy of C++ GDALRasterAttributeTableShadow class.
| GDALTransformerInfoShadow Proxy of C++ GDALTransformerInfoShadow class.
| GDALInfoOptions Proxy of C++ GDALInfoOptions class.
| GDALMultiDimInfoOptions Proxy of C++ GDALMultiDimInfoOptions 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.
| GDALMultiDimTranslateOptions Proxy of C++ GDALMultiDimTranslateOptions 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, sub_package=None, new_module=None) | source code
RGBFile2PCTFile(src_filename, dst_filename) | source code
listdir(path, recursionLevel=-1, options=[]) Iterate over a directory. | source code
int |
GetUseExceptions() | source code
UseExceptions() | source code
DontUseExceptions() | source code
VSIFReadL(*args) VSIFReadL(unsigned int nMembSize, unsigned int nMembCount, VSILFILE fp) -> unsigned int | source code
VSIGetMemFileBuffer_unsafe(*args) VSIGetMemFileBuffer_unsafe(char const * utf8_path) | source code
InfoOptions(options=None, 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, wktFormat=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
MultiDimInfoOptions(options=None, detailed=False, array=None, arrayoptions=None, limit=None, as_text=False) Create a MultiDimInfoOptions() object that can be passed to gdal.MultiDimInfo() options can be be an array of strings, a string or let empty and filled from other keywords. | source code
MultiDimInfo(ds, **kwargs) Return information on a dataset. | source code
_strHighPrec(x) | source code
TranslateOptions(options=None, format=None, outputType=gdalconst.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, nogcp=False, GCPs=None, noData=None, rgbExpand=None, stats=False, rat=True, xmp=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=None, format=None, outputBounds=None, outputBoundsSRS=None, xRes=None, yRes=None, targetAlignedPixels=False, width=0, height=0, srcSRS=None, dstSRS=None, coordinateOperation=None, srcAlpha=False, dstAlpha=False, warpOptions=None, errorThreshold=None, warpMemoryLimit=None, creationOptions=None, outputType=gdalconst.GDT_Unknown, workingType=gdalconst.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, overviewLevel='AUTO', 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=None, format=None, accessMode=None, srcSRS=None, dstSRS=None, reproject=True, coordinateOperation=None, SQLStatement=None, SQLDialect=None, where=None, selectFields=None, addFields=False, forceNullable=False, emptyStrAsNull=False, spatFilter=None, spatSRS=None, datasetCreationOptions=None, layerCreationOptions=None, layers=None, layerName=None, geometryType=None, dim=None, segmentizeMaxDist=None, makeValid=False, zField=None, resolveDomains=False, skipFailures=False, limit=None, 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.VectorTranslateOptions(), 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=None, colorFilename=None, format=None, creationOptions=None, computeEdges=False, alg=None, band=1, zFactor=None, scale=None, azimuth=None, altitude=None, combined=False, multiDirectional=False, igor=False, slopeFormat=None, trigonometric=False, zeroForFlat=False, addAlpha=None, colorSelection=None, 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=None, format=None, 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=None, format=None, outputType=gdalconst.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=None, format=None, outputType=gdalconst.GDT_Unknown, creationOptions=None, noData=None, initValues=None, outputBounds=None, outputSRS=None, transformerOptions=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, optim=None, add=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.RasterizeOptions(), 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=None, 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, strict=False, 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
MultiDimTranslateOptions(options=None, format=None, creationOptions=None, arraySpecs=None, groupSpecs=None, subsetSpecs=None, scaleAxesSpecs=None, callback=None, callback_data=None) Create a MultiDimTranslateOptions() object that can be passed to gdal.MultiDimTranslate() Keyword arguments are : options --- can be be an array of strings, a string or let empty and filled from other keywords. | source code
MultiDimTranslate(destName, srcDSOrSrcDSTab, **kwargs) MultiDimTranslate one or several datasets. | source code
_pylog_handler(err_level, err_no, err_msg) | source code
ConfigurePythonLogging(logger_name='gdal', enable_debug=False) Configure GDAL to use Python's logging framework | source code
EscapeString(string_or_bytes, scheme= gdal.CPLES_SQL) | source code
ApplyVerticalShiftGrid(*args, **kwargs) ApplyVerticalShiftGrid(Dataset src_ds, Dataset grid_ds, bool inverse=False, double srcUnitToMeter=1.0, double dstUnitToMeter=1.0, char ** options=None) -> Dataset | source code
Debug(*args) Debug(char const * msg_class, char const * message) | source code
SetErrorHandler(*args) SetErrorHandler(CPLErrorHandler pfnErrorHandler=0) -> CPLErr | source code
SetCurrentErrorHandlerCatchDebug(*args) SetCurrentErrorHandlerCatchDebug(int bCatchDebug) | source code
PushErrorHandler(*args) PushErrorHandler(CPLErrorHandler pfnErrorHandler=0) -> CPLErr | source code
PopErrorHandler() | source code
Error(*args) Error(CPLErr msg_class, int err_code=0, char const * msg) | source code
GOA2GetAuthorizationURL(*args) GOA2GetAuthorizationURL(char const * pszScope) -> retStringAndCPLFree * | source code
GOA2GetRefreshToken(*args) GOA2GetRefreshToken(char const * pszAuthToken, char const * pszScope) -> retStringAndCPLFree * | source code
GOA2GetAccessToken(*args) GOA2GetAccessToken(char const * pszRefreshToken, char const * pszScope) -> retStringAndCPLFree * | source code
ErrorReset() | source code
wrapper_EscapeString(*args, **kwargs) wrapper_EscapeString(int len, int scheme) -> retStringAndCPLFree * | source code
EscapeBinary(*args, **kwargs) EscapeBinary(int len, int scheme) | source code
int |
GetLastErrorNo() | source code
int |
GetLastErrorType() | source code
char const * |
GetLastErrorMsg() | source code
unsigned int |
GetErrorCounter() | source code
int |
VSIGetLastErrorNo() | source code
char const * |
VSIGetLastErrorMsg() | source code
VSIErrorReset() | source code
PushFinderLocation(*args) PushFinderLocation(char const * utf8_path) | source code
PopFinderLocation() | source code
FinderClean() | source code
FindFile(*args) FindFile(char const * pszClass, char const * utf8_path) -> char const * | source code
ReadDir(*args) ReadDir(char const * utf8_path, int nMaxFiles=0) -> char ** | source code
ReadDirRecursive(*args) ReadDirRecursive(char const * utf8_path) -> char ** | source code
OpenDir(*args) OpenDir(char const * utf8_path, int nRecurseDepth=-1, char ** options=None) -> VSIDIR * | source code
GetNextDirEntry(*args) GetNextDirEntry(VSIDIR * dir) -> DirEntry | source code
CloseDir(*args) CloseDir(VSIDIR * dir) | source code
SetConfigOption(*args) SetConfigOption(char const * pszKey, char const * pszValue) | source code
SetThreadLocalConfigOption(*args) SetThreadLocalConfigOption(char const * pszKey, char const * pszValue) | source code
GetConfigOption(*args) GetConfigOption(char const * pszKey, char const * pszDefault=None) -> char const * | source code
GetThreadLocalConfigOption(*args) GetThreadLocalConfigOption(char const * pszKey, char const * pszDefault=None) -> char const * | source code
SetCredential(*args) SetCredential(char const * pszPathPrefix, char const * pszKey, char const * pszValue) | source code
GetCredential(*args) GetCredential(char const * pszPathPrefix, char const * pszKey, char const * pszDefault=None) -> char const * | source code
ClearCredentials(*args) ClearCredentials(char const * pszPathPrefix=None) | source code
CPLBinaryToHex(*args) CPLBinaryToHex(int nBytes) -> retStringAndCPLFree * | source code
CPLHexToBinary(*args) CPLHexToBinary(char const * pszHex, int * pnBytes) -> GByte * | source code
FileFromMemBuffer(*args) FileFromMemBuffer(char const * utf8_path, GIntBig nBytes) | source code
Unlink(*args) Unlink(char const * utf8_path) -> VSI_RETVAL | source code
UnlinkBatch(*args) UnlinkBatch(char ** files) -> bool | source code
int |
HasThreadSupport() | source code
Mkdir(*args) Mkdir(char const * utf8_path, int mode) -> VSI_RETVAL | source code
Rmdir(*args) Rmdir(char const * utf8_path) -> VSI_RETVAL | source code
MkdirRecursive(*args) MkdirRecursive(char const * utf8_path, int mode) -> VSI_RETVAL | source code
RmdirRecursive(*args) RmdirRecursive(char const * utf8_path) -> VSI_RETVAL | source code
Rename(*args) Rename(char const * pszOld, char const * pszNew) -> VSI_RETVAL | source code
Sync(*args, **kwargs) Sync(char const * pszSource, char const * pszTarget, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> bool | source code
AbortPendingUploads(*args) AbortPendingUploads(char const * utf8_path) -> bool | source code
GetActualURL(*args) GetActualURL(char const * utf8_path) -> char const * | source code
GetSignedURL(*args) GetSignedURL(char const * utf8_path, char ** options=None) -> retStringAndCPLFree * | source code
char ** |
GetFileSystemsPrefixes() | source code
GetFileSystemOptions(*args) GetFileSystemOptions(char const * utf8_path) -> char const * | source code
VSIStatL(*args) VSIStatL(char const * utf8_path, int nFlags=0) -> int | source code
GetFileMetadata(*args) GetFileMetadata(char const * utf8_path, char const * domain, char ** options=None) -> char ** | source code
SetFileMetadata(*args) SetFileMetadata(char const * utf8_path, char ** metadata, char const * domain, char ** options=None) -> bool | source code
VSIFOpenL(*args) VSIFOpenL(char const * utf8_path, char const * pszMode) -> VSILFILE | source code
VSIFOpenExL(*args) VSIFOpenExL(char const * utf8_path, char const * pszMode, int bSetError=False, char ** options=None) -> VSILFILE | source code
VSIFEofL(*args) VSIFEofL(VSILFILE fp) -> int | source code
VSIFFlushL(*args) VSIFFlushL(VSILFILE fp) -> int | 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
VSISupportsSparseFiles(*args) VSISupportsSparseFiles(char const * utf8_path) -> int | source code
VSIFGetRangeStatusL(*args) VSIFGetRangeStatusL(VSILFILE fp, GIntBig offset, GIntBig length) -> int | source code
VSIFWriteL(*args) VSIFWriteL(int nLen, int size, int memb, VSILFILE fp) -> int | source code
VSICurlClearCache() | source code
VSICurlPartialClearCache(*args) VSICurlPartialClearCache(char const * utf8_path) | source code
NetworkStatsReset() | source code
NetworkStatsGetAsSerializedJSON(*args) NetworkStatsGetAsSerializedJSON(char ** options=None) -> retStringAndCPLFree * | source code
ParseCommandLine(*args) ParseCommandLine(char const * 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 const * | source code
GDAL_GCP_Info_set(*args) GDAL_GCP_Info_set(GCP gcp, char const * pszInfo) | source code
GDAL_GCP_Id_get(*args) GDAL_GCP_Id_get(GCP gcp) -> char const * | source code
GDAL_GCP_Id_set(*args) GDAL_GCP_Id_set(GCP gcp, char const * pszId) | source code
GCPsToGeoTransform(*args) GCPsToGeoTransform(int nGCPs, int bApproxOK=1) -> RETURN_NONE | source code
ExtendedDataType_Create(*args) ExtendedDataType_Create(GDALDataType dt) -> ExtendedDataType | source code
ExtendedDataType_CreateString(*args) ExtendedDataType_CreateString(size_t nMaxStringLength=0, GDALExtendedDataTypeSubType eSubType=GEDTST_NONE) -> ExtendedDataType | source code
ExtendedDataType_CreateCompound(*args) ExtendedDataType_CreateCompound(char const * name, size_t nTotalSize, int nComps) -> ExtendedDataType | source code
EDTComponent_Create(*args) EDTComponent_Create(char const * name, size_t offset, ExtendedDataType type) -> EDTComponent | source code
TermProgress_nocb(*args, **kwargs) TermProgress_nocb(double dfProgress, char const * pszMessage=None, void * pData=None) -> int | source code
ComputeMedianCutPCT(*args, **kwargs) ComputeMedianCutPCT(Band red, Band green, Band blue, int num_colors, ColorTable colors, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
DitherRGB2PCT(*args, **kwargs) DitherRGB2PCT(Band red, Band green, Band blue, Band target, ColorTable colors, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
ReprojectImage(*args, **kwargs) ReprojectImage(Dataset src_ds, Dataset dst_ds, char const * src_wkt=None, char const * dst_wkt=None, GDALResampleAlg eResampleAlg, double WarpMemoryLimit=0.0, double maxerror=0.0, GDALProgressFunc callback=0, void * callback_data=None, char ** options=None) -> CPLErr | source code
ComputeProximity(*args, **kwargs) ComputeProximity(Band srcBand, Band proximityBand, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
RasterizeLayer(*args, **kwargs) RasterizeLayer(Dataset dataset, int bands, Layer layer, void * pfnTransformer=None, void * pTransformArg=None, int burn_values=0, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
Polygonize(*args, **kwargs) Polygonize(Band srcBand, Band maskBand, Layer outLayer, int iPixValField, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
FPolygonize(*args, **kwargs) FPolygonize(Band srcBand, Band maskBand, Layer outLayer, int iPixValField, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
FillNodata(*args, **kwargs) FillNodata(Band targetBand, Band maskBand, double maxSearchDist, int smoothingIterations, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
SieveFilter(*args, **kwargs) SieveFilter(Band srcBand, Band maskBand, Band dstBand, int threshold, int connectedness=4, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
RegenerateOverviews(*args, **kwargs) RegenerateOverviews(Band srcBand, int overviewBandCount, char const * resampling, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
RegenerateOverview(*args, **kwargs) RegenerateOverview(Band srcBand, Band overviewBand, char const * resampling, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
ContourGenerate(*args, **kwargs) ContourGenerate(Band srcBand, double contourInterval, double contourBase, int fixedLevelCount, int useNoData, double noDataValue, Layer dstLayer, int idField, int elevField, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
ContourGenerateEx(*args, **kwargs) ContourGenerateEx(Band srcBand, Layer dstLayer, char ** options=None, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
ViewshedGenerate(*args, **kwargs) ViewshedGenerate(Band srcBand, char const * driverName, char const * targetRasterName, char ** creationOptions, double observerX, double observerY, double observerHeight, double targetHeight, double visibleVal, double invisibleVal, double outOfRangeVal, double noDataVal, double dfCurvCoeff, GDALViewshedMode mode, double maxDistance, GDALProgressFunc callback=0, void * callback_data=None, GDALViewshedOutputType heightMode=GVOT_NORMAL, char ** papszOptions=None) -> Dataset | source code
AutoCreateWarpedVRT(*args) AutoCreateWarpedVRT(Dataset src_ds, char const * src_wkt=None, char const * dst_wkt=None, GDALResampleAlg eResampleAlg, double maxerror=0.0) -> Dataset | source code
CreatePansharpenedVRT(*args) CreatePansharpenedVRT(char const * pszXML, Band panchroBand, int nInputSpectralBands) -> Dataset | source code
Transformer(*args) Transformer(Dataset src, Dataset dst, char ** options) -> GDALTransformerInfoShadow | source code
_ApplyVerticalShiftGrid(*args, **kwargs) _ApplyVerticalShiftGrid(Dataset src_ds, Dataset grid_ds, bool inverse=False, double srcUnitToMeter=1.0, double dstUnitToMeter=1.0, char ** options=None) -> Dataset | source code
ApplyGeoTransform(*args) ApplyGeoTransform(double [6] padfGeoTransform, double dfPixel, double dfLine) | source code
InvGeoTransform(*args) InvGeoTransform(double [6] gt_in) -> RETURN_NONE | source code
VersionInfo(*args) VersionInfo(char const * request) -> char const * | source code
AllRegister() | source code
GDALDestroyDriverManager() | source code
GIntBig |
GetCacheMax() | source code
GIntBig |
GetCacheUsed() | source code
SetCacheMax(*args) SetCacheMax(GIntBig nBytes) | source code
GetDataTypeSize(*args) GetDataTypeSize(GDALDataType eDataType) -> int | source code
DataTypeIsComplex(*args) DataTypeIsComplex(GDALDataType eDataType) -> int | source code
GetDataTypeName(*args) GetDataTypeName(GDALDataType eDataType) -> char const * | source code
GetDataTypeByName(*args) GetDataTypeByName(char const * pszDataTypeName) -> GDALDataType | source code
DataTypeUnion(*args) DataTypeUnion(GDALDataType a, GDALDataType b) -> GDALDataType | source code
GetColorInterpretationName(*args) GetColorInterpretationName(GDALColorInterp eColorInterp) -> char const * | source code
GetPaletteInterpretationName(*args) GetPaletteInterpretationName(GDALPaletteInterp ePaletteInterp) -> char const * | source code
DecToDMS(*args) DecToDMS(double arg1, char const * arg2, int arg3=2) -> char const * | source code
PackedDMSToDec(*args) PackedDMSToDec(double dfPacked) -> double | source code
DecToPackedDMS(*args) DecToPackedDMS(double dfDec) -> double | source code
ParseXMLString(*args) ParseXMLString(char * pszXMLString) -> CPLXMLNode * | source code
SerializeXMLTree(*args) SerializeXMLTree(CPLXMLNode * xmlnode) -> retStringAndCPLFree * | source code
GetJPEG2000Structure(*args) GetJPEG2000Structure(char const * pszFilename, char ** options=None) -> CPLXMLNode * | source code
GetJPEG2000StructureAsString(*args) GetJPEG2000StructureAsString(char const * pszFilename, char ** options=None) -> retStringAndCPLFree * | source code
int |
GetDriverCount() | source code
GetDriverByName(*args) GetDriverByName(char const * name) -> Driver | source code
GetDriver(*args) GetDriver(int i) -> Driver | source code
Open(*args) Open(char const * utf8_path, GDALAccess eAccess) -> Dataset | source code
OpenEx(*args, **kwargs) OpenEx(char const * utf8_path, unsigned int nOpenFlags=0, char ** allowed_drivers=None, char ** open_options=None, char ** sibling_files=None) -> Dataset | source code
OpenShared(*args) OpenShared(char const * utf8_path, GDALAccess eAccess) -> Dataset | source code
IdentifyDriver(*args) IdentifyDriver(char const * utf8_path, char ** papszSiblings=None) -> Driver | source code
IdentifyDriverEx(*args, **kwargs) IdentifyDriverEx(char const * utf8_path, unsigned int nIdentifyFlags=0, char ** allowed_drivers=None, char ** sibling_files=None) -> Driver | source code
GeneralCmdLineProcessor(*args) GeneralCmdLineProcessor(char ** papszArgv, int nOptions=0) -> char ** | source code
InfoInternal(*args) InfoInternal(Dataset hDataset, GDALInfoOptions infoOptions) -> retStringAndCPLFree * | source code
MultiDimInfoInternal(*args) MultiDimInfoInternal(Dataset hDataset, GDALMultiDimInfoOptions infoOptions) -> retStringAndCPLFree * | source code
TranslateInternal(*args) TranslateInternal(char const * dest, Dataset dataset, GDALTranslateOptions translateOptions, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
wrapper_GDALWarpDestDS(*args) wrapper_GDALWarpDestDS(Dataset dstDS, int object_list_count, GDALWarpAppOptions warpAppOptions, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
wrapper_GDALWarpDestName(*args) wrapper_GDALWarpDestName(char const * dest, int object_list_count, GDALWarpAppOptions warpAppOptions, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
wrapper_GDALVectorTranslateDestDS(*args) wrapper_GDALVectorTranslateDestDS(Dataset dstDS, Dataset srcDS, GDALVectorTranslateOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
wrapper_GDALVectorTranslateDestName(*args) wrapper_GDALVectorTranslateDestName(char const * dest, Dataset srcDS, GDALVectorTranslateOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
DEMProcessingInternal(*args) DEMProcessingInternal(char const * dest, Dataset dataset, char const * pszProcessing, char const * pszColorFilename, GDALDEMProcessingOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
wrapper_GDALNearblackDestDS(*args) wrapper_GDALNearblackDestDS(Dataset dstDS, Dataset srcDS, GDALNearblackOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
wrapper_GDALNearblackDestName(*args) wrapper_GDALNearblackDestName(char const * dest, Dataset srcDS, GDALNearblackOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
GridInternal(*args) GridInternal(char const * dest, Dataset dataset, GDALGridOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
wrapper_GDALRasterizeDestDS(*args) wrapper_GDALRasterizeDestDS(Dataset dstDS, Dataset srcDS, GDALRasterizeOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> int | source code
wrapper_GDALRasterizeDestName(*args) wrapper_GDALRasterizeDestName(char const * dest, Dataset srcDS, GDALRasterizeOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
BuildVRTInternalObjects(*args) BuildVRTInternalObjects(char const * dest, int object_list_count, GDALBuildVRTOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
BuildVRTInternalNames(*args) BuildVRTInternalNames(char const * dest, char ** source_filenames, GDALBuildVRTOptions options, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code
wrapper_GDALMultiDimTranslateDestName(*args) wrapper_GDALMultiDimTranslateDestName(char const * dest, int object_list_count, GDALMultiDimTranslateOptions multiDimTranslateOptions, GDALProgressFunc callback=0, void * callback_data=None) -> Dataset | source code

Variables | [hide private]
| _newclass = `0`
| have_warned = `0`
| byteorders = `{"little": "<", "big": ">"}`
| array_modes = `{gdalconst.GDT_Int16:("%si2" % byteorders [sys.b`...``
| mapGRIORAMethodToString = `{gdalconst.GRIORA_NearestNeighbour: `...``
| DirEntry_swigregister = `_gdal.DirEntry_swigregister`
| VSILFILE_swigregister = `_gdal.VSILFILE_swigregister`
| 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`
| VSI_STAT_SET_ERROR_FLAG = `_gdal.VSI_STAT_SET_ERROR_FLAG`
| VSI_STAT_CACHE_ONLY = `_gdal.VSI_STAT_CACHE_ONLY`
| StatBuf_swigregister = `_gdal.StatBuf_swigregister`
| VSI_RANGE_STATUS_UNKNOWN = `_gdal.VSI_RANGE_STATUS_UNKNOWN`
| VSI_RANGE_STATUS_DATA = `_gdal.VSI_RANGE_STATUS_DATA`
| VSI_RANGE_STATUS_HOLE = `_gdal.VSI_RANGE_STATUS_HOLE`
| 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`
| GEDTST_NONE = `_gdal.GEDTST_NONE`
| GEDTST_JSON = `_gdal.GEDTST_JSON`
| Group_swigregister = `_gdal.Group_swigregister`
| Statistics_swigregister = `_gdal.Statistics_swigregister`
| MDArray_swigregister = `_gdal.MDArray_swigregister`
| Attribute_swigregister = `_gdal.Attribute_swigregister`
| Dimension_swigregister = `_gdal.Dimension_swigregister`
| GEDTC_NUMERIC = `_gdal.GEDTC_NUMERIC`
| GEDTC_STRING = `_gdal.GEDTC_STRING`
| GEDTC_COMPOUND = `_gdal.GEDTC_COMPOUND`
| ExtendedDataType_swigregister = `_gdal.ExtendedDataType_swigreg`...``
| EDTComponent_swigregister = `_gdal.EDTComponent_swigregister`
| Band_swigregister = `_gdal.Band_swigregister`
| ColorTable_swigregister = `_gdal.ColorTable_swigregister`
| RasterAttributeTable_swigregister = `_gdal.RasterAttributeTable`...``
| TermProgress = `_gdal.TermProgress`
| GVM_Diagonal = `_gdal.GVM_Diagonal`
| GVM_Edge = `_gdal.GVM_Edge`
| GVM_Max = `_gdal.GVM_Max`
| GVM_Min = `_gdal.GVM_Min`
| GVOT_NORMAL = `_gdal.GVOT_NORMAL`
| GVOT_MIN_TARGET_HEIGHT_FROM_DEM = `_gdal.GVOT_MIN_TARGET_HEIGHT`...``
| GVOT_MIN_TARGET_HEIGHT_FROM_GROUND = `_gdal.GVOT_MIN_TARGET_HEI`...``
| GDALTransformerInfoShadow_swigregister = `_gdal.GDALTransformer`...``
| GDALInfoOptions_swigregister = `_gdal.GDALInfoOptions_swigregister`
| GDALMultiDimInfoOptions_swigregister = `_gdal.GDALMultiDimInfoO`...``
| GDALTranslateOptions_swigregister = `_gdal.GDALTranslateOptions`...``
| GDALWarpAppOptions_swigregister = `_gdal.GDALWarpAppOptions_swi`...``
| GDALVectorTranslateOptions_swigregister = `_gdal.GDALVectorTran`...``
| GDALDEMProcessingOptions_swigregister = `_gdal.GDALDEMProcessin`...``
| GDALNearblackOptions_swigregister = `_gdal.GDALNearblackOptions`...``
| GDALGridOptions_swigregister = `_gdal.GDALGridOptions_swigregister`
| GDALRasterizeOptions_swigregister = `_gdal.GDALRasterizeOptions`...``
| GDALBuildVRTOptions_swigregister = `_gdal.GDALBuildVRTOptions_s`...``
| GDALMultiDimTranslateOptions_swigregister = `_gdal.GDALMultiDim`...``

Function Details | [hide private]

### listdir(path, recursionLevel=-1, options=[]) | source code
Iterate over a directory. recursionLevel = -1 means unlimited level of recursion.

### 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.

### MultiDimInfo(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.MultiDimInfoOptions(), string or array of strings
      other keywords arguments of gdal.MultiDimInfoOptions()
    If options is provided as a gdal.MultiDimInfoOptions() object, other keywords are ignored.

### TranslateOptions(options=None, format=None, outputType=gdalconst.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, nogcp=False, GCPs=None, noData=None, rgbExpand=None, stats=False, rat=True, xmp=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 (gdalconst.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
      nogcp --- ignore GCP in the raster
      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
      xmp --- whether to copy XMP metadata
      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.TranslateOptions(), 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=None, format=None, outputBounds=None, outputBoundsSRS=None, xRes=None, yRes=None, targetAlignedPixels=False, width=0, height=0, srcSRS=None, dstSRS=None, coordinateOperation=None, srcAlpha=False, dstAlpha=False, warpOptions=None, errorThreshold=None, warpMemoryLimit=None, creationOptions=None, outputType=gdalconst.GDT_Unknown, workingType=gdalconst.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, overviewLevel='AUTO', 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
      coordinateOperation -- coordinate operation as a PROJ string or WKT string
      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 (gdalconst.GDT_Byte, etc...)
      workingType --- working type (gdalconst.GDT_Byte, etc...)
      warpOptions --- list of warping options
      errorThreshold --- error threshold for approximation transformer (in pixels)
      warpMemoryLimit --- size of working buffer in MB
      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
      overviewLevel --- To specify which overview level of source files must be used
      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.WarpOptions(), 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=None, format=None, accessMode=None, srcSRS=None, dstSRS=None, reproject=True, coordinateOperation=None, SQLStatement=None, SQLDialect=None, where=None, selectFields=None, addFields=False, forceNullable=False, emptyStrAsNull=False, spatFilter=None, spatSRS=None, datasetCreationOptions=None, layerCreationOptions=None, layers=None, layerName=None, geometryType=None, dim=None, segmentizeMaxDist=None, makeValid=False, zField=None, resolveDomains=False, skipFailures=False, limit=None, 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)
      coordinateOperation -- coordinate operation as a PROJ string or WKT string
      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
      addFields --- whether to add new fields found in source layers (to be used with accessMode == 'append')
      forceNullable --- whether to drop NOT NULL constraints on newly created fields
      emptyStrAsNull --- whether to treat empty string values as NULL
      spatFilter --- spatial filter as (minX, minY, maxX, maxY) bounding box
      spatSRS --- SRS in which the spatFilter is expressed. If not specified, it is assumed to be the one of the layer(s)
      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
      makeValid --- run MakeValid() on geometries
      zField --- name of field to use to set the Z component of geometries
      resolveDomains --- whether to create an additional field for each field associated with a coded field domain.
      skipFailures --- whether to skip failures
      limit -- maximum number of features to read per layer
      callback --- callback method
      callback_data --- user data for callback

### DEMProcessingOptions(options=None, colorFilename=None, format=None, creationOptions=None, computeEdges=False, alg=None, band=1, zFactor=None, scale=None, azimuth=None, altitude=None, combined=False, multiDirectional=False, igor=False, slopeFormat=None, trigonometric=False, zeroForFlat=False, addAlpha=None, colorSelection=None, 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 --- 'Horn' (default) or 'ZevenbergenThorne' for hillshade, slope or aspect. 'Wilson' (default) or 'Riley' for TRI
      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. Only one of combined, multiDirectional and igor can be specified.
      multiDirectional --- (hillshade only) whether to compute multi-directional shading. Only one of combined, multiDirectional and igor can be specified.
      igor --- (hillshade only) whether to use Igor's hillshading from Maperitive.  Only one of combined, multiDirectional and igor can be specified.
      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.
      addAlpha --- adds an alpha band to the output file (only for processing = 'color-relief')
      colorSelection --- (color-relief only) Determines how color entries are selected from an input value. Can be "nearest_color_entry", "exact_color_entry" or "linear_interpolation". Defaults to "linear_interpolation"
      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.DEMProcessingOptions(), 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=None, format=None, 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 to 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.NearblackOptions(), 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=None, format=None, outputType=gdalconst.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 (gdalconst.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.GridOptions(), 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=None, format=None, outputType=gdalconst.GDT_Unknown, creationOptions=None, noData=None, initValues=None, outputBounds=None, outputSRS=None, transformerOptions=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, optim=None, add=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...)
      outputType --- output type (gdalconst.GDT_Byte, etc...)
      creationOptions --- list of creation options
      outputBounds --- assigned output bounds: [minx, miny, maxx, maxy]
      outputSRS --- assigned output SRS
      transformerOptions --- list of transformer options
      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)
      optim --- optimization mode ('RASTER', 'VECTOR')
      add --- set to True to use additive mode instead of replace when burning values
      callback --- callback method
      callback_data --- user data for callback

### BuildVRTOptions(options=None, 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, strict=False, 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.
      strict --- set to True if warnings should be failures
      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.BuildVRTOptions(), string or array of strings
      other keywords arguments of gdal.BuildVRTOptions()
    If options is provided as a gdal.BuildVRTOptions() object, other keywords are ignored.

### MultiDimTranslateOptions(options=None, format=None, creationOptions=None, arraySpecs=None, groupSpecs=None, subsetSpecs=None, scaleAxesSpecs=None, callback=None, callback_data=None) | source code
    Create a MultiDimTranslateOptions() object that can be passed to gdal.MultiDimTranslate()
    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
      arraySpecs -- list of array specifications, each of them being an array name or "name={src_array_name},dstname={dst_name},transpose=[1,0],view=[:,::-1]"
      groupSpecs -- list of group specifications, each of them being a group name or "name={src_array_name},dstname={dst_name},recursive=no"
      subsetSpecs -- list of subset specifications, each of them being like "{dim_name}({min_val},{max_val})" or "{dim_name}({slice_va})"
      scaleAxesSpecs -- list of dimension scaling specifications, each of them being like "{dim_name}({scale_factor})"
      callback --- callback method
      callback_data --- user data for callback

### MultiDimTranslate(destName, srcDSOrSrcDSTab, **kwargs) | source code
    MultiDimTranslate one or several 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.MultiDimTranslateOptions(), string or array of strings
      other keywords arguments of gdal.MultiDimTranslateOptions()
    If options is provided as a gdal.MultiDimTranslateOptions() 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]),}

  ### mapGRIORAMethodToString Value:
      {gdalconst.GRIORA_NearestNeighbour: 'near', gdalconst.GRIORA_Bilinear:
       'bilinear', gdalconst.GRIORA_Cubic: 'cubic', gdalconst.GRIORA_CubicSp
      line: 'cubicspline', gdalconst.GRIORA_Lanczos: 'lanczos', gdalconst.GR
      IORA_Average: 'average', gdalconst.GRIORA_RMS: 'rms', gdalconst.GRIORA
      _Mode: 'mode', gdalconst.GRIORA_Gauss: 'gauss',}

  ### ExtendedDataType_swigregister Value:
      _gdal.ExtendedDataType_swigregister

  ### RasterAttributeTable_swigregister Value:
      _gdal.RasterAttributeTable_swigregister

  ### GVOT_MIN_TARGET_HEIGHT_FROM_DEM Value:
      _gdal.GVOT_MIN_TARGET_HEIGHT_FROM_DEM

  ### GVOT_MIN_TARGET_HEIGHT_FROM_GROUND Value:
      _gdal.GVOT_MIN_TARGET_HEIGHT_FROM_GROUND

  ### GDALTransformerInfoShadow_swigregister Value:
      _gdal.GDALTransformerInfoShadow_swigregister

  ### GDALMultiDimInfoOptions_swigregister Value:
      _gdal.GDALMultiDimInfoOptions_swigregister

  ### GDALTranslateOptions_swigregister Value:
      _gdal.GDALTranslateOptions_swigregister

  ### GDALWarpAppOptions_swigregister Value:
      _gdal.GDALWarpAppOptions_swigregister

  ### GDALVectorTranslateOptions_swigregister Value:
      _gdal.GDALVectorTranslateOptions_swigregister

  ### GDALDEMProcessingOptions_swigregister Value:
      _gdal.GDALDEMProcessingOptions_swigregister

  ### GDALNearblackOptions_swigregister Value:
      _gdal.GDALNearblackOptions_swigregister

  ### GDALRasterizeOptions_swigregister Value:
      _gdal.GDALRasterizeOptions_swigregister

  ### GDALBuildVRTOptions_swigregister Value:
      _gdal.GDALBuildVRTOptions_swigregister

  ### GDALMultiDimTranslateOptions_swigregister Value:
      _gdal.GDALMultiDimTranslateOptions_swigregister