hubdc.core

class hubdc.core.Column(x, z)

Bases: object

Class for managing image column location.

__init__(x, z)

Parameters:

• x (int) –
• z (int) –

x()

Returns column x coordinate.

z()

Returns column z coordinate.

class hubdc.core.ENVI

Bases: object

static findHeader(filenameBinary, ext='.hdr')

classmethod gdalType(enviType)

static numpyType(enviType)

static readHeader(filenameHeader)

static typeSize(enviType)

classmethod writeAttributeTable(filename, table)

Write attribute table values to csv file next to the given binary file.

static writeHeader(filenameHeader, metadata)

SPATIAL_KEYS = ['lines', 'samples', 'map info', 'projection info', 'coordinate system string']

class hubdc.core.ESRIShapefileDriver

Bases: hubdc.core.VectorDriver

ESRI Shapefile driver.

__init__()

Parameters:name (str) – e.g. ‘ESRI Shapefile’ or ‘GPKG’

class hubdc.core.EnviDriver

Bases: hubdc.core.RasterDriver

ENVI driver.

class Option

Bases: object

class INTERLEAVE

Bases: object

BIL = 'INTERLEAVE=BIL'

BIP = 'INTERLEAVE=BIP'

BSQ = 'INTERLEAVE=BSQ'

class SUFFIX

Bases: object

ADD = 'SUFFIX=ADD'

REPLACE = 'SUFFIX=REPLACE'

__init__()

Create instance from GDAL driver name and (optional) a list of default creation options.

class hubdc.core.ErdasDriver

Bases: hubdc.core.RasterDriver

Erdas Imagine driver.

__init__()

Create instance from GDAL driver name and (optional) a list of default creation options.

class hubdc.core.Extent(xmin, xmax, ymin, ymax, projection)

Bases: object

Class for managing extents (i.e. bounding boxes).

__init__(xmin, xmax, ymin, ymax, projection)

Parameters:

• xmin (number) –
• xmax (number) –
• ymin (number) –
• ymax (number) –
• projection (hubdc.core.Projection) –

centroid()

Returns the centroid.

equal(other, tol=1e-05)

Returns wether self is equal to other.

static fromGeometry(geometry)

Create an extent from the bounding box a Geometry.

geometry()

Returns self as a Geometry.

intersection(other)

Returns a new instance which is the intersection of self and other in the projection of self.

intersects(other)

Returns whether self and other intersects.

lowerLeft()

Returns the lower left corner.

lowerRight()

Returns the lower right corner.

projection()

Returns the Projection.

reproject(projection)

Reproject self into the given projection.

union(other)

Returns a new instance which is the union of self with other in the projection of self.

upperLeft()

Returns the upper left corner.

upperRight()

Returns the upper right corner.

xmax()

Returns the xmax.

xmin()

Returns the xmin.

ymax()

Returns the ymax.

ymin()

Returns the ymin.

class hubdc.core.Feature(ogrFeature, projection=None)

Bases: object

__init__(ogrFeature, projection=None)

Initialize self. See help(type(self)) for accurate signature.

geometry()

ogrFeature()

projection()

value(attribute)

class hubdc.core.GTiffDriver

Bases: hubdc.core.RasterDriver

GTiff driver.

class Option

Bases: object

class ALPHA

Bases: object

NON_PREMULTIPLIED = 'ALPHA=NON-PREMULTIPLIED'

PREMULTIPLIED = 'ALPHA=PREMULTIPLIED'

UNSPECIFIED = 'ALPHA=UNSPECIFIED'

YES = 'ALPHA=YES'

class BIGTIFF

Bases: object

IF_NEEDED = 'BIGTIFF=IF_NEEDED'

IF_SAFER = 'BIGTIFF=IF_SAFER'

NO = 'BIGTIFF=NO'

YES = 'BIGTIFF=YES'

class COMPRESS

Bases: object

CCITTFAX3 = 'COMPRESS=CCITTFAX3'

CCITTFAX4 = 'COMPRESS=CCITTFAX4'

