arcgis.raster module

The arcgis.raster module containing classes and raster analysis functions for working with raster data and imagery layers.

Raster data is made up of a grid of cells, where each cell or pixel can have a value. Raster data is useful for storing data that varies continuously, as in a satellite image, a surface of chemical concentrations, or an elevation surface.

Use arcgis.raster.analytics.is_supported(gis) to check if raster analysis is supported in your GIS.

ImageryLayer

class arcgis.raster.ImageryLayer(url, gis=None)
add_rasters(rasterType, itemIds=None, serviceUrl=None, computeStatistics=False, buildPyramids=False, buildThumbnail=False, minimumCellSizeFactor=None, maximumCellSizeFactor=None, attributes=None, geodataTransforms=None, geodataTransformApplyMethod='esriGeodataTransformApplyAppend')

This operation is supported at 10.1 and later. The Add Rasters operation is performed on an image service resource. The Add Rasters operation adds new rasters to an image service (POST only). The added rasters can either be uploaded items, using the itemIds parameter, or published services, using the serviceUrl parameter. If itemIds is specified, uploaded rasters are copied to the image service’s dynamic image workspace location; if the serviceUrl is specified, the image service adds the URL to the mosaic dataset no raster files are copied. The serviceUrl is required input for the following raster types: Image Service, Map Service, WCS, and WMS.

Inputs:

itemIds - The upload items (raster files) to be added. Either
itemIds or serviceUrl is needed to perform this operation.

Syntax: itemIds=<itemId1>,<itemId2> Example: itemIds=ib740c7bb-e5d0-4156-9cea-12fa7d3a472c,

ib740c7bb-e2d0-4106-9fea-12fa7d3a482c
serviceUrl - The URL of the service to be added. The image service

will add this URL to the mosaic dataset. Either itemIds or serviceUrl is needed to perform this operation. The service URL is required for the following raster types: Image Service, Map Service, WCS, and WMS.

Example: serviceUrl=http://myserver/arcgis/services/Portland/ImageServer
rasterType - The type of raster files being added. Raster types

define the metadata and processing template for raster files to be added. Allowed values are listed in image service resource.

Example: Raster Dataset | CADRG/ECRG | CIB | DTED | Image Service | Map Service | NITF | WCS | WMS
computeStatistics - If true, statistics for the rasters will be
computed. The default is false.
Values: false | true
buildPyramids - If true, builds pyramids for the rasters. The
default is false.
Values: false | true
buildThumbnail - If true, generates a thumbnail for the rasters.
The default is false.
Values: false | true
minimumCellSizeFactor - The factor (times raster resolution) used

to populate the MinPS field (maximum cell size above which the raster is visible).

Syntax: minimumCellSizeFactor=<minimumCellSizeFactor> Example: minimumCellSizeFactor=0.1
maximumCellSizeFactor - The factor (times raster resolution) used

to populate MaxPS field (maximum cell size below which raster is visible).

Syntax: maximumCellSizeFactor=<maximumCellSizeFactor> Example: maximumCellSizeFactor=10
attributes - Any attribute for the added rasters.

Syntax: {

“<name1>” : <value1>, “<name2>” : <value2>

} Example: {

“MinPS”: 0, “MaxPS”: 20; “Year” : 2002, “State” : “Florida”

}

geodataTransforms - The geodata transformations applied on the

added rasters. A geodata transformation is a mathematical model that performs a geometric transformation on a raster; it defines how the pixels will be transformed when displayed or accessed. Polynomial, projective, identity, and other transformations are available. The geodata transformations are applied to the dataset that is added.

Syntax: [ {

“geodataTransform” : “<geodataTransformName1>”, “geodataTransformArguments” : {<geodataTransformArguments1>} }, { “geodataTransform” : “<geodataTransformName2>”, “geodataTransformArguments” : {<geodataTransformArguments2>} }

]

The syntax of the geodataTransformArguments property varies based on the specified geodataTransform name. See Geodata Transformations documentation for more details.

geodataTransformApplyMethod - This parameter defines how to apply

the provided geodataTransform. The default is esriGeodataTransformApplyAppend.

