Match Multidimensional Variable (Environment setting)

Tools that honor the Match Multidimensional Variable environment will generate a multidimensional raster only if the input multidimensional rasters share at least one variable with the same name.

Usage notes

  • This setting is only applied when there is more than one raster input and the inputs are multidimensional raster datasets.
  • When the Match Multidimensional Variable environment is checked, a geoprocessing tool will run only if the variables in the input multidimensional rasters have the same name. If the variable names do not match, the tool will fail.
  • When the environment is not checked, the input multidimensional rasters can have variables with different names. This is necessary for tools that combine two different variables to generate an output. For example, you can use the Math tool to combine relative humidity and temperature variables to generate a heat index raster.

Dialog syntax

  • Checked—Supported tools will run only if the input multidimensional rasters have a variable with the same name. This is the default.
  • Unchecked—Supported tools will run even if the input multidimensional rasters do not share a variable with the same name.

Scripting syntax

arcpy.env.matchMultidimensionalVariable = boolean_option

ParameterExplanation

boolean_option

Specifies whether to force variable names to match in input multidimensional rasters. The default is True.

matchMultidimensionalVariable syntax

Script example

import arcpy

# Set the matchMultidimensionalVariable environment to False
arcpy.env.matchMultidimensionalVariable = False

Related topics