CCITTRLE = 'COMPRESS=CCITTRLE'

DEFLATE = 'COMPRESS=PACKBITS'

JPEG = 'COMPRESS=JPEG'

LERC = 'COMPRESS=LERC'

LERC_DEFLATE = 'COMPRESS=LERC_DEFLATE'

LERC_ZSTD = 'COMPRESS=LERC_ZSTD'

LZMA = 'COMPRESS=LZMA'

LZW = 'COMPRESS=LZW'

NONE = 'COMPRESS=NONE'

PACKBITS = 'COMPRESS=JPEG'

WEBP = 'COMPRESS=WEBP'

ZSTD = 'COMPRESS=ZSTD'

class COPY_SRC_OVERVIEWS

Bases: object

NO = 'COPY_SRC_OVERVIEWS=NO'

YES = 'COPY_SRC_OVERVIEWS=YES'

class GEOTIFF_KEYS_FLAVOR

Bases: object

ESRI_PE = 'GEOTIFF_KEYS_FLAVOR=ESRI_PE'

STANDARD = 'GEOTIFF_KEYS_FLAVOR=STANDARD'

class INTERLEAVE

Bases: object

BAND = 'INTERLEAVE=BAND'

PIXEL = 'INTERLEAVE=PIXEL'

class PHOTOMETRIC

Bases: object

CIELAB = 'PHOTOMETRIC=CIELAB'

CMYK = 'PHOTOMETRIC=CMYK'

ICCLAB = 'PHOTOMETRIC=ICCLAB'

ITULAB = 'PHOTOMETRIC=ITULAB'

MINISBLACK = 'PHOTOMETRIC=MINISBLACK'

MINISWHITE = 'PHOTOMETRIC=MINISWHITE'

RGB = 'PHOTOMETRIC=RGB'

YCBCR = 'PHOTOMETRIC=YCBCR'

class PIXELTYPE

Bases: object

DEFAULT = 'PIXELTYPE=DEFAULT'

SIGNEDBYTE = 'PIXELTYPE=SIGNEDBYTE'

class PREDICTOR

Bases: object

FloatingPoint = 'PREDICTOR=3'

HorizontalDifferencing = 'PREDICTOR=2'

NONE = 'PREDICTOR=1'

class PROFILE

Bases: object

BASELINE = 'PROFILE=BASELINE'

GDALGeoTIFF = 'PROFILE=GDALGeoTIFF'

GeoTIFF = 'PROFILE=GeoTIFF'

class SPARSE_OK

Bases: object

FALSE = 'SPARSE_OK=FALSE'

TRUE = 'SPARSE_OK=TRUE'

class TILED

Bases: object

NO = 'TILED=NO'

YES = 'TILED=YES'

class WEBP_LOSSLESS

Bases: object

FALSE = 'WEBP_LOSSLESS=FALSE'

TRUE = 'WEBP_LOSSLESS=TRUE'

static BLOCKXSIZE(n=256)

static BLOCKYSIZE(n=256)

static JPEG_QUALITY(n=75)

static MAX_Z_ERROR(threshold=0)

static NBITS(n)

static NUM_THREADS(n='ALL_CPUS')

static WEBP_LEVEL(n=75)

static ZLEVEL(n=6)

static ZSTD_LEVEL(n=9)

__init__()

Create instance from GDAL driver name and (optional) a list of default creation options.

class hubdc.core.GeoPackageDriver

Bases: hubdc.core.VectorDriver

ESRI Shapefile driver.

__init__()

Parameters:name (str) – e.g. ‘ESRI Shapefile’ or ‘GPKG’

class hubdc.core.Geometry(wkt, projection)

Bases: object

Class for managing geometries.

__init__(wkt, projection)

Create by given well known text string and Projection.

intersection(other)

Returns the intersection of self and other.

intersects(other)

Returns whether self and other intersect.

ogrGeometry()

Returns ogr.Geometry object.

projection()

Returns the Projection.

reproject(projection)

Reproject self into given projection.

union(other)

Returns the union of self and other.

within(other)

Returns whether self is within other.

