Log10 (Spatial Analyst)

Available with Spatial Analyst license.

Summary

Calculates the base 10 logarithm of cells in a raster.

Illustration

Log10 illustration
OutRas = Log10(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.

  • If the input is multidimensional raster data, all slices from all variables will be processed. The output will be a multidimensional raster in CRF format.

  • See Analysis environments and Spatial Analyst for additional details on the geoprocessing environments that apply to this tool.

Parameters

LabelExplanationData Type
Input raster or constant value

Input values for which to find the base 10 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

LabelExplanationData Type
Output raster

The output raster.

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

Raster

Log10(in_raster_or_constant)
NameExplanationData Type
in_raster_or_constant

Input values for which to find the base 10 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 10 logarithm of the input values.

Raster

Code sample

Log10 example 1 (Python window)

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

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outLog10 = Log10("elevation")
outLog10.save("C:/sapyexamples/output/outlog10.img")
Log10 example 2 (stand-alone script)

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

# Name: Log10_Ex_02.py
# Description: Calculates the base 10 logarithm of cells in a raster
# Requirements: Spatial Analyst Extension

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

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

# Set local variables
inRaster = "degs"

# Execute Log10
outLog10 = Log10(inRaster)

# Save the output 
outLog10.save("C:/sapyexamples/output/outlog10")

Related topics