alcyon (version 0.7.0)

vgaVisualLocal: Visibility Graph Analysis - Visual local metrics

Description

Runs Visibility Graph Analysis to get visual local metrics

Usage

vgaVisualLocal(
  pointMap,
  nthreads = 1L,
  algorithm = VGALocalAlgorithm$Standard,
  copyMap = TRUE,
  gatesOnly = FALSE,
  progress = FALSE
)

Value

A new PointMap with the results included

Arguments

pointMap

A PointMap

nthreads

Optional. Number of threads to use (defaults to 1)

algorithm

Optional. The algorithm to use. See ?VGALocalAlgorithm

copyMap

Optional. Copy the internal sala map

gatesOnly

Optional. Only keep the values at specific gates

progress

Optional. Enable progress display

Examples

mifFile <- system.file(
    "extdata", "testdata", "simple",
    "simple_interior.mif",
    package = "alcyon"
  )
  sfMap <- st_read(mifFile,
    geometry_column = 1L, quiet = TRUE
  )
  pointMap <- makeVGAPointMap(
    sfMap,
    gridSize = 0.5,
    fillX = 3.0,
    fillY = 6.0,
    maxVisibility = NA,
    boundaryGraph = FALSE,
    verbose = FALSE
  )
vgaVisualLocal(pointMap, FALSE)