wkt()

Returns well known text string.

class hubdc.core.Grid(extent, resolution)

Bases: object

Class for managing raster grids in terms of extent, resolution and projection.

__init__(extent, resolution)

Parameters:

• extent (hubdc.core.Extent) –
• resolution (hubdc.core.Resolution) –

anchor(point)

Returns a new instance that is anchored to the given point. Anchoring will result in a subpixel shift. See the source code for implementation details.

atResolution(resolution)

Return grid with same extent and projection, but new resolution.

clip(extent)

Return self clipped by given extent.

equal(other, tol=1e-05)

Returns whether self is equal to other.

extent()

Returns the Extent.

geoTransform()

Returns a GDAL georeferencing transform tuple (xmin, xres, 0, ymax, 0, -yres) from bounds and resolution, without any rotation or shearing.

pixelBuffer(buffer, left=True, right=True, up=True, down=True)

Returns a new instance with a pixel buffer applied in different directions.

Parameters:

• buffer (int) – number of pixels to be buffered (can also be negativ)
• left (bool) – whether to buffer to the left/west
• right (bool) – whether to buffer to the right/east
• up (bool) – whether to buffer upwards/north
• down (bool) – whether to buffer downwards/south

Returns:

Return type:

hubdc.core.Grid

projection()

Returns the Projection.

reproject_OLD(other)

Returns a new instance with: a) extent reprojected into the projection of other, b) resolution of other, and c) anchored to other.

resolution()

Returns the Resolution.

shape()

Returns size as (ysize, xsize) tuple.

size()

Returns the Size.

subgrids(size)

Returns the decomposition of self into subgrids of given size. Subgrids at the border are trimmed to the extent of self.

subset(offset, size, trim=False)

Returns a new instance that is a subset given by an offset location and a raster size. Optionally set trim=True to restrain the grid extent to the extent of self.

xMapCoordinates()

Returns the list of map coordinates in x dimension.

xMapCoordinatesArray()

Returns the 2d array of map x coordinates.

xPixelCoordinates(offset=0)

Returns the list of pixel coordinates in x dimension with optional offset.

xPixelCoordinatesArray(offset=0)

Returns the 2d array of pixel x coordinates with optional offset.

yMapCoordinates()

Returns the list of map coordinates in y dimension.

yMapCoordinatesArray()

Returns the 2d array of map y coordinates.

yPixelCoordinates(offset=0)

Returns the list of pixel coordinates in y dimension with optional offset.

yPixelCoordinatesArray(offset=0)

Returns the 2d array of pixel y coordinates with optional offset.

class hubdc.core.MapViewer

Bases: object

__init__()

Initialize self. See help(type(self)) for accurate signature.

addLayer(layer)

extent()

onKeyPressed(e)

projection()

resize(xsize=None, ysize=None)

save(filename)

setExtent(extent)

setProjection(projection)

show(size=None)

class hubdc.core.MemDriver

Bases: hubdc.core.RasterDriver

MEM driver.

__init__()

Create instance from GDAL driver name and (optional) a list of default creation options.

class hubdc.core.MemoryDriver

Bases: hubdc.core.VectorDriver

Memory driver.

__init__()

Parameters:name (str) – e.g. ‘ESRI Shapefile’ or ‘GPKG’

class hubdc.core.MetadataFormatter

Bases: object

Class for managing GDAL metadata value formatting.

classmethod stringToValue(string, dtype)

Returns a representation of string as value of given dtype. If string represents a list of values in curly brackets (e.g. {1, 2, 3}), a list of values is returned.

classmethod valueToString(value)

Returns a string representation of value.

class hubdc.core.Pixel(x, y)

Bases: object

Class for managing image pixel location.

__init__(x, y)

Parameters:

• x (int) –
• y (int) –

static parse(obj)

Create instance from given Pixel or (number, number) object.

x()

Returns pixel x coordinate.

y()

Returns pixel y coordinate.

class hubdc.core.Point(x, y, projection)

Bases: hubdc.core.Geometry

Class for managing map locations.

