arcgis.raster.utils module

generate_direct_access_url

arcgis.raster.utils.generate_direct_access_url(expiration=None, *, gis=None)

Function to get the direct access url for user’s rasterStore on ArcGIS Online.

Argument

Description

expiration

Optional integer. Direct access URL expiration time in minutes. (The default is 1440 ie. 24 hours)

gis

Keyword only parameter. Optional GIS. The GIS on which this function runs. If not specified, the active GIS is used.

Returns

String. Direct Access URL

upload_imagery_to_agol_userstore

arcgis.raster.utils.upload_imagery_to_agol_userstore(files, direct_access_url=None, auto_renew=True, upload_properties=None, *, gis=None)

Uploads file/files to the user’s rasterstore on ArcGIS Online and returns the list of urls.

The list of urls can then be used with arcgis.raster.analytics.copy_raster() or arcgis.raster.analytics.create_image_collection() method to create imagery layers on ArcGIS Online.

For this functionality to work, Azure library packages for Python (Azure SDK for Python - azure-storage-blob: 12.1<= version <=12.9) needs to be pre-installed. Refer https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-python#install-the-package

Argument

Description

files

Required. It can be a folder, list of files or single file that needs to be uploaded.

direct_access_url

Optional string. The direct access url generated using generate_direct_access_url function. If not specified, the function would generate the direct access url internally which is valid for 1440 minutes.

auto_renew

Optional boolean. If set to True, function would continue uploading until the entire data is uploaded by auto renewing the direct access url. (The default is True)

upload_properties

Optional dictionary. upload_properties can be used to control specific upload parameters.

Available options:

  • “maxUploadConcurrency”: Optional integer. Maximum number of parallel connections to use for large uploads (when individual file/blob size exceeds 64MB). This is the max_concurrency parameter of the BlobClient.upload_blob() method. (The default is 6)

  • “maxWorkerThreads”: Optional integer. Maximum number of threads to execute asynchronously when uploading multiple files. This is the max_workers parameter of the ThreadPoolExecutor() class. (The default is None)

  • “displayProgress”: Optional boolean. If set to True, a progress bar will be displayed for tracking the progress of the uploads to user’s rasterstore. (The default is False)

Example:

{“maxUploadConcurrency”:8, “maxWorkerThreads”:20, “displayProgress”:True}

gis

Keyword only parameter. Optional GIS. The GIS on which this function runs. If not specified, the active GIS is used.

Returns

List of file paths.

# Usage Example: Generates an expirable direct access url and uploads files to the user's raster store.

sas_url = generate_direct_access_url(expiration=180, gis=gis)

uploaded_imagery = upload_imagery_to_agol_userstore(files=r"/path/to/data", 
                                                    direct_access_url=sas_url,
                                                    upload_properties={"displayProgress":True},
                                                    gis=gis
                                                    )

# Following snippet executes the copy_raster() function on the uploaded imagery to create imagery layer item on ArcGIS Online.

copy_raster_op = copy_raster(input_raster=uploaded_imagery,
                             raster_type_name="Raster Dataset",
                             output_name="output_layer",
                             gis=gis)

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.