getStreamDistMatInt: Extracts downstream-only hydrologic distances for two vectors...

In jayverhoef/SSNbd: Spatial Modeling for Big Data Sets on Stream Networks

Description

Extracts downstream-only hydrologic distances for two vectors of pids and returns a list of distance matrices.

Usage

getStreamDistMatInt(ssn, pidset1, dataID1, pidset2 = NULL,
  dataID2 = NULL)

Arguments

ssn	a SpatialStreamNetwork object created using the SSN package
pidset1	a vector of pids found within a SpatialStreamNetwork object
dataID1	a character string representing the name of the dataset found in the SpatialStreamNetwork object slot ID
pidset2	a vector of pids found within a SpatialStreamNetwork object. Default = NULL.
dataID2	a character string representing the name of the dataset found in the SpatialStreamNetwork object slot ID. Default = NULL.

Value

a list matrices containing the of downstream-only hydrologic distance for pidset1 and pidset2. If pidset2 is omitted, the function returns the downstream-only hydrologic distances between pidset1 and pidset1. See documentation for createBigDistMat for more information about the format of the distance matrices.

Author(s)

Erin Peterson

Examples

## ssn<- importSSN("raw5.ssn", predpts = "preds")
## createBigDistMat(ssn, predpts = "preds", o.write = TRUE, amongpreds = TRUE,
##                  no.cores = 2)
## pidset1 <- c(1, 3, 9, 28, 34, 51)
## pidset2 <- c(4, 7, 30, 35)
## distmats <- getStreamDistMatInt(ssn, pidset1, dataID1 = "preds",
##                                  pidset2 = pidset2, dataID2 = "preds")

jayverhoef/SSNbd documentation built on April 1, 2020, 8:06 a.m.