__init__(x, y, projection)

Create point geometry by x and y coordinates and projection.

projection()

Returns the Projection.

reproject(projection)

Reproject self into given projection.

x()

Returns map x coordinate.

y()

Returns map y coordinate.

class hubdc.core.Projection(wkt)

Bases: object

Class for managing projections.

__init__(wkt)

Create by given well known text string.

equal(other)

Returns whether self is equal to other.

static fromEpsg(epsg)

Create by given epsg authority ID.

osrSpatialReference()

Returns osr.SpatialReference object.

classmethod utm(zone, north=True)

Create UTM projection of given zone.

static wgs84()

Create WGS84 projection (epsg=4326), also see http://spatialreference.org/ref/epsg/wgs-84/

static wgs84WebMercator()

Create WGS84 Web Mercator projection (epsg=3857), also see http://spatialreference.org/ref/sr-org/7483/

wkt()

Returns the well known text string.

class hubdc.core.PseudoGrid(size)

Bases: hubdc.core.Grid

__init__(size)

Parameters:

• extent (hubdc.core.Extent) –
• resolution (hubdc.core.Resolution) –

static fromArray(array)

class hubdc.core.RasterBandDataset(raster, index)

Bases: object

Class for managing raster band datasets.

__init__(raster, index)

Creating a new instance given a Raster and a raster band index.

array(grid=None, resampleAlg=<Mock name='mock.gdal.GRA_NearestNeighbour' id='139880523761312'>, noDataValue=None, errorThreshold=0.0, warpMemoryLimit=104857600, multithread=False)

Returns raster band data as 2d array of shape = (ysize, xsize) for the given grid, where zsize is the number of raster bands, and ysize, xsize = grid.shape().

Parameters:

• grid (hubdc.core.Grid) – if not specified self.grid() is used
• resampleAlg (int) – one of the GDAL resampling algorithms gdal.GRA_*
• noDataValue (float) – if not specified, no data value of self is used
• errorThreshold (float) – error threshold for approximation transformer (in pixels)
• warpMemoryLimit (int) – size of working buffer in bytes
• multithread (bool) – whether to multithread computation and I/O operations

Returns:

Return type:

numpy.ndarray

categoryColors()

Returns band category colors as list of rgba tuples.

categoryNames()

Returns band category names.

copyMetadata(other)

Copy raster and raster band metadata from self to other

description()

Returns band description.

fill(value)

Write constant value to the whole raster band.

flushCache()

Flush the cache.

gdalBand()

Return the gdal.Band.

index()

Returns the raster band index.

mapLayer()

mapViewer()

metadataDict()

Return the metadata dictionary for all domains.

metadataDomain(domain='')

Return the metadata dictionary for the given domain.

metadataDomainList()

Returns the list of metadata domain names.

metadataItem(key, domain='', default=None, required=False, dtype=<class 'str'>)

Return the metadata item.

noDataValue(default=None, required=False)

Returns band no data value. Returns default if no data value is undefined, or raises an error if required.

raster()

Returns the RasterDataset.

readAsArray(grid=None, resample_alg=<Mock name='mock.gdal.GRA_NearestNeighbour' id='139880523761312'>)

Returns raster band data as 2d array.

Parameters:

• grid (hubdc.core.Grid) – if provided, only data inside the grid extent is returned.
• resampleAlg (int) – one of the GDAL resampling algorithms (i.e. gdal.GRA_*)

Returns:

Return type:

numpy.ndarray

setCategoryColors(colors)

Set band category colors from list of rgba tuples.

setCategoryNames(names)

Set band category names.

setDescription(value)

Set band description.

setMetadataItem(key, value, domain='')

Set a metadata item. value can be a string, a number or a list of strings or numbers.

setNoDataValue(value)

Set no data value.

writeArray(array, grid=None)

Writes raster data.

Parameters:

• array (3d array | list of 2d arrays) –
• grid (hubdc.core.Grid) – if provided, data is written to the location given by the grid extent

xprofile(y)

Returns raster data as 1d array for the given row y.

yprofile(x)

