Manage Multidimensional Raster (Multidimension)

Summary

Edits a multidimensional raster by adding or deleting variables or dimensions.

Usage

• Use this tool to edit a multidimensional raster. This tool does not generate a new dataset; it modifies the multidimensional raster. To create a dataset, use the Subset Multidimensional Raster tool or the Copy Raster tool before making additional edits with this tool.

• The target and input rasters must be in Cloud Raster Format (CRF). Currently, no other format is supported in this tool. To convert a multidimensional mosaic dataset or a multidimensional raster layer to a .crf file, use the Copy Raster tool, choose CRF as the output format, and choose to process the dataset as multidimensional.

• The Manage Mode parameter sets the type of editing operation to be performed. The parameter supports the following options:

  • Add Dimension—Adds a dimension to the dataset. The name, description, and unit of the dimension must be provided. After the dimension is added, slices from another multidimensional dataset with the same dimension can be appended.

    Note:

    If an input CRF dataset is not a multidimensional raster, you cannot use this tool to create a multidimensional raster. Instead, use the Set Raster Properties tool to create a multidimensional raster.

  • Remove Dimension—Removes dimensions from the dataset. Each dimension to be removed can only contain a single value.
  • Append Slices—Adds slices from one or more input multidimensional rasters to the end of the stack of slices in the target multidimensional raster. The variable and dimension names in the multidimensional rasters must match exactly, and there can be no overlapping dimension values between the rasters. The appended slices must have dimension values that come after the end of the dimension values in the target multidimensional raster.
  • Replace Slices—Deletes slices from the target multidimensional raster and replaces them with slices from another multidimensional raster. The variable and dimension names in the multidimensional rasters must match exactly, and only the overlapping slices will be replaced.
  • Append Variables—Adds all the variables from one or more input multidimensional rasters to the end of the list of variables in the target multidimensional raster. If the variable name already exists in the target multidimensional raster, it will not be added. If multiple input multidimensional rasters contain a variable of the same name, the variable from the first listed input raster will be added to the target multidimensional raster.
  • Delete Variables—Deletes one or more variables, and the corresponding slices, from the target multidimensional raster. There must be at least one variable remaining in the multidimensional raster.
  • Truncate Dimension Values—Modifies the dimension values by truncating the date values, or selecting the start and end values if the dimension values are ranges.
  • Remove Slices—Removes a slice, or a range of slices, from a multidimensional raster.

• The Truncation Unit parameter specifies the date and time truncation unit that will be used. This parameter is required when the manage_mode parameter is set to TRUNCATE_DIMENSION_VALUES and the Dimension Name parameter is set to StdTime.

• The Truncation Unit parameter has the following options for truncating date values: Year, Month, Day, Hour, Minute, and Second. For example, if the time dimension value is 2013-03-19T12:30:00, the Hour option will truncate values after hours, resulting in a dimension value of 2013-03-19T12:00:00. Using the Month option will result in a dimension value of 2013-03-01T00:00:00. This parameter is only applicable when the Dimension Name parameter value is time based.

• All of the input data must have the exact same spatial reference, spatial extent, and cell size to use the Manage Mode parameter's Append Slices, Replace Slices, and Append Variables options.

• Removing slices from a CRF involves expensive file operations. The performance of removing slices from a CRF stored in the cloud may be affected.

Parameters

Dialog

