Package 'aboveR'

Description

Identifies flat bench areas between highwall faces in surface mining terrain. Benches are detected as relatively flat areas (low slope) bounded by steep terrain (high slope), using slope segmentation and area filtering.

Usage

bench_detection(dem, max_slope = 10, min_area = 100, highwall_slope = 40)

Arguments

Value

An sf::sf data frame of bench polygons with columns:

• bench_id: sequential bench identifier

• area_m2: bench area in square metres

• mean_elev: mean elevation of the bench surface

• mean_slope: mean slope within the bench

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
benches <- bench_detection(dem, max_slope = 15, min_area = 0)
if (nrow(benches) > 0) plot(sf::st_geometry(benches))

Description

Converts a polygon boundary to a closed linestring and samples elevation values around the perimeter. Useful for inspecting highwall edges, dam crests, or property boundaries.

Usage

boundary_terrain_profile(dem, boundary, spacing = NULL)

Arguments

Value

A data frame with columns:

• distance: distance along the boundary perimeter

• elevation: sampled elevation value

• x, y: coordinates of each sample point

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
boundary <- sf::st_read(
  system.file("extdata/boundary.gpkg", package = "aboveR"),
  quiet = TRUE
)
bprof <- boundary_terrain_profile(dem, boundary)
plot(bprof$distance, bprof$elevation, type = "l",
     xlab = "Perimeter Distance", ylab = "Elevation")

Description

Extracts change statistics for each polygon in a zone layer, computing cut volume, fill volume, net change, and descriptive statistics per zone.

Usage

change_by_zone(change_raster, zones, id_field)

Arguments

Value

An sf::sf data frame with columns:

• zone identifier

• cut_volume: total volume of material removed (m^3, positive)

• fill_volume: total volume of material added (m^3, positive)

• net_volume: fill - cut (m^3)

• area_m2: zone area

• mean_change: mean elevation change

• max_cut: deepest cut (most negative value)

• max_fill: highest fill (most positive value)

Examples

before <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
after  <- terra::rast(system.file("extdata/dem_after.tif", package = "aboveR"))
chg <- terrain_change(before, after)
zones <- sf::st_read(
  system.file("extdata/zones.gpkg", package = "aboveR"),
  quiet = TRUE
)
change_by_zone(chg, zones, id_field = "zone_id")

Description

Returns a blue-white-red color ramp centered at zero, suitable for terrain change visualisation. Cut (negative) is blue, fill (positive) is red.

Usage

change_colors(n = 100L)

Arguments

Value

Character vector of hex color values.

Examples

cols <- change_colors(10)
image(matrix(1:10), col = cols)

Description

Identifies steep terrain faces (highwalls) typical of surface mining operations by computing slope from a DEM and classifying cells that exceed a slope threshold. Returns a binary raster and optionally vectorised polygons of highwall zones.

Usage

classify_highwall(dem, slope_threshold = 60, min_area = 0, as_polygons = FALSE)

Arguments

Value

If as_polygons = FALSE, a terra::SpatRaster with values 1 (highwall) and NA (non-highwall). If as_polygons = TRUE, an sf::sf data frame of highwall polygons with an area_m2 column.

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
hw <- classify_highwall(dem, slope_threshold = 5)
terra::plot(hw)

Description

Extracts contour lines at a specified interval and returns them as an sf::sf object with an elevation attribute.

Usage

contour_lines(dem, interval = 5, levels = NULL)

Arguments

Value

An sf::sf data frame with LINESTRING geometry and an elevation column.

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
cl <- contour_lines(dem, interval = 2)
plot(sf::st_geometry(cl))

Description

Identifies potential erosion channels (rills, gullies) by computing flow accumulation and filtering cells where accumulated flow exceeds a threshold. Optionally returns vectorised channel lines.

Usage

detect_channels(dem, threshold = 100, as_lines = FALSE)

Arguments

Value

If as_lines = FALSE, a terra::SpatRaster with channel cells = 1, other = NA. If as_lines = TRUE, an sf::sf LINESTRING object of detected channels.

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
channels <- detect_channels(dem, threshold = 50)
terra::plot(channels)

Description

Computes the volume of material between a surface DEM and a reference surface (e.g., a design grade or pre-mining DEM), optionally clipped to a boundary polygon. Reports cut and fill volumes separately and documents the integration method used.

Usage

estimate_volume(
  surface,
  reference,
  boundary = NULL,
  method = c("trapezoidal", "simpson")
)

Arguments