Returns raster data as 1d array for the given column x.

class hubdc.core.RasterDataset(gdalDataset)

Bases: object

Class for managing raster datasets files.

__init__(gdalDataset)

Create an instance by a given gdal.Dataset.

acquisitionTime()

Returns the acquisition time. Restore it from ‘acquisition time’ metadata item inside the ‘ENVI’ domain.

Returns: Return type:datetime.datetime

array(indices=None, grid=None, resampleAlg=<Mock name='mock.gdal.GRA_NearestNeighbour' id='139880523761312'>, noDataValue=None, forceWarp=True, errorThreshold=0.0, warpMemoryLimit=104857600, multithread=False)

Returns raster data as 3d array of shape = (zsize, ysize, xsize) for the given grid, where zsize is the number of raster bands, and ysize, xsize = grid.shape().

Parameters:

• indices (list) – band indices to read (default is all bands)
• grid (hubdc.core.Grid) – if not specified self.grid() is used
• resampleAlg (int) – one of the GDAL resampling algorithms gdal.GRA_*
• noDataValue (float) – if not specified, no data value of self is used
• errorThreshold (float) – error threshold for approximation transformer (in pixels)
• warpMemoryLimit (int) – size of working buffer in bytes
• multithread (bool) – whether to multithread computation and I/O operations

Returns:

Return type:

numpy.ndarray

band(index)

Return the RasterBandDataset given by index.

bands()

Returns an iterator over each RasterBandDataset.

close()

Close the gdal.Dataset.

copyCategories(other)

Copy raster band category names and lookup tables.

copyMetadata(other)

Copy raster and raster band metadata from other to self.

description()

Returns the description.

driver()

Return the Driver.

dtype()

Returns the raster data type.

extent()

Return the Extent.

filename()

Return filename.

filenames()

Return gdal dataset file list``

flushCache()

Flush the cache.

static fromArray(array, grid=None, filename='', driver=None, options=None)

Creates a new raster file with content, data type and number of bands given by array and with extent, resolution and projection given by grid.

Parameters:

• array (numpy.ndarray) –
• grid (hubdc.core.Grid) –
• filename (str) – output filename
• driver (hubdc.core.RasterDriver) –
• options (list) – raster creation options

Returns:

Return type:

hubdc.core.RasterDataset

gdalDataset()

Return the gdal.Dataset.

gdalType()

Returns the raster data type.

grid()

Return the Grid.

mapLayer()

metadataDict()

Returns the metadata dictionary for all domains.

metadataDomain(domain='')

Returns the metadata dictionary for the given domain.

metadataDomainList()

Returns the list of metadata domain names.

metadataItem(key, domain='', dtype=<class 'str'>, required=False, default=None)

Returns the value (casted to a specific dtype) of a metadata item.

noDataValue(default=None, required=False)

Returns no data value. Returns default if all band no data values are undefined, or raises Raises an exception if not all bands share the same no data value.

If all bands are without a no data value, default is returned.

noDataValues(default=None, required=False)

Returns band no data values. For bands without a no data value, default is returned, or if required is True, an error is raised

plotCategoryBand(index=0, noPlot=False, showPlot=True)

plotMultibandColor(rgbindex=(0, 1, 2), rgbvmin=(None, None, None), rgbvmax=(None, None, None), rgbpmin=(None, None, None), rgbpmax=(None, None, None), noPlot=False, showPlot=True)

plotSinglebandGrey(index=0, vmin=None, vmax=None, pmin=None, pmax=None, cmap='gray', noPlot=False, showPlot=True)

cmap see https://matplotlib.org/examples/color/colormaps_reference.html https://matplotlib.org/api/_as_gen/matplotlib.pyplot.imshow.html

plotXProfile(row, plotWidget=None, yscale=1.0, **kwargs)

plotYProfile(column, plotWidget=None, yscale=1.0, **kwargs)

plotZProfile(pixel, plotWidget=None, spectral=False, xscale=1.0, yscale=1.0, **kwargs)

projection()

Return the Projection.

