Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.

  >  Docs Center  >  ENVI API  >  Crop Science  >  ENVIAgCalculateAndRasterizeCropMetricsTask



This task calculates statistics from a single-band raster and an associated ENVIAgCrops object. It creates a classification raster showing the relative means of crops or a greyscale raster showing actual mean values of crops. For example, if the input raster is a vegetation index such as NDVI, the crop means describe the health of the crops.

ENVIAgCalculateAndRasterizeCropMetrics is a metatask that automatically runs the following tasks:

You can run ENVIAgCropCountTask or ENVIAgCountAndRasterizeCropsTask to create the ENVIAgCrops object that is required for this task. Or, you can use an ENVIAgCrops file that you created and saved earlier.

This task is part of ENVI Crop Science, which requires a separate license and installation.


This example performs the following steps.

  1. Opens an orthophoto of a citrus orchard.
  2. Creates a spectral index raster to make the citrus trees bright against the background. A Normalized Difference Vegetation Index (NDVI) works well in this case. NDVI will be used for crop counting and for calculating metrics in this example.
  3. Tip: See the ENVISpectralIndexRaster topic in ENVI Help for a list of spectral indices. You can run ENVIQuerySpectralIndicesTask to see what indices are available for your particular image.

  4. Runs ENVIAgCropCount to count the trees and to create an ENVIAgCrops object.
  5. Runs ENVIAgCalculateAndRasterizeCropMetrics task, using the NDVI image as the basis for calculating metrics.
  6. Displays a classification raster showing relative NDVI means of the citrus trees.
  7. Prints the range of crop NDVI values in the entire image.
; Start the application
e = ENVI()
; Open an input file
File = Filepath('CitrusOrthophoto.dat', $
  Subdir=['data','crop_science'], $
Raster = e.OpenRaster(File)
; Preprocess the image so that crops are bright.
NDVIImage = ENVISpectralIndexRaster(Raster, 'NDVI')
; Count the crops and output an ENVIAgCrops object
outCrops = ENVIAgCropCount(NDVIImage, 2.0, 5.0, $
; Get the metrics task from the catalog of ENVITasks
Task = ENVITask('AgCalculateAndRasterizeCropMetrics')
; Define inputs
Task.INPUT_CROPS = outCrops
; Define outputs
Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()
; Run the task
; Get the collection of objects currently in the Data Manager
DataColl = e.Data
; Add the output to the data collection
DataColl.Add, Task.OUTPUT_RASTER
; Display the result
View = e.GetView()
Layer = View.CreateLayer(Task.OUTPUT_RASTER)
; Print the range of NDVI values
crops = Task.OUTPUT_CROPS
Print, 'Minimum NDVI value for entire image: ',MIN(crops.CROP_MIN)
Print, 'Maximum NDVI value for entire image: ',MAX(crops.CROP_MAX)


Result = ENVITask('AgCalculateAndRasterizeCropMetrics')


Output properties (Get only): OUTPUT_CROPS, OUTPUT_RASTER

Properties marked as "Init" are applied only during the initial creation of the object. Properties marked as "Set" are those that you can set to specific values after the object has been created. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.


This task inherits the following methods from ENVITask. See the ENVITask topic in ENVI Help.

  • AddParameter
  • Execute
  • Parameter
  • ParameterNames
  • RemoveParameters


This task inherits the following properties from ENVITask:







See the ENVITask topic in ENVI Help for details.

This task also contains the following properties:


Set this property to true (the default value) to create a classification raster where crops are colored according to relative means. For example, a dark green polygon corresponds to a crop with a higher mean value than light-green, yellow, and red polygons. The resulting raster will look similar to the following:

If you set the CLASSIFICATION property to false, the output will be a greyscale raster that is based on the actual mean values of the crops; for example:

INPUT_CROPS (required)

Specify an input ENVIAgCrops object. You can run ENVIAgCropCountTask or ENVIAgCountAndRasterizeCropsTask to create an ENVIAgCrops object before running this task. Or, you can use an ENVIAgCrops file that you created and saved earlier.

INPUT_RASTER (required)

Specify a single-band raster from which crop metrics will be computed. A common example is a spectral index raster such as Normalized Difference Vegetation Index (NDVI).


This is a reference to the output crop data.


Specify a string with the fully qualified path and filename for OUTPUT_CROPS. If you do not specify this property, the output crop file is only temporary. Once the crop file has no remaining references, ENVI deletes the temporary file.

OUTPUT_METRIC (required)

Set this property to one of the following strings, indicating the metric that the output raster will be based on:

  • Crop Minimum
  • Crop Maximum
  • Crop Mean
  • Crop Standard Deviation
  • Radius


This is a reference to the output crops classification raster or greyscale raster.


Specify a string with the fully qualified filename and path of the output raster. If you do not specify this property, the output raster is only temporary. Once the raster has no remaining references, ENVI deletes the temporary file.

Version History




Added Crop Minimum, Crop Maximum, Crop Standard Deviation, and Radius options to OUTPUT_METRIC.

See Also

ENVIAgCalculateCropMetricsTask, ENVIAgCalculateAndRasterizeCropMetricsWithSpectralIndexTask, ENVIAgCrops, ENVIAgCropCountTask, ENVIAgCountAndRasterizeCropsTask

© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us