ApplyEnvironment

Résumé

Creates a new raster that is a copy of the input raster with the current environment settings being applied.

Discussion

Use ApplyEnvironment when you want to apply environment settings to an existing raster (which can be a raster object or data on disk). For example, you may have an output from a previous analysis tool that you want to alter the cell size or clip to a mask.

The function creates a new raster object which is a copy of the input with the newly applied environment settings. Since the referenced raster dataset for the raster object is temporary, if you want to make it permanent you can call the raster object's save method. For example, outRas.save("C:/Data/outraster").

The ApplyEnvironment function can be used to create a raster of constant values by setting the cell size and extent environment settings and then entering a scalar value as input. For example, outConstant = ApplyEnvironment(5).

If the input is a multiband raster, the output will be a multiband raster. The function will perform the operation on each band in the input.

If the input is a multidimensional raster, all slices from all variables will be processed, and the output will be a multidimensional raster.

The following environment settings apply to the ApplyEnvironment function: Cell size, Cell size projection method, Current Workspace, Extent, Mask, Output Coordinate System, Scratch Workspace, and Snap Raster.

Syntaxe

ApplyEnvironment (in_raster)

Paramètre	Explication	Type de données
in_raster	The input raster dataset.	Raster

Valeur renvoyée

Type de données	Explication
Raster	The output raster.

Exemple de code

ApplyEnvironment example

Converts an elevation dataset's units from feet to meters then applies a new cell size and clips to a new mask extent.

import arcpy
from arcpy import env

#convert raster form meter to feet
elevMeter = Raster('C:/data/dem10') * 0.3048
env.cellsize = '30'
env.mask = 'C:/data/studyarea'

#create a new clipped raster based on the cellsize and mask environment settings
elevRasterClip = arcpy.ia.ApplyEnvironment(elevMeter)
elevRasterClip.save("C:/output/fgdb.gdb/dem30_m")