readAsArray(grid=None, resampleAlg=<Mock name='mock.gdal.GRA_NearestNeighbour' id='139880523761312'>)

Returns raster data as 3d array.

Parameters:

• grid (hubdc.core.Grid) – if provided, only data inside the grid extent is returned
• resampleAlg (int) – one of the GDAL resampling algorithms (i.e. gdal.GRA_*)

Returns:

Return type:

numpy.ndarray

reopen(eAccess=<Mock name='mock.gdal.GA_ReadOnly' id='139880523761424'>)

Returns re-opened version of itself. Useful in cases where flushCache is not sufficient.

setAcquisitionTime(acquisitionTime)

Set the acquisition time. Store it as ‘acquisition time’ metadata item inside the ‘ENVI’ domain.

Parameters:acquisitionTime (datetime.datetime) –

setDescription(value)

Set the description.

setGrid(grid)

Set the Grid.

setMetadataDict(metadataDict)

Set the metadata dictionary

setMetadataDomain(metadataDomain, domain)

Set the metadata domain

setMetadataItem(key, value, domain)

Set a metadata item. value can be a string, a number or a list of strings or numbers.

setNoDataValue(value)

Set a single no data value to all bands.

setNoDataValues(values)

Set band no data values.

shape()

Returns the (zsize, ysize, xsize) tuple.

translate(grid=None, filename='', driver=None, options=None, resampleAlg=None, **kwargs)

Returns a new instance of self translated into the given grid (default is self.grid()).

Parameters:

• grid (hubdc.core.Grid) –
• filename (str) –
• driver (hubdc.core.RasterDriver) –
• options (list) – raster creation options
• resampleAlg (int) – GDAL resampling algorithm
• kwargs – passed to gdal.TranslateOptions

Returns:

Return type:

hubdc.core.RasterDataset

warp(grid=None, filename='', driver=MemDriver(), options=None, resampleAlg=None, **kwargs)

Returns a new instance of self warped into the given grid (default is self.grid()).

Parameters:

• grid (hubdc.core.Grid) –
• filename (str) – output filename
• driver (hubdc.core.RasterDriver) –
• options (list) – creation options
• kwargs – passed to gdal.WarpOptions

Returns:

Return type:

hubdc.core.RasterDataset

waveband(center)

Return the RasterBandDataset given by center wavelenth in nanometers.

writeArray(array, grid=None)

Writes raster data.

Parameters:

• array (3d array | list of 2d arrays) –
• grid (hubdc.core.Grid) – if provided, data is written to the location given by the grid extent

xprofile(row)

Returns raster data as 1d array for the given row.

xsize()

Returns raster x size in pixels.

yprofile(column)

Returns raster data as 1d array for the given column.

ysize()

Returns raster y size in pixels.

zprofile(pixel)

Returns raster data as 1d array for the given pixel.

zsize()

Returns raster z size in terms of number of raster bands.

class hubdc.core.RasterDriver(name, options=None)

Bases: object

Class for managing raster drivers

__init__(name, options=None)

Create instance from GDAL driver name and (optional) a list of default creation options.

create(grid, bands=1, gdalType=<Mock name='mock.gdal.GDT_Float32' id='139880517999752'>, filename='', options=None)

Creates a new raster file with extent, resolution and projection given by grid.

Parameters:

• grid (hubdc.core.Grid) –
• bands (int) – number of raster bands
• gdalType (int) – one of the gdal.GDT_* data types, or use gdal_array.NumericTypeCodeToGDALTypeCode
• filename (str) – output filename
• options (list) – raster creation options

Returns:

Return type:

hubdc.core.RasterDataset

equal(other)

Returns whether self is equal to the other driver.

classmethod fromFilename(filename)

gdalDriver()

Returns the GDAL driver object.

name()

Returns the driver name.

options()

Returns default creation options.

prepareCreation(filename)

Returns absolute filename and creates root folders if not existing.

setOptions(options=None)

Set the default options.

class hubdc.core.RasterLayer(qgsRasterLayer)

Bases: object

__init__(qgsRasterLayer)