Label	Explanation	Data Type
Target Multidimensional Raster	The multidimensional raster in CRF that will be modified.	Raster Dataset; Mosaic Dataset; Raster Layer; Mosaic Layer; Image Service; File
Manage Mode (Optional)	Specifies the type of modification that will be performed on the target raster. Add Dimension—A dimension will be added to the input multidimensional raster. Append Slices—Slices from the input multidimensional rasters will be added to the end of the slices for a dimension. This is the default. Append Variables—The variables from the input multidimensional rasters will be added. Replace Slices—Existing slices will be replaced by slices from another multidimensional raster, at specific dimension values. Delete Variables—One or more variables will be deleted from the multidimensional raster. Remove Dimension—A single slice multidimensional raster will be converted to a dimensionless raster. Truncate Dimension Values—The dimension values will be modified by truncating the date values, or selecting the start and end values if the dimension values are ranges. Remove Slices—A slice, or a range of slices, will be removed from the input multidimensional raster.	String
Variables (Optional)	The variable or variables that will be modified in the target multidimensional raster. This parameter is required if the operation being performed is a modification of an existing variable. If no variable is specified, the first variable in the target multidimensional raster will be modified.	String
Input Multidimensional Rasters (Optional)	The multidimensional raster datasets that contain the slices or variables that will be added to the target multidimensional raster. This parameter is required when the Manage Mode parameter is set to Append Slices, Replace Slices, or Append Variables.	Raster Dataset; Raster Layer; Image Service
Dimension Name (Optional)	The name of the dimension that will be added to or removed from the raster properties. This parameter is required when the Manage Mode parameter is set to Add Dimension, Truncate Dimension Values, or Remove Slices. If the Manage Mode parameter is set to Remove Dimension, the specified dimension can only contain a single value. If no value is specified for this parameter and the input only contains a single slice, all dimensions will be removed.	String
Dimension Value (Optional)	The value of the dimension that will be added or removed. The value can be a single value or a range of values. For a range of values, provide the minimum and maximum values separated by a comma. For example, for a new height dimension, enter 0,10 to generate a dimension in which the first slice contains information for the first 10 meters of height. This parameter is required when the Manage Mode parameter is set to Add Dimension or Remove Slices when the Dimension Definition parameter is set to By Values. If the Manage Mode parameter is set to Remove Slices, the value must be a single value.	String
Dimension Description (Optional)	The description of the new dimension that will be added to the raster properties for metadata purposes. This parameter is active when the Manage Mode parameter is set to Add Dimension.	String
Dimension Unit (Optional)	The unit of the new dimension that will be added to the raster properties for metadata purposes. This parameter is active when the Manage Mode parameter is set to Add Dimension.	String
Update Statistics (Optional)	Specifies whether the statistics will be recalculated for the multidimensional raster dataset. Checked—Statistics will be recalculated. This is the default. Unchecked—Statistics will not be recalculated.	Boolean
Update Transpose (Optional)	Specifies whether the transpose will be rebuilt for the multidimensional raster dataset. Checked—The transpose will be rebuilt. If no transpose exists, a new transpose will be built. This is the default. Unchecked—The transpose will not be rebuilt.	Boolean
Truncation Unit (Optional)	Specifies the date and time truncation unit that will be used. This parameter is required when the Manage Mode parameter is set to Truncate Dimension Values and the Dimension Name parameter is set to StdTime. Second—The specified time unit of truncation will be seconds. Minute—The specified time unit of truncation will be minutes. Hour—The specified time unit of truncation will be hours. Day—The specified time unit of truncation will be days. Month—The specified time unit of truncation will be months. Year—The specified time unit of truncation will be years.	String
Start/End Keyword (Optional)	Specifies how the dimension value will be truncated. This parameter is active when the Manage Mode parameter is set to Truncate Dimension Values. Start—The dimension value will be truncated on the start value. End—The dimension value will be truncated on the end value. Both—The dimension value will be truncated on both the start and end values.	String
Dimension Definition (Optional)	Specifies how the dimension will be sliced. By Values—The dimension will be sliced using a list of dimension values. This is the default. By Ranges—The dimension will be sliced using a range.	String
Minimum Value (Optional)	The minimum value of the range of slices that will be removed. This parameter is active when the Dimension Definition parameter is set to By Ranges.	String
Maximum Value (Optional)	The maximum value of the range of slices that will be removed. This parameter is active when the Dimension Definition parameter is set to By Ranges.	String

Derived Output

Label	Explanation	Data Type
Target Multidimensional Raster	The modified multidimensional raster.	Raster Layer

Python