Value

A list with components:

• cut_volume_m3: volume of material removed (positive)

• fill_volume_m3: volume of material added (positive)

• net_volume_m3: fill minus cut

• area_m2: total analysed area

• mean_depth_m: mean absolute difference

• max_cut_m: deepest cut

• max_fill_m: highest fill

• method: integration method used

Examples

surface <- terra::rast(system.file("extdata/dem_after.tif", package = "aboveR"))
reference <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
boundary <- sf::st_read(
  system.file("extdata/boundary.gpkg", package = "aboveR"),
  quiet = TRUE
)
vol <- estimate_volume(surface, reference, boundary)
cat("Net volume:", vol$net_volume_m3, "m3\n")

Description

Converts a DEM raster to a LandXML file containing a TIN (Triangulated Irregular Network) surface. LandXML is widely supported by civil engineering software including Autodesk Civil 3D, Bentley OpenRoads, and Trimble Business Center.

Usage

export_landxml(
  dem,
  output,
  surface_name = "Ground",
  decimate = 1L,
  boundary = NULL
)

Arguments

Value

The output file path (invisibly).

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
out <- file.path(tempdir(), "surface.xml")
export_landxml(dem, out, surface_name = "Existing")
file.exists(out)

Description

Converts a DEM raster to an STL (stereolithography) file suitable for 3D printing. The model includes a flat base and vertical exaggeration control.

Usage

export_stl(dem, output, exaggeration = 1, base_height = 1, decimate = 1L)

Arguments

Value

The output file path (invisibly).

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
out <- file.path(tempdir(), "terrain.stl")
export_stl(dem, out, exaggeration = 2)
file.exists(out)

Description

Light-to-dark blue color ramp for flood depth visualisation.

Usage

flood_colors(n = 100L)

Arguments

Value

Character vector of hex color values.

Examples

cols <- flood_colors(10)
image(matrix(1:10), col = cols)

Description

Calculates the depth of water at each cell for a given water surface elevation. Cells above the water level receive NA.

Usage

flood_depth(dem, water_level, boundary = NULL)

Arguments

Value

A terra::SpatRaster of water depth values (positive, in DEM elevation units). Cells above the water level are NA.

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
depth <- flood_depth(dem, water_level = 305)
terra::plot(depth, main = "Flood Depth (m)")

Description

Creates a binary raster showing which cells would be inundated at a given water surface elevation. Cells below the water level are marked as flooded (1), cells above are NA.

Usage

flood_inundation(dem, water_level, boundary = NULL)

Arguments

Value

A terra::SpatRaster with values 1 (inundated) and NA (dry).

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
inundated <- flood_inundation(dem, water_level = 305)
terra::plot(inundated, main = "Flood Inundation at 305m")

Description

Returns TRUE only when the ABOVER_KFA_TEST environment variable is set, ensuring KyFromAbove examples never run on CRAN or in environments without verified S3 access.

Usage

has_s3_access()

Value

Logical scalar indicating whether the KyFromAbove test environment variable is set.

Examples

has_s3_access()

Description

Calculates a relative elevation model representing each cell's height above the nearest drainage channel. This is a key input for flood susceptibility mapping. Channels are identified using Topographic Position Index (TPI).

Usage

height_above_drainage(dem, channel_threshold = 0.1, window = 15L)

Arguments

Value

A terra::SpatRaster of height-above-nearest-drainage values. Lower values indicate greater flood susceptibility.

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
hand <- height_above_drainage(dem, window = 7)
terra::plot(hand, main = "Height Above Nearest Drainage")

Description

Computes an analytical hillshade (shaded relief) from a DEM using specified sun azimuth and altitude angles. Useful for terrain visualisation and map backgrounds.

Usage

hillshade(dem, azimuth = 315, altitude = 45)

Arguments

Value

A terra::SpatRaster with hillshade values (0–255).

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
hs <- hillshade(dem)
terra::plot(hs, col = grey.colors(256))

Description

Calculates storage volume at a series of water surface elevations for a terrain depression (e.g., a pond, reservoir, or sediment basin). The result is an elevation-area-volume curve.

Usage

impoundment_curve(dem, boundary = NULL, elevations = NULL, n_steps = 20L)

Arguments

Value

A data frame with columns:

• elevation: water surface elevation

• area_m2: inundated area at this elevation

