Manage Multidimensional Raster (Multidimension Tools)
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
.crffile, 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_modeparameter is set toTRUNCATE_DIMENSION_VALUESand 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
| 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.
|
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.
|
Boolean |
|
Update Transpose (Optional) |
Specifies whether the transpose will be rebuilt for the multidimensional raster dataset.
|
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.
|
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.
|
String |
|
Dimension Definition (Optional) |
Specifies how the dimension will be sliced.
|
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 |
Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes