Log2 (Image Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

Calculates the base 2 logarithm of cells in a raster.

Illustration

Log2 illustration
OutRas = Log2(InRas1)

Usage

  • The input can be of integer or float type.

    You can review some results for floating-point input values in the examples of output values from the Logarithmic tools.

  • Input values that are 0 or negative will be NoData in the output raster.

  • The output raster from this tool is always floating-point type, regardless of the input value type.

  • If the input is a multiband raster, the output will be a multiband raster. The tool will perform the operation on each band in the input.

Syntax

Log2(in_raster_or_constant)
ParameterExplanationData Type
in_raster_or_constant

Input values for which to find the base 2 logarithm.

To use a number as an input for this parameter, the cell size and extent must first be set in the environment.

Raster Layer; Constant

Return Value

NameExplanationData Type
out_raster

The output raster.

The cell values are the base 2 logarithm of the input values.

Raster

Code sample

Log2 example (Python window)

This example calculates base 2 logarithm of the input raster values and generates the output as an IMG raster.

import arcpy
from arcpy import env
from arcpy.ia import *
env.workspace = "C:/iapyexamples/data"
outLog2 = Log2("elevation")
outLog2.save("C:/iapyexamples/output/outlog2.img")
Log2 example 2 (stand-alone script)

This example calculates base 2 logarithm of the input raster values.

# Name: Log2_Ex_02.py
# Description: Calculates the base 2 logarithm of pixels in a raster
# Requirements: Image Analyst Extension

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

# Set environment settings
env.workspace = "C:/iapyexamples/data"

# Set local variables
inRaster = "degs"

# Check out the ArcGIS Image Analyst extension license
arcpy.CheckOutExtension("ImageAnalyst")

# Execute Log2
outLog2 = Log2(inRaster)

# Save the output 
outLog2.save("C:/iapyexamples/output/outlog2")

Licensing information

  • Basic: Requires Image Analyst or Spatial Analyst
  • Standard: Requires Image Analyst or Spatial Analyst
  • Advanced: Requires Image Analyst or Spatial Analyst

Related topics