Initialize self. See help(type(self)) for accurate signature.

initMultiBandColorRenderer(redIndex=0, greenIndex=1, blueIndex=2, redMin=None, redMax=None, greenMin=None, greenMax=None, blueMin=None, blueMax=None, percent=2)

Initialize a MultiBandColorRenderer for given band index.

initRendererFromQml(filename)

initSingleBandGrayRenderer(grayIndex=0, grayMin=None, grayMax=None, percent=2)

Initialize a SingleBandGrayRenderer.

initTrueColorRenderer(**kwargs)

mapViewer()

qgsLayer()

show()

class hubdc.core.RasterSize(x, y)

Bases: object

Class for managing image sizes.

__init__(x, y)

Parameters:

• x (number) –
• y (number) –

static parse(obj)

Create instance by parsing the given RasterSize object, a (number, number) tuple or list

x()

Returns the x size.

y()

Returns the y size.

class hubdc.core.ResampleAlgHandler

Bases: object

classmethod resampleAlgorithms()

classmethod toString(resampleAlg)

Return clear name of given resampleAlg.

classmethod translateResampleAlgorithms()

classmethod warpResampleAlgorithms()

class hubdc.core.Resolution(x, y)

Bases: object

Class for managing pixel resolutions.

__init__(x, y)

Parameters:

• x (float > 0) – resolution in x dimension
• y (float > 0) – resolution in y dimension

equal(other, tol=0.0)

Returns whether self is equal to other.

static parse(obj)

Create new instance from given Resolution object, number or (number, number) object.

x()

Returns x resolution.

y()

Returns y resolution.

class hubdc.core.Row(y, z)

Bases: object

Class for managing image row location.

__init__(y, z)

Parameters:

• y (int) –
• z (int) –

y()

Returns row y coordinate.

z()

Returns row z coordinate.

class hubdc.core.VectorDataset(ogrDataSource, layerNameOrIndex=0)

Bases: object

Class for managing vector layer datasets.

__init__(ogrDataSource, layerNameOrIndex=0)

Creates new instance from given ogr.DataSource and layer name or index given by nameOrIndex.

attributeTable()

close()

Closes the ogr.DataSourse and ogr.Layer

createFidDataset(filename, fidName='_fid')

Create a vector dataset with same features but only one FID attribute.

delete()

Closes and deletes/unlinks itself from disk/memory.

driver()

Return the Driver.

extent()

Returns the Extent.

extractPixel(rasterDataset)

Extracts all pixel profiles covert by self, together with all associated attribute.

Returns (rasterValues, vectorValues) tuple.

featureCount()

Returns the number of features.

features()

fieldCount()

Returns the number of attribute fields.

fieldNames()

Returns the attribute field names.

fieldTypeNames()

Returns the attribute field data type names.

filename()

Returns the filename.

static fromPoints(points, attributes=None, filename='', driver=MemoryDriver())

Create instance from given points. Projection is taken from the first point.

geometryTypeName()

Return the geometry type name.

grid(resolution)

Returns grid with extent of self and given resolution.

layerNameOrIndex()

Returns the layer name/index.

mapLayer()

mapViewer()

metadataDict()

Returns the metadata dictionary for all domains.

metadataDomain(domain='')

Returns the metadata dictionary for the given domain.

metadataDomainList()

Returns the list of metadata domain names.

metadataItem(key, domain='', dtype=<class 'str'>, required=False, default=None)

Returns the value (casted to a specific dtype) of a metadata item.

ogrDataSource()

Returns the ogr.DataSource.

ogrLayer()

Returns the ogr.Layer.

projection()

Returns the Projection.

rasterize(grid, gdalType=<Mock name='mock.gdal.GDT_Float32' id='139880517999752'>, initValue=0, burnValue=1, burnAttribute=None, allTouched=False, filterSQL=None, noDataValue=None, filename='', driver=None, options=None)

Returns a Raster that is the rasterization of self into the given grid as.

Parameters:

• grid (hubdc.core.Grid) –
• gdalType (int) – one of the GDAL data types gdal.GDT_*
• initValue (int) – value to pre-initialize the output array
• burnValue (int) – value to burn into the output array for all objects; exclusive with burnAttribute
• burnAttribute (str) – identifies an attribute field on the features to be used for a burn-in value; exclusive with burnValue
• allTouched (bool) – whether to enable 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
• filterSQL (str) – set an SQL WHERE clause which will be used to filter vector features
• noDataValue (float) – output raster no data value
• filename (str) – output filename
• driver (hubdc.core.RasterDriver) –
• options (list) – raster creation options

Returns:

Return type:

hubdc.core.RasterDataset

reproject(projection, filename='', driver=MemoryDriver(), **kwargs)

Returns a reprojection of self into the given projection. Optional kwargs are passed to gdal.VectorTranslateOptions.

setMetadataDict(metadataDict)

Set the metadata dictionary

setMetadataDomain(metadataDomain, domain)

Set the metadata domain

setMetadataItem(key, value, domain='')

Set a metadata item. value can be a string, a number or a list of strings or numbers.

translate(filename='', driver=MemoryDriver(), **kwargs)

Returns a translation of self. Optional kwargs are passed to gdal.VectorTranslateOptions.

zsize()

Returns number of layers (i.e. 1).

class hubdc.core.VectorDriver(name)

Bases: object

Class for managing OGR Drivers

__init__(name)

Parameters:name (str) – e.g. ‘ESRI Shapefile’ or ‘GPKG’

delete(filename)

Delete/unlink file given by filename.

equal(other)

Returns whether self is equal to the other driver.

classmethod fromFilename(filename)

name()

Returns the driver name.

ogrDriver()

Returns the OGR driver object.

prepareCreation(filename)

Deletes filename if it already exist and creates subfolders if needed.

class hubdc.core.VectorLayer(qgsVectorLayer)

Bases: object

__init__(qgsVectorLayer)

Initialize self. See help(type(self)) for accurate signature.

mapViewer()

qgsLayer()

show()

class hubdc.core.VrtDriver

Bases: hubdc.core.RasterDriver

VRT driver.

__init__()

Create instance from GDAL driver name and (optional) a list of default creation options.

hubdc.core.buildOverviews(filename, levels=None, minsize=1024, resampling='average')

Build image overviews (a.k.a. image pyramid) for raster given by filename. If the list of overview levels is not specified, overviews are generated for levels of powers of 2 (i.e. levels=[2, 4, 8…]) up to the level where the size of the overview is smaller than minsize.

Parameters:

• filename (str) – input filename
• minsize (int) – defines the levels (powers of 2) in the case where levels is None
• levels (Union[Tuple, List]) – list of overview levels
• resampling (str) – one of those: 'average', 'gauss', 'cubic', 'cubicspline', 'lanczos', 'average_mp', 'average_magphase', 'mode'

hubdc.core.createVRTDataset(rasterDatasetsOrFilenames, filename='', **kwargs)

Creates a virtual raster file (VRT) from raster datasets or filenames given by rastersOrFilenames.

Parameters:

• filename (str) – output filename
• rastersOrFilenames (Union[Tuple, List]) – list of filenames or rasters
• kwargs – all additional keyword arguments are passed to gdal.BuildVRTOptions

Returns:

Return type:

hubdc.core.RasterDataset

hubdc.core.openRasterDataset(filename, eAccess=<Mock name='mock.gdal.GA_ReadOnly' id='139880523761424'>)

Opens the raster given by filename.

Parameters:

• filename (str) – input filename
• eAccess (int) – access mode gdal.GA_ReadOnly or gdal.GA_Update

Returns:

Return type:

hubdc.core.RasterDataset

hubdc.core.openVectorDataset(filename, layerNameOrIndex=None, update=False)

Opens the vector layer given by filename and layerNameOrIndex.

Parameters:

• filename (str) – input filename
• layerNameOrIndex (int | str) – layer index or name
• update (bool) – whether to open in update mode

Returns:

Return type:

hubdc.core.VectorDataset