• volume_m3: cumulative storage volume below this elevation

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
boundary <- sf::st_read(
  system.file("extdata/boundary.gpkg", package = "aboveR"),
  quiet = TRUE
)
curve <- impoundment_curve(dem, boundary, n_steps = 10)
plot(curve$elevation, curve$volume_m3, type = "l",
     xlab = "Elevation", ylab = "Volume (m3)")

Description

Returns a bounding box (in EPSG:4326) for a Kentucky county by name. Useful for quickly querying KyFromAbove tiles without constructing an AOI manually.

Usage

kfa_county_bbox(county)

Arguments

Value

A numeric vector c(xmin, ymin, xmax, ymax) in EPSG:4326.

Examples

# Get bounding box for Fayette County
bbox <- kfa_county_bbox("Fayette")
print(bbox)


# Use directly with kfa_find_tiles
tiles <- kfa_find_tiles(kfa_county_bbox("Fayette"), product = "dem")

Description

Queries KyFromAbove tile indexes to find elevation, point cloud, or imagery tiles that intersect a given area of interest. Tries the STAC catalog first (if available), then falls back to the tile index GeoPackage on S3.

Usage

kfa_find_tiles(
  aoi,
  product = "dem",
  phase = 2L,
  method = c("auto", "stac", "index")
)

Arguments

Value

An sf::sf data frame with columns: tilename, s3_url, phase, product, and geometry.

Examples

# Find Phase 2 DEM tiles for a bounding box in Fayette County
tiles <- kfa_find_tiles(
  aoi = c(-84.55, 37.95, -84.45, 38.05),
  product = "dem",
  phase = 2
)

Description

Returns a character vector of all 120 Kentucky county names.

Usage

kfa_list_counties()

Value

Character vector of county names sorted alphabetically.

Examples

counties <- kfa_list_counties()
head(counties)

Description

Finds DEM tiles covering the AOI, reads them as Cloud-Optimized GeoTIFFs via ⁠/vsicurl/⁠, optionally merges into a single raster, and crops to the AOI extent.

Usage

kfa_read_dem(aoi, phase = 2L, merge = TRUE, crop = TRUE, cache = FALSE)

Arguments

Value

A terra::SpatRaster object.

Examples

dem <- kfa_read_dem(
  aoi = c(-84.55, 37.95, -84.45, 38.05),
  phase = 2
)

Description

Finds ortho (nadir) or oblique imagery tiles covering the AOI and reads them as RGB SpatRaster.

Usage

kfa_read_ortho(aoi, phase = 3L, type = c("nadir", "oblique"))

Arguments

Value

A terra::SpatRaster object with 3 bands (RGB).

Examples

ortho <- kfa_read_ortho(
  aoi = c(-84.55, 37.95, -84.54, 37.96),
  phase = 3
)

Description

Finds point cloud tiles (LAZ for Phase 1, COPC for Phase 2/3) covering the AOI and reads them via lidR::readLAS().

Usage

kfa_read_pointcloud(aoi, phase = 2L)

Arguments

Value

A lidR::LAS object.

Examples

las <- kfa_read_pointcloud(
  aoi = c(-84.55, 37.95, -84.54, 37.96),
  phase = 2
)

Description

Queries the KyFromAbove STAC catalog for items matching an area of interest and product type. Requires the rstac package.

Usage

kfa_stac_search(aoi, collection = NULL, datetime = NULL)

Arguments

Details

The KyFromAbove STAC catalog is under active development by Ian Horn (github.com/ianhorn/kyfromabove-stac). This function will be activated when the catalog is live. In the meantime, use kfa_find_tiles() with method = "index".

Value

An sf::sf data frame of STAC items with asset URLs, or an error if the STAC catalog is not yet available.

Examples

# STAC catalog not yet available — use kfa_find_tiles() instead
tiles <- kfa_find_tiles(
  aoi = c(-84.55, 37.95, -84.45, 38.05),
  product = "dem", phase = 2
)

Description

Downloads a tile index GeoPackage from the KyFromAbove S3 bucket and caches it locally. Subsequent calls use the cached copy unless it is older than max_age_days.

Usage

kfa_tile_index(product = "dem", phase = 2L, max_age_days = 30L)

Arguments

Value

An sf::sf data frame representing the tile index grid.

Examples

idx <- kfa_tile_index(product = "dem", phase = 2)
head(idx)

Description

Compares two DEMs of a pond or sediment basin to estimate the volume of accumulated sediment. The pond area is defined by a boundary polygon, and sedimentation is computed as fill (positive change) within that area.

Usage

pond_sedimentation(before, after, pond_boundary)

