arcgis.env module
Theenv module provides a shared environment used by the different modules.It stores globals such as the currently activeGIS, the default geocoder and so on.It also stores environment settings that are common among all geoprocessing tools,such as the output spatial reference.
active_gis
The currently activeGIS, that is used for analysis functions unless explicitly specifiedwhen calling the functions.Creating a newGIS object makes it active unless set_active=False is passed in theGIS constructor.
analysis_extent
The processing extent used by analysis tools, specified as anEnvelope .
out_spatial_reference
The spatial reference of the output geometries. If not specified, the output geometries are in thespatial reference of the input geometries. If process_spatial_reference is specified and out_spatial_referenceis not specified, the output geometries are in the spatial reference of the process spatial reference.
process_spatial_reference
The spatial reference that the geoprocessor will use to perform geometry operations. If specified andout_spatial_reference is not specified, the output geometries are in the spatial reference of theprocess spatial reference.
output_datastore
The data store where GeoAnalytics results should be stored. The supported values of this parameter arerelational andspatiotemporal. By default, results are stored in the spatiotemporal data store. It is recommended that results arestored in the spatiotemporal data store due to the scalability of the spatiotemporal big data store.
return_z
IfTrue, Z values will be included in the geoprocessing results if the features have Z values.Otherwise Z values are not returned. The default isFalse.
return_m
IfTrue, M values will be included in the results if the features have M values.Otherwise M values are not returned. The default isFalse.
verbose
IfTrue, messages from geoprocessing tools will be printed to stdout.In any case, all geoprocessing messages are available through Python logging module. The default isFalse.
default_aggregation_styles
Tasks that have the default_aggregation_styles property set toTrue will set the default aggregations for theresulting layer. Default aggregations can be square, pointy triangle, flat triangle, pointy hexagon, flathexagon, and geohash. All aggregation styles are supported using WKID 4326 (WGS_1984).The default_aggregation_styles isFalse. (supported at 10.6.1+)
snap_raster
Tasks that honor the snap_raster environment will adjust the extent of output rastersso that they match the cell alignment of the specified snap raster.(For more information about this environment setting,please refer toSnap Raster (Environment setting))
cell_size
Tasks that honor the cell_size environment setting set the output raster cell size, or resolution,for the operation. The default output resolution is determined by the largest cell size ofall the input rasters.(For more information about this environment setting,please refer toCell Size (Environment setting))
mask
Tasks that honor the mask environment will only consider those cells that fall within the analysismask in the operation(For more information about this environment setting,please refer toMask (Environment setting))
parallel_processing_factor
Tasks that honor the parallel_processing_factor environment will divide and perform operations acrossmultiple processes.(For more information about this environment setting,please refer toParallel Processing Factor (Environment setting))
union_dimension
Tasks (raster functions present infunctions module) that honor the union_dimension environmentwill generate a multidimensional raster that includes all the dimensions from the input multidimensional rasters.(For more information about this environment setting,please refer toUnion Dimension (Environment setting))
match_variables
Tasks (raster functions present infunctions module) that honor the match_variables environmentwill generate a multidimensional raster only if the input multidimensional rasters share at least one variablewith the same name.(For more information about this environment setting,please refer toMatch Multidimensional Variable (Environment setting))