Skip to contents

Retrieve urban canopy LCZ parameters

Source: R/lcz_get_parameters.R
lcz_get_parameters.Rd

This function extracts 34 LCZ parameters based on the classification scheme developed by Stewart and Oke (2012). LCZs provide valuable information about urban morphology and are useful for urban climate and environmental studies.

Usage

lcz_get_parameters(x, iselect = "", istack = TRUE, ishp = FALSE, isave = FALSE)

Arguments

x

A LCZ map in .tiff format SpatRaster object containing LCZ classes.

iselect

Code vector. Specify one or more parameter:

  • SVFmean: Mean Sky View Factor

  • SVFmax: Maximum Sky View Factor

  • SVFmin: Minimum Sky View Factor

  • ARmean: Mean Aspect Ratio

  • ARmax: Maximum Aspect Ratio

  • ARmin: Minimum Aspect Ratio

  • BSFmean: Mean Building Surface Fraction

  • BSFmax: Maximum Building Surface Fraction

  • BSFmin: Minimum Building Surface Fraction

  • ISFmean: Mean Impervious Surface Fraction

  • ISFmax: Maximum Impervious Surface Fraction

  • ISFmin: Minimum Impervious Surface Fraction

  • PSFmean: Mean Vegetation Surface Fraction

  • PSFmax: Maximum Vegetation Surface Fraction

  • PSFmin: Minimum Vegetation Surface Fraction

  • TSFmean: Mean Tree Surface Fraction

  • TSFmax: Maximum Tree Surface Fraction

  • TSFmin: Minimum Tree Surface Fraction

  • HREmean: Mean Height Roughness Elements

  • HREmax: Maximum Height Roughness Elements

  • HREmin: Minimum Height Roughness Elements

  • TRCmean: Mean Terrain Roughness class

  • TRCmax: Maximum Terrain Roughness class

  • TRCmin: Minimum Terrain Roughness class

  • SADmean: Mean Surface Admittance

  • SADmax: Maximum Surface Admittance

  • SADmin: Minimum Surface Admittance

  • SALmean: Mean Surface Albedo

  • SALmax: Maximum Surface Albedo

  • SALmin: Minimum Surface Albedo

  • AHmean: Mean Anthropogenic Heat Outupt

  • AHmax: Maximum Anthropogenic Heat Outupt

  • AHmin: Minimum Anthropogenic Heat Outupt

  • z0: Roughness Lenght class

istack

Logical. If TRUE, returns all parameters as a raster stack. If FALSE, returns a list of individual parameter rasters.

ishp

Logical. If TRUE, returns all parameters as an ESRI shapefile.

isave

Set to TRUE if you want to save the your clipped resulting map as a raster.tiff or .shp file on your local machine.

Value

If 'istack' is TRUE, it returns a raster stack containing 34 LCZ-related parameters. If 'istack' is FALSE, it returns a list of individual parameter rasters. If 'ishp' is TRUE, it returns an ESRI shapefile containing all parameters. If 'iselect' is specified, it returns the selected parameter(s) as a raster(s).

References

Stewart, I., and T. Oke, 2012: Local climate zones for urban temperature studies. Bull. Amer. Meteor. Soc., 93, 1879–1900. https://doi.org/10.1175/BAMS-D-11-00019.1

Author

Max Anjos (https://github.com/ByMaxAnjos)

Examples

if (FALSE) { # \dontrun{
# Load the LCZ map
lcz_map <- raster::raster("path/to/lcz_map.tif")

# Get LCZ parameters as a raster stack
lcz_params_stack <- lcz_get_parameters(lcz_map, istack = TRUE)

# Get LCZ parameters as a list of individual parameter rasters
lcz_params_list <- lcz_get_parameters(lcz_map, istack = FALSE)

# Access individual parameters from the list
specific_param <- lcz_params_list$parameter_name

# Get specific parameters as a raster or shapefile
selected_params <- lcz_get_parameters(lcz_map, iselect = c("SVFmin"))
} # }