Arguments

Value

A list with:

• sediment_volume_m3: estimated sediment volume (positive fill)

• mean_depth_change_m: mean elevation change within the pond

• max_accumulation_m: maximum sedimentation depth

• pond_area_m2: area of the pond boundary

• change_raster: terra::SpatRaster of elevation change within the pond

Examples

before <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
after  <- terra::rast(system.file("extdata/dem_after.tif", package = "aboveR"))
boundary <- sf::st_read(
  system.file("extdata/boundary.gpkg", package = "aboveR"),
  quiet = TRUE
)
sed <- pond_sedimentation(before, after, boundary)
cat("Sediment volume:", sed$sediment_volume_m3, "m3\n")

Description

Compares a current DEM against a target (design grade) surface to quantify how much of a reclamation area has been restored to the desired elevation. Returns per-cell deviations and summary statistics.

Usage

reclamation_progress(current, target, boundary = NULL, tolerance = 0.3)

Arguments

Value

A list with:

• deviation: terra::SpatRaster of current - target values

• on_grade_pct: percentage of cells within tolerance

• above_grade_pct: percentage of cells above tolerance

• below_grade_pct: percentage of cells below tolerance

• mean_deviation: mean signed deviation

• rmse: root mean square error

Examples

current <- terra::rast(system.file("extdata/dem_after.tif", package = "aboveR"))
target  <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
prog <- reclamation_progress(current, target, tolerance = 1)
cat("On grade:", prog$on_grade_pct, "%\n")

Description

Calculates slope (in degrees or percent) and aspect (compass bearing) from a DEM in a single call.

Usage

slope_aspect(dem, units = c("degrees", "percent"))

Arguments

Value

A two-layer terra::SpatRaster:

• slope: terrain slope in the requested units

• aspect: terrain aspect in degrees (0 = North, 90 = East, 180 = South, 270 = West; flat areas = -1)

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
sa <- slope_aspect(dem)
terra::plot(sa)

Description

Calculates surface roughness as the standard deviation of elevation within a moving window. Rougher surfaces indicate unreclaimed terrain, active construction, or natural heterogeneity.

Usage

surface_roughness(dem, window = 5L)

Arguments

Value

A terra::SpatRaster of local roughness values (standard deviation of elevation).

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
rough <- surface_roughness(dem, window = 5)
terra::plot(rough)

Description

Calculates the elevation difference between a before and after DEM, returning both the continuous change values and a classified layer (cut / stable / fill). Rasters are aligned automatically if their extents or resolutions differ (same CRS required).

Usage

terrain_change(before, after, tolerance = 0.1)

Arguments

Value

A two-layer terra::SpatRaster:

• change: continuous elevation difference (after - before)

• class: integer classification (1 = cut, 2 = stable, 3 = fill)

Examples

before <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
after  <- terra::rast(system.file("extdata/dem_after.tif", package = "aboveR"))
result <- terrain_change(before, after)
terra::plot(result[["change"]])

Description

Green-brown-white hypsometric color ramp for elevation maps.

Usage

terrain_colors(n = 100L)

Arguments

Value

Character vector of hex color values.

Examples

cols <- terrain_colors(10)
image(matrix(1:10), col = cols)

Description

Samples elevation values from a DEM at regular intervals along a transect line and returns a data frame of distance vs. elevation.

Usage

terrain_profile(dem, line, spacing = NULL)

Arguments

Value

A data frame with columns:

• distance: distance along the profile from the start point

• elevation: sampled elevation value

• x, y: coordinates of each sample point

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
line <- sf::st_read(
  system.file("extdata/profile_line.gpkg", package = "aboveR"),
  quiet = TRUE
)
prof <- terrain_profile(dem, line)
plot(prof$distance, prof$elevation, type = "l",
     xlab = "Distance", ylab = "Elevation")

Description

Extracts summary statistics for each polygon zone, including min, max, mean, median, standard deviation, and cell count.

Usage

zonal_stats(r, zones, id_field)

Arguments

Value

An sf::sf data frame with columns:

• zone identifier

• min, max, mean, median, sd: summary statistics

• cell_count: number of non-NA cells

• area_m2: zone area

Examples

dem <- terra::rast(system.file("extdata/dem_before.tif", package = "aboveR"))
zones <- sf::st_read(
  system.file("extdata/zones.gpkg", package = "aboveR"),
  quiet = TRUE
)
zs <- zonal_stats(dem, zones, id_field = "zone_id")
print(zs)