Available with Image Analyst license.
Available with Spatial Analyst license.
Summary
Extracts the dimension value or band index at which a given statistic is attained for each pixel in a multidimensional or multiband raster.
Usage
-
Use the Find Argument Statistics tool to extract the dimension value (for example, the date, height, or depth) at which a specific statistic is reached in the stack of rasters in a multidimensional raster dataset. Alternatively, find the band number at which the statistic is reached in a multiband raster.
For example, you may want to know the month in which each pixel reached the highest sea surface temperature over 30 years of data collection. Another example is you have an eight-band remote sensing image and you want to know the band in which the minimum reflectance value was reached for each pixel.
Supported multidimensional raster datasets include Cloud Raster Format (CRF), multidimensional mosaic datasets, or multidimensional raster layers generated by netCDF, GRIB, or HDF files.
This tool produces a multidimensional raster dataset in Cloud Raster Format (CRF). Currently, no other output formats are supported.
If the input multidimensional raster contains only one dimension, the output will be a single-band raster dataset. If the input multidimensional raster contains multiple dimensions, the output multidimensional raster will include those dimensions that were not included in the analysis.
Syntax
FindArgumentStatistics(in_raster, {dimension}, {dimension_def}, {interval_keyword}, {variables}, {statistics_type}, {min}, {max}, {multiple_occurrence}, {ignore_nodata})| Parameter | Explanation | Data Type |
in_raster | The input multidimensional or multiband raster to be analyzed. | Raster Dataset; Raster Layer; Mosaic Dataset; Mosaic Layer; Image Service; File |
dimension (Optional) | The dimension from which the statistic will be extracted. If the input raster is not a multidimensional raster, this parameter is not required. | String |
dimension_def (Optional) | Specifies how the statistic will be extracted from the dimension.
| String |
interval_keyword (Optional) | The unit of time for which the statistic will be extracted. For example, you have five years of daily sea surface temperature data and you want to know the year in which the maximum temperature was observed. Set Statisitcs Type to Argument of the maximum, set Dimension Definition to Interval Keyword, and set Keyword Interval to Yearly. Alternatively, if you want to know the month in which the maximum temperature was consistently observed, set Statistics Type to Argument of the maximum, setDimension Definition to Interval Keyword, and set Keyword Interval to Recurring Monthly. This will generate a raster in which each pixel contains the month in which the statistic was reached across the five-year record (08/18/2018, 08/25/2016, 08/07/2013, for example). This parameter is required when the dimension parameter is set to StdTime and the dimension_def parameter is set to INTERVAL_KEYWORD.
| String |
variables [variables,...] (Optional) | The variable or variables to be analyzed. If the input raster is not multidimensional, the pixel values of the multiband raster are considered the variable. If the input raster is multidimensional and no variable is specified, all variables with the selected dimension will be analyzed. For example, to find the years in which temperature values were highest, specify temperature as the variable to be analyzed. If you do not specify any variables and you have both temperature and precipitation variables, both variables will be analyzed, and the output multidimensional raster will include both variables. | String |
statistics_type (Optional) | Specifies the statistic to extract from the variable or variables along the given dimension.
| String |
min (Optional) | The minimum variable value to be used to extract the duration. This parameter is required when the statistics_type parameter is set to DURATION. | Double |
max (Optional) | The maximum variable value to be used to extract the duration. This parameter is required when the statistics_type parameter is set to DURATION. | Double |
multiple_occurrence (Optional) | The pixel value to use to indicate that a given argument statistic was reached more than once in the input raster dataset. If not specified, the pixel value will be the value of the dimension the first time the argument statistic is reached. | Long |
ignore_nodata (Optional) | Specifies whether NoData values are ignored in the analysis.
| Boolean |
Return Value
| Name | Explanation | Data Type |
| out_raster | The output raster dataset. | Raster |
Code sample
This example finds the minimum monthly precipitation and temperature values across a time series multidimensional raster. If the same minimum value is found multiple times, the pixel value will be 99999.
# Import system modules
import arcpy
from arcpy.ia import *
# Check out the ArcGIS Image Analyst extension license
arcpy.CheckOutExtension("ImageAnalyst")
# get the date when the minimal precipitation was observed in each year
# as well as the date when the minimal temperature was observed in each year
argStatOutput = FindArgumentStatistics("prcp_temp_time_series.crf", "StdTime", "INTERVAL_KEYWORD", "YEARLY",
"prcp;temp", "ARGUMENT_MIN", None, None, 0, "DATA")
# Save output
argStatOutput.save("C:/data/yearly_min_temp_precip.crf")This example finds the longest time interval for which salinity fell between 10 and 15 units of measurement in the multidimensional raster.
# Import system modules
import arcpy
from arcpy.ia import *
# Check out the ArcGIS Image Analyst extension license
arcpy.CheckOutExtension("ImageAnalyst")
# Define input parameters
inFile = "C:/data/salinity.crf"
dimensionName = "Time"
dimensiondef = "ALL"
intervalkeyword = ''
variables = "temp"
arg_statistics_type = "DURATION"
min_value = 20
max_value = 25
multiple_occurrances_value = None
ignore_nodata = "NODATA"
# Execute
# get the number of continous slices that have temperature value between 20 and 25
argStatOutput = FindArgumentStatistics(inFile, dimensionName, dimensiondef, intervalkeyword,
variables, arg_statistics_type, min_value, max_value, multiple_occurrances_value, ignore_nodata)
# Save output
argStatOutput.save("C:/data/arg_statistics_output2.crf")Environments
Licensing information
- Basic: Requires Image Analyst
- Standard: Requires Image Analyst
- Advanced: Requires Image Analyst