Values: esriGeodataTransformApplyAppend | esriGeodataTransformApplyReplace | esriGeodataTransformApplyOverwrite
colormap()

The colormap resource returns RGB color representation of pixel values. This resource is supported if the hasColormap property of the service is true.

export_image(bbox, imageSR, bboxSR, size=None, time=None, export_format='jpgpng', pixelType='UNKNOWN', noData=None, noDataInterpretation='esriNoDataMatchAny', interpolation=None, compression=None, compressionQuality=75, bandIds=None, moasiacRule=None, renderingRule='', f='json', saveFolder=None, saveFile=None)

The exportImage operation is performed on an image service resource The result of this operation is an image resource. This resource provides information about the exported image, such as its URL, extent, width, and height. In addition to the usual response formats of HTML and JSON, you can also request the image format while performing this operation. When you perform an export with the image format , the server responds by directly streaming the image bytes to the client. With this approach, you don’t get any information associated with the exported image other than the image itself.

Inputs:
bbox - The extent (bounding box) of the exported image. Unless
the bboxSR parameter has been specified, the bbox is assumed to be in the spatial reference of the image service.

imageSR - The spatial reference of the exported image. bboxSR - The spatial reference of the bbox. size - The size (width * height) of the exported image in

pixels. If size is not specified, an image with a default size of 400 * 400 will be exported.

time - The time instant or the time extent of the exported image. export_format - The format of the exported image. The default format is

jpgpng. Values: jpgpng | png | png8 | png24 | jpg | bmp | gif |

tiff | png32
pixelType - The pixel type, also known as data type, pertains to
the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals.

noDate - The pixel value representing no information. noDataInterpretation - Interpretation of the noData setting. The

default is esriNoDataMatchAny when noData is a number, and esriNoDataMatchAll when noData is a comma-delimited string: esriNoDataMatchAny | esriNoDataMatchAll.
interpolation - The resampling process of extrapolating the
pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.
compression - Controls how to compress the image when exporting
to TIFF format: None, JPEG, LZ77. It does not control compression on other formats.
compressionQuality - Controls how much loss the image will be
subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100.
bandIds - If there are multiple bands, you can specify a single
band to export, or you can change the band combination (red, green, blue) by specifying the band number. Band number is 0 based.
mosaicRule - Specifies the mosaic rule when defining how
individual images should be mosaicked. When a mosaic rule is not specified, the default mosaic rule of the image service will be used (as advertised in the root resource: defaultMosaicMethod, mosaicOperator, sortField, sortValue).
renderingRule - Specifies the rendering rule for how the
requested image should be rendered.
f - The response format. default is json
Values: json | image | kmz
classmethod fromitem(item)
properties

The properties of this object

query(where='1=1', out_fields='*', timeFilter=None, geometryFilter=None, returnGeometry=True, returnIdsOnly=False, returnCountOnly=False, pixelSize=None, orderByFields=None, returnDistinctValues=True, outStatistics=None, groupByFieldsForStatistics=None)

queries a feature service based on a sql statement Inputs:

where - the selection sql statement out_fields - the attribute fields to return timeFilter - a TimeFilter object where either the start time

or start and end time are defined to limit the search results for a given time. The values in the timeFilter should be as UTC timestampes in milliseconds. No checking occurs to see if they are in the right format.
geometryFilter - a GeometryFilter object to parse down a given
query by another spatial dataset.
returnGeometry - true means a geometry will be returned,
else just the attributes
returnIdsOnly - false is default. True means only OBJECTIDs
will be returned
returnCountOnly - if True, then an integer is returned only
based on the sql statement
pixelSize-Query visible rasters at a given pixel size. If
pixelSize is not specified, rasters at all resolutions can be queried.
orderByFields-Order results by one or more field names. Use
ASC or DESC for ascending or descending order, respectively
returnDistinctValues- If true, returns distinct values
based on the fields specified in outFields. This parameter applies only if the supportsAdvancedQueries property of the image service is true.
outStatistics- the definitions for one or more field-based
statistics to be calculated.
groupByFieldsForStatistics-One or more field names using the
values that need to be grouped for calculating the statistics.
Output:
A list of Feature Objects (default) or a path to the output featureclass if returnFeatureClass is set to True.