arcpy.md.ManageMultidimensionalRaster(target_multidimensional_raster, {manage_mode}, {variables}, {in_multidimensional_rasters}, {dimension_name}, {dimension_value}, {dimension_description}, {dimension_unit}, {update_statistics}, {update_transpose}, {truncation_unit}, {startEnd_keyword}, {dimension_def}, {min_value}, {max_value})

Name	Explanation	Data Type
target_multidimensional_raster	The multidimensional raster in CRF that will be modified.	Raster Dataset; Mosaic Dataset; Raster Layer; Mosaic Layer; Image Service; File
manage_mode (Optional)	Specifies the type of modification that will be performed on the target raster. ADD_DIMENSION—A dimension will be added to the input multidimensional raster. APPEND_SLICES—Slices from the input multidimensional rasters will be added to the end of the slices for a dimension. This is the default. APPEND_VARIABLES—The variables from the input multidimensional rasters will be added. REPLACE_SLICES—Existing slices will be replaced by slices from another multidimensional raster, at specific dimension values. DELETE_VARIABLES—One or more variables will be deleted from the multidimensional raster. REMOVE_DIMENSION—A single slice multidimensional raster will be converted to a dimensionless raster. TRUNCATE_DIMENSION_VALUES—The dimension values will be modified by truncating the date values, or selecting the start and end values if the dimension values are ranges. REMOVE_SLICES—A slice, or a range of slices, will be removed from the input multidimensional raster.	String
variables [variables,...] (Optional)	The variable or variables that will be modified in the target multidimensional raster. This parameter is required if the operation being performed is a modification of an existing variable. If no variable is specified, the first variable in the target multidimensional raster will be modified.	String
in_multidimensional_rasters [in_multidimensional_rasters,...] (Optional)	The multidimensional raster datasets that contain the slices or variables that will be added to the target multidimensional raster. This parameter is required when the manage_mode parameter is set to APPEND_SLICES, REPLACE_SLICES, or APPEND_VARIABLES.	Raster Dataset; Raster Layer; Image Service
dimension_name (Optional)	The name of the dimension that will be added to or removed from the raster properties. This parameter is required when the manage_mode parameter is set to ADD_DIMENSION, TRUNCATE_DIMENSION_VALUES, or REMOVE_SLICES. If the manage_mode parameter is set to REMOVE_DIMENSION, the specified dimension can only contain a single value. If no value is specified for this parameter and the input only contains a single slice, all dimensions will be removed.	String
dimension_value (Optional)	The value of the dimension that will be added or removed. The value can be a single value or a range of values. For a range of values, provide the minimum and maximum values separated by a comma. For example, for a new height dimension, enter 0,10 to generate a dimension in which the first slice contains information for the first 10 meters of height. This parameter is required when the manage_mode parameter is set to ADD_DIMENSION or REMOVE_SLICES when the dimension_def parameter is set to BY_VALUES. If the manage_mode parameter is set to REMOVE_SLICES, the value must be a single value.	String
dimension_description (Optional)	The description of the new dimension that will be added to the raster properties for metadata purposes. This parameter is enabled when the manage_mode parameter is set to ADD_DIMENSION.	String
dimension_unit (Optional)	The unit of the new dimension that will be added to the raster properties for metadata purposes. This parameter is enabled when the manage_mode parameter is set to ADD_DIMENSION.	String
update_statistics (Optional)	Specifies whether the statistics will be recalculated for the multidimensional raster dataset. UPDATE_STATISTICS—Statistics will be recalculated. This is the default. NO_UPDATE_STATISTICS—Statistics will not be recalculated.	Boolean
update_transpose (Optional)	Specifies whether the transpose will be rebuilt for the multidimensional raster dataset. UPDATE_TRANSPOSE—The transpose will be rebuilt. If no transpose exists, a new transpose will be built. This is the default. NO_UPDATE_TRANSPOSE—The transpose will not be rebuilt.	Boolean
truncation_unit (Optional)	Specifies the date and time truncation unit that will be used. This parameter is required when the manage_mode parameter is set to TRUNCATE_DIMENSION_VALUES and the dimension_name parameter is set to STDTIME. SECOND—The specified time unit of truncation will be seconds. MINUTE—The specified time unit of truncation will be minutes. HOUR—The specified time unit of truncation will be hours. DAY—The specified time unit of truncation will be days. MONTH—The specified time unit of truncation will be months. YEAR—The specified time unit of truncation will be years.	String
startEnd_keyword (Optional)	Specifies how the dimension value will be truncated. This parameter is active when the manage_mode parameter is set to TRUNCATE_DIMENSION_VALUES. START—The dimension value will be truncated on the start value. END—The dimension value will be truncated on the end value. BOTH—The dimension value will be truncated on both the start and end values.	String
dimension_def (Optional)	Specifies how the dimension will be sliced. BY_VALUES—The dimension will be sliced using a list of dimension values. This is the default. BY_RANGES—The dimension will be sliced using a range.	String
min_value (Optional)	The minimum value of the range of slices that will be removed. This parameter is active when the dimension_def parameter is set to BY_RANGES.	String
max_value (Optional)	The maximum value of the range of slices that will be removed. This parameter is active when the dimension_def parameter is set to BY_RANGES.	String

