Generate Raster From Raster Function (Data Management Tools)

Summary

Generates a raster dataset from an input raster function or function chain.

Usage

The tool is designed for raster processing using multiple threads to help speed up the processing.
The output raster format can be TIFF, GRID, ERDAS IMAGINE, CRF (Cloud Raster Format), or MRF (Meta Raster Format).

Label	Explanation	Data type
Input Raster Function	The name of a raster function, raster function JSON object, or function chain (in `.rft.xml` format).	File; String
Output Raster Dataset	The output raster dataset.	Raster Dataset
Raster Function Arguments (Optional)	The parameters associated with the function chain. For example, if the function chain applies the Hillshade raster function, set the data source, azimuth, and altitude. Value table columns: Name—The name of the raster function. Value—The value of the raster function.	Value Table
Raster Properties (Optional)	The output raster dataset key properties, such as the sensor or wavelength. Value table columns: Name—The name of the key raster property. Value—The value of the key raster property.	Value Table
Format (Optional)	The output raster format. The default format will be derived from the file extension specified in the Output Raster Dataset value. TIFF—Tagged Image File Format for raster datasets will be used. Cloud Optimized GeoTIFF—Cloud Optimized GeoTIFF format will be used. ERDAS IMAGINE file—ERDAS IMAGINE raster data format will be used. Esri Grid—Esri Grid raster dataset format will be used. CRF—Cloud Raster Format will be used. MRF—Meta Raster Format will be used.	String
Process as Multidimensional (Optional)	Specifies whether the input mosaic dataset will be processed as a multidimensional raster dataset. Checked—The input will be processed as a multidimensional raster dataset and all slices will be processed to produce a new multidimensional raster dataset. Set the Format parameter to CRF to use this option. Unchecked—The input will not be processed as a multidimensional raster dataset. If the input is multidimensional, only the slice that is currently displayed will be processed. This is the default.	Boolean

arcpy.management.GenerateRasterFromRasterFunction(raster_function, out_raster_dataset, {raster_function_arguments}, {raster_properties}, {format}, {process_as_multidimensional})

Name	Explanation	Data type
raster_function	The name of a raster function, raster function JSON object, or function chain (in `.rft.xml` format).	File; String
out_raster_dataset	The output raster dataset.	Raster Dataset
raster_function_arguments [[Name, Value],...] (Optional)	The parameters associated with the function chain. For example, if the function chain applies the Hillshade raster function, set the data source, azimuth, and altitude. Value table columns: `Name`—The name of the raster function. `Value`—The value of the raster function.	Value Table
raster_properties [[Name, Value],...] (Optional)	The output raster dataset key properties, such as the sensor or wavelength. Value table columns: `Name`—The name of the key raster property. `Value`—The value of the key raster property.	Value Table
format (Optional)	The output raster format. The default format will be derived from the file extension specified in the `output_raster_dataset` value. `TIFF`—Tagged Image File Format for raster datasets will be used. `Cloud Optimized GeoTIFF`—Cloud Optimized GeoTIFF will be used. `IMAGINE Image`—ERDAS IMAGINE raster data format will be used. `Grid`—Esri Grid raster dataset format will be used. `CRF`—Cloud Raster Format will be used. `MRF`—Meta Raster Format will be used.	String
process_as_multidimensional (Optional)	Specifies whether the input mosaic dataset will be processed as a multidimensional raster dataset. `ALL_SLICES`—The input will be processed as a multidimensional raster dataset and all slices will be processed to produce a new multidimensional raster dataset. Set the `format` parameter to `CRF` to use this option. `CURRENT_SLICE`—The input will not be processed as a multidimensional raster dataset. If the input is multidimensional, only the slice that is currently displayed will be processed. This is the default.	Boolean

Code sample

GenerateRasterFromRasterFunction example (Python window)

This Python sample uses the NDVI raster function to create a raster dataset.

import arcpy
arcpy.env.workspace = r"C:\PrjWorkspace"

arcpy.management.GenerateRasterFromRasterFunction(
    raster_function="NDVI",
    out_raster_dataset="c:/temp/ndvitest.crf",
    raster_function_arguments="Raster \\\\somemachine\\data\\test.tif; VisibleBandID 3;InfraredBandID 4",
    format="CRF")

GenerateRasterFromRasterFunction example (stand-alone script)

This Python sample uses the Band Arithmetic raster function with the SAVI method to create a raster dataset.

## Generate raster from Band Arithmetic raster function where method is set to SAVI.

arcpy.management.GenerateRasterFromRasterFunction(
    r"C:\Projects\SAVI.rft.xml", r"C:\Projects\Portland_SAVI.tif",
    r"Raster C:\Projects\PortlandIKONOS.tif;Method SAVI;'Band Indexes' '4 3 0.33'",
    None, "TIFF", "CURRENT_SLICE")

Environments

Cell Alignment, Cell Size, Compression, Current Workspace, Extent, Geographic Transformations, GPU ID, Match Multidimensional Variable, NoData, Output Coordinate System, Parallel Processing Factor, Processor Type, Pyramid, Raster Statistics, Resampling Method, Scratch Workspace, Snap Raster, Tile Size, Union Dimension

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes