Skip to content
GitLab
Select Git revision
  • master default
  • fortran_module
  • dev
  • 1.1.0
  • 1.0.11
  • 1.0.7
  • 1.0.6
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.1.2
  • 0.1.1
  • 0.1.0
Find file BlameHistoryPermalink
hdist.Rd 3.12 KiB
1 
% Generated by roxygen2: do not edit by hand
2 
% Please edit documentation in R/hdist.R
3 
\name{hdist}
4 
\alias{hdist}
5 
\alias{hdist.sfc}
6 
\alias{hdist.sf}
7 
\alias{hdist.stars}
8 
\alias{hdist.transfR}
9 
\title{Geographical distance between catchments}
10 
\usage{
11 
hdist(x, y, ...)
12
13 
\method{hdist}{sfc}(
14 
  x,
15 
  y,
16 
  method = "rghosh",
17 
  gres = 5,
18 
  ditself = FALSE,
19 
  maxsample = 25000,
20 
  proj = NULL,
21 
  parallel = FALSE,
22 
  cores = NULL,
23 
  verbose = TRUE,
24 
  ...
25 
)
26
27 
\method{hdist}{sf}(x, y, ...)
28
29 
\method{hdist}{stars}(x, y, ...)
30
31 
\method{hdist}{transfR}(x, y, method = "rghosh", weightO = 0.8, weightC = 0.2, ...)
32 
}
33 
\arguments{
34 
\item{x}{sf, stars or transfR object of the first catchments}
35
36 
\item{y}{sf, stars or transfR object of the second catchments}
37
38 
\item{...}{further arguments passed to or from other methods}
39
40 
\item{method}{the method to use for computing distance. This must be one of "ghosh",
41 
"rghosh", "points", "centroids", "combined"}
42
43 
\item{gres}{resolution of spatial discretisation (number of points by km²) for Ghosh
44 
distance}
45
46 
\item{ditself}{logical value indicating if the distance to itself should be computed.
47 
It will add one row and one column in the distance matrix. Only used if method is "ghosh"}
48
49 
\item{maxsample}{maximum size of sampling points for each catchments during spatial discretisation}
50
51 
\item{proj}{logical indicating if spatial layer are using a projection. If TRUE, euclidean
52 
distance is used. If FALSE, the great-circle distance is used}
53
54 
\item{parallel}{logical indicating whether the computation should be parallelised. Could be a vector
55 
of length two to distinguish between parallelisation of sampling and Ghosh distance
56 
(because sampling over large areas can be memory intensive)}
57
58 
\item{cores}{the number of cores to use for parallel execution if \code{parallel} is TRUE.
59 
If not specified, the number of cores is set to the value of \code{parallel::detectCores()}.
60 
Similarly to \code{parallel}, it could be a vector of length two to distinguish between
61 
parallelisation of sampling and Ghosh distance}
62
63 
\item{verbose}{boolean indicating if information messages should be written to the console}
64
65 
\item{weightO}{weight given to the distance between outlets if method is "combined"}
66
67 
\item{weightC}{weight given to the distance between centroids if method is "combined"}
68 
}
69 
\value{
70 
A matrix of class units with the catchments of \code{x} organised in rows
7172737475767778798081828384858687888990919293949596
and the catchments of \code{y} organised in columns. } \description{ Calculate distances between two sets of catchments using their spatial support. } \details{ The \code{method} "ghosh" refers to a simplification of the distance defined by \insertCite{Ghosh1951;textual}{transfR} as proposed by \insertCite{Gottschalk1993,Gottschalk2011;textual}{transfR}. The rescaled Ghosh distance (\code{method} "rghosh") is calculated following \insertCite{deLavenne2016;textual}{transfR}. } \examples{ data(Oudon) catchments <- st_geometry(Oudon$obs) hdist(x = catchments[1:2], y = catchments[3:5], gres = 5, method = "rghosh", parallel=c(FALSE, TRUE), cores=2) } \references{ \insertRef{Ghosh1951}{transfR} \insertRef{Gottschalk1993}{transfR} \insertRef{Gottschalk2011}{transfR} \insertRef{deLavenne2016}{transfR} }