Derived Output

Name	Explanation	Data Type
updated_target_multidimensional_raster	The modified multidimensional raster.	Raster Layer

Code sample

ManageMultidimensionalRaster example 1 (Python window)

This example appends slices to the end of a multidimensional raster and updates the statistics.

# Import system modules
import arcpy

# Append slices from two multidimensional rasters with temperature data
arcpy.md.ManageMutidimensionalRaster(
	"C:/data/temp1980_1990.crf", "APPEND_SLICES", "Temp", 
	["C:/new_data/temp1991.crf", "C:/new_data/temp1992.crf"],None,
	None,None, None, "UPDATE_STATISTICS")

ManageMultidimensionalRaster example 2 (stand-alone script)

This example replaces slices, adds a variable, and adds a dimension to the target multidimensional raster.

# Import system modules
import arcpy

# Define input parameters
target_multidimensional_raster = "C:/data/hycom.crf"
manage_mode_replace = "REPLACE_SLICES"
manage_mode_append = "APPEND_VARIABLES"
manage_mode_newDimension = "ADD_DIMENSION"
variables = "water_temp"
replace_multidimensional_rasters = "C:/new_data/new_hycom1985.crf"
salinity_multidimensional_raster = "C:/data/salinity.crf"
dimension_name = "Depth"
dimension_value = "0,5"
dimension_description = "Depth at 5m increments"
dimension_unit = "meter"
update_stats = "UPDATE_STATISTICS"
update_transpose = "UPDATE_TRANSPOSE"


# Replace existing slices with new slices
arcpy.md.ManageMutidimensionalRaster(target_multidimensional_raster,manage_mode_replace, 
	variables, replace_multidimensional_rasters)

# Append salinity variable
arcpy.md.ManageMutidimensionalRaster(target_multidimensional_raster, manage_mode_append,
	'', salinity_multidimensional_raster)
	
# Add a new dimension, depth, for the water temperature variable
# Depth will be measured in 5 meter increments
arcpy.md.ManageMutidimensionalRaster(target_multidimensional_raster, manage_mode_newDimension,
	variables, None, dimension_name, dimension_value, dimension_description, dimension_unit,
	update_stats, update_transpose)

ManageMultidimensionalRaster example 3 (stand-alone script)

This example removes dimensions from a single-slice multidimensional raster.

# Import system modules
import arcpy

# Define input parameters
target_multidimensional_raster = "C:/data/precip.crf"
manage_mode = "REMOVE_DIMENSION"

# Remove dimension to make input data dimensionless
arcpy.md.ManageMultidimensionalRaster(target_multidimensional_raster,
	manage_mode)

Environments

Parallel Processing Factor

Licensing information

• Basic: Yes
• Standard: Yes
• Advanced: Yes