Skip to main content

LessThanFrequency

Summary

Creates a raster object in which each pixel contains the number of times a set of rasters is less than another raster.

Discussion

For more information about how this function works, see the Less Than Frequency tool.

The referenced raster dataset for the raster object is temporary. To make it permanent, you can call the raster object's save method.

Syntax

LessThanFrequency(value_raster, rasters, {extent_type}, {cellsize_type}, {process_as_multiband})

Parameter Explanation Data Type

value_raster

A value raster that will be referenced by the list of input rasters.

Raster

rasters

The list of input rasters.

Raster

extent_type

The method that will be used to compute the extent of the output when the input rasters have different extents.

  • FirstOf—The output extent will be defined using the extent of the first input raster.

  • LastOf—The output extent will be defined using the extent of the last input raster.

  • IntersectionOf—The output extent will be defined as the intersecting area of the input rasters.

  • UnionOf—The output extent will be defined as the total extent of the input rasters.

The default value is FirstOf.

String

cellsize_type

The method that will be used to compute the pixel size of the output when the input rasters have different pixel sizes.

  • FirstOf—The output pixel size will be defined using the pixel size of the first input raster.

  • LastOf—The output pixel size will be defined using the pixel size of the last input raster.

  • MaxOf—The output pixel size will be defined using the maximum pixel size of the input rasters.

  • MeanOf—The output pixel size will be defined using the mean of both input rasters.

  • MinOf—The output pixel size will be defined using the minimum pixel size of the input rasters.

The default value is FirstOf.

String

process_as_multiband

Specifies how the bands of the input rasters will be processed.

  • True—Each multiband raster will be processed as a multiband raster. The operation will be performed for each band from one input using the corresponding band number from other inputs.

  • False—Each band from a multiband raster input will be processed separately as a single-band raster.

The default value is False.

Boolean

Return value

Data Type Explanation

Raster

The output raster.

Code sample

LessThanFrequency example

Calculates the number of times a set of input rasters is less than a value raster.

# Import system modules
import arcpy
from arcpy.ia import *

#Set the local variables
value_raster = r"c:\temp\value_raster.tif"

rasters = [r"c:\temp\raster1.tif", r"c:\temp\raster2.tif", r"c:\temp\raster3.tif"]

# Run
LessThan_raster = LessThanFrequency(value_raster, rasters, "UnionOf", "FirstOf", True)