GeoEco.Datasets.ArcGIS.ArcGISRasterBand.ConstructFromArcGISPath
- classmethod ArcGISRasterBand.ConstructFromArcGISPath(path, decompressedFileToReturn=None, queryableAttributeValues=None, lazyPropertyValues=None, cacheDirectory=None)
Given a path to a raster, returns an
ArcGISRasterBand.This is a convenience function that allows an
ArcGISRasterBandto be instantiated with a single function call, rather than instantiating anArcGISRasterand then querying it to get theArcGISRasterBand, which is how this function is implemented. TheArcGISRasteris not returned but is referenced as the parent collection of theArcGISRasterBandthat is returned. It will be garbage collected automatically when theArcGISRasterBandis deleted.- Parameters:
path (
str) – ArcGIS catalog path to the raster or a raster band. If a path to a raster is given, the first band will be opened. If a path to a band is given, that band will be opened. Minimum length꞉ 1.decompressedFileToReturn (
str, optional) –glob()expression that identifies the extracted file to open when the path points to an archive (e.g. a .zip or .tar file). Minimum length꞉ 1.queryableAttributeValues (
dictmappingstrtoobject, optional) – Values of the queryable attributes, expressed as a dictionary mapping the case-insensitive names of queryable attributes to their values.lazyPropertyValues (
dictmappingstrtoobject, optional) – Lazy properties to set when this object is constructed, expressed as a dictionary mapping the names of lazy properties to their values.cacheDirectory (
str, optional) –Directory to cache a copy of the downloaded or decompressed file.
If provided, this directory will be checked for the file prior to download or decompression. If the file is found, the download and decompression will be skipped. Thus, when performing repetitive processing with remote or compressed datasets, you can speed up processing considerably by providing a cache directory.
Minimum length꞉ 1.
- Returns:
ArcGISRasterBandinstance.- Return type: