Summary
Creates a subset of a multidimensional raster by slicing data along defined variables and dimensions.
Usage
This tool creates a multidimensional raster layer from a multidimensional raster or mosaic dataset by extracting a subset of variables. For example, you have a mosaic dataset that contains 30 years of monthly precipitation data, and you only want to extract data for each January to see how precipitation has changed for that month.
Supported multidimensional raster datasets include netCDF, GRIB, HDF, and Esri's CRF. Multidimensional mosaic datasets are also supported.
This tool produces a multidimensional raster dataset in Cloud Raster Format (CRF). Currently, no other output formats are supported.
Use the Dimension Definition parameter to slice dimensions using an interval, a value, or a range of values. For example, if you have 10 years of ocean salinity data, collected monthly and at every 2 meters depth up to 500 meters, you might use the different dimension definition options for the following scenarios:
- Extract salinity data for the month of January over the 10-year period. Choose By Values, set Dimension to StdTime, and set Values to January.
- Slice salinity data over a depth range from 0 to 150 meters. Choose By Ranges, set Dimension to StdZ, and set Minimum Value to -150 and Maximum Value to 0.
- Extract salinity data for the first 10 days of every January over a 10-year period. Choose By Iteration, set Dimension to StdTime, set Start of first iteration and End of first iteration to the corresponding start and end of the iteration period, set Step to 1, and set Unit to Years.
By default, the multidimensional raster output will be compressed using the LZ77 compression type. It is recommended, however, that you change the compression type to LERC and adjust the Maximum Error based on your data. For example, if you expect the results of the analysis to be accurate to three decimal places, use 0.001 for the Maximum Error. It's best to avoid unnecessary accuracy requirements, as they will increase the processing time and storage size.
To change the compression type, modify the Environment setting.
Syntax
SubsetMultidimensionalRaster(in_multidimensional_raster, out_multidimensional_raster, {variables}, {dimension_def}, {dimension_ranges}, {dimension_values}, {dimension}, {start_of_first_iteration}, {end_of_first_iteration}, {iteration_step}, {iteration_unit})| Parameter | Explanation | Data Type |
in_multidimensional_raster | The input multidimensional raster dataset. Supported inputs include netCDF, GRIB, HDF or CRF files, a multidimensional mosaic dataset, or a multidimensional raster layer. | Raster Dataset; Raster Layer; Mosaic Dataset; Mosaic Layer; Image Service; File |
out_multidimensional_raster | The output multidimensional raster dataset. | Raster Dataset |
variables [variables,...] (Optional) | The variables that will be included in the output multidimensional raster. If no variable is specified, all of the variables will be used. | String |
dimension_def (Optional) | Specifies the method that will be used to slice the dimension.
| String |
dimension_ranges [dimension_ranges,...] (Optional) | The range or list of ranges for the specified dimension. This slices the data based on the dimension name and the minimum and maximum values for the range. This parameter is required when the dimension_def parameter is set to BY_RANGES. | Value Table |
dimension_values [dimension_values,...] (Optional) | A list of values for the specified dimension. This parameter is required when the dimension_def parameter is set to BY_VALUE. | Value Table |
dimension (Optional) | The dimension along which the variables will be sliced. This parameter is required when the dimension_def parameter is set to BY_ITERATION. | String |
start_of_first_iteration (Optional) | The beginning of the first interval. This interval is used to iterate through the dataset. This parameter is required when the dimension_def parameter is set to BY_ITERATION. | String |
end_of_first_iteration (Optional) | The end of the first interval. This interval is used to iterate through the dataset. This parameter is required when the dimension_def parameter is set to BY_ITERATION. | String |
iteration_step (Optional) | The frequency with which the data will be sliced. This parameter is required when the dimension_def parameter is set to BY_ITERATION. | Double |
iteration_unit (Optional) | Specifies the iteration unit. This parameter is required when the dimension_def parameter is set to BY_ITERATION and the dimension parameter is set to StdTime.
| String |
Code sample
Extract a subset of variables from a multidimensional raster using the BY_RANGES method.
# Import system modules
import arcpy
# Execute
SubMultidim = SubsetMultidimensionalRaster("C:\data\Ocean_Data.crf", "salinity", "BY_RANGES", "StdZ -500 -100")
# Save Output
SubMultidim.save("C:\data\Halocline.crf")Extract the water temperature variable from a multidimensional raster using the BY_VALUE method
# Import system modules
import arcpy
# Define input parameters
in_multidimensional_raster = r"C:\data\MD_Ocean_data.crf"
out_multidimensional_raster = r"C:\data\Temp_slice.crf"
variables = "water_temp"
dimension_def = "BY_VALUE"
dimension_values = "StdZ -50;StdZ -100"
#Execute
arcpy.md.SubsetMultidimensionalRaster(in_multidimensional_raster, out_multidimensional_raster, variables, dimension_def, dimension_values)Extract the salinity variable from a multidimensional raster using the BY_ITERATION method.
# Import system modules
import arcpy
# Set local variables
in_multidimensional_raster = r"C:\data\MD_Ocean_data.crf"
out_multidimensional_raster = r"C:\data\salinity_slice.crf"
variables = "salinity"
dimension_def = "BY_ITERATION"
dimension = "StdTime"
start_of_first_iteration = "2009-01-01"
end_of_first_iteration = "2009-01-10"
iteration_step = "1"
iteration_unit = "YEARS"
#Execute
arcpy.md.SubsetMultidimensionalRaster(in_multidimensional_raster, out_multidimensional_raster, variables, dimension_def, dimension, start_of_first_iteration, end_of_first_iteration, iteration_step, iteration_unit)Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes