Skip to contents

Methods to convert raster or point data to distributions. Each layer of a raster will be treated as a distribution. With point data each point will be treated as a "one hot" distribution containing mostly 0 and a single 1 at the location corresponding to the point.

Usage

as_distr(x, bf, ...)

# S3 method for class 'data.frame'
as_distr(x, bf, crs = NULL, ...)

# S3 method for class 'SpatRaster'
as_distr(x, bf, normalize = TRUE, zero_na = TRUE, ...)

# S3 method for class 'sf'
as_distr(x, bf, ...)

Arguments

x

An object to be converted either a data.frame with x and y columns indicating point locations, a sf object containing points, or a raster object containing values to be treated as a distribution.

bf

A reference BirdFlow object.

...

Arguments used by other methods.

crs

The coordinate reference system that the x and y coordinates are in. If NULL the function will assume coordinates are in the same CRS as bf.

normalize

if TRUE normalize each distribution to sum to 1

zero_na

if TRUE replace NA values with 0.

Value

An object containing distribution data to be projected with x. Either a vector with n_active(bf) values or a matrix with that many rows and a column for each distribution.

Details

If x is a data.frame it should have columns x and y containing the coordinates of points. crs should indicate the coordinate reference system the points are in - only necessary if it differs from crs(bf).

If x is either an sf object or a data frame it should represent points. Each point will be converted into a separate distribution with the cell corresponding to the point having a value of 1 with the remaining values set to 0.

If x is a terra::SpatRaster() it will be projected to align with the cells in bf with terra::project() using method = "average" and then cropped and/or extended to match the extent of bf. Warnings will be throw if some of the value in x is lost due to cropping or due to masking out the inactive cells.

Examples

# \donttest{
bf <- BirdFlowExamples::amewoo
xy <- i_to_xy(c(1, 2), bf)

# data.frame method: one "one hot" distribution per point
pts <- data.frame(x = xy$x, y = xy$y)
as_distr(pts, bf)
#>        [,1] [,2]
#>   [1,]    1    0
#>   [2,]    0    1
#>   [3,]    0    0
#>   [4,]    0    0
#>   [5,]    0    0
#>   [6,]    0    0
#>   [7,]    0    0
#>   [8,]    0    0
#>   [9,]    0    0
#>  [10,]    0    0
#>  [11,]    0    0
#>  [12,]    0    0
#>  [13,]    0    0
#>  [14,]    0    0
#>  [15,]    0    0
#>  [16,]    0    0
#>  [17,]    0    0
#>  [18,]    0    0
#>  [19,]    0    0
#>  [20,]    0    0
#>  [21,]    0    0
#>  [22,]    0    0
#>  [23,]    0    0
#>  [24,]    0    0
#>  [25,]    0    0
#>  [26,]    0    0
#>  [27,]    0    0
#>  [28,]    0    0
#>  [29,]    0    0
#>  [30,]    0    0
#>  [31,]    0    0
#>  [32,]    0    0
#>  [33,]    0    0
#>  [34,]    0    0
#>  [35,]    0    0
#>  [36,]    0    0
#>  [37,]    0    0
#>  [38,]    0    0
#>  [39,]    0    0
#>  [40,]    0    0
#>  [41,]    0    0
#>  [42,]    0    0
#>  [43,]    0    0
#>  [44,]    0    0
#>  [45,]    0    0
#>  [46,]    0    0
#>  [47,]    0    0
#>  [48,]    0    0
#>  [49,]    0    0
#>  [50,]    0    0
#>  [51,]    0    0
#>  [52,]    0    0
#>  [53,]    0    0
#>  [54,]    0    0
#>  [55,]    0    0
#>  [56,]    0    0
#>  [57,]    0    0
#>  [58,]    0    0
#>  [59,]    0    0
#>  [60,]    0    0
#>  [61,]    0    0
#>  [62,]    0    0
#>  [63,]    0    0
#>  [64,]    0    0
#>  [65,]    0    0
#>  [66,]    0    0
#>  [67,]    0    0
#>  [68,]    0    0
#>  [69,]    0    0
#>  [70,]    0    0
#>  [71,]    0    0
#>  [72,]    0    0
#>  [73,]    0    0
#>  [74,]    0    0
#>  [75,]    0    0
#>  [76,]    0    0
#>  [77,]    0    0
#>  [78,]    0    0
#>  [79,]    0    0
#>  [80,]    0    0
#>  [81,]    0    0
#>  [82,]    0    0
#>  [83,]    0    0
#>  [84,]    0    0
#>  [85,]    0    0
#>  [86,]    0    0
#>  [87,]    0    0
#>  [88,]    0    0
#>  [89,]    0    0
#>  [90,]    0    0
#>  [91,]    0    0
#>  [92,]    0    0
#>  [93,]    0    0
#>  [94,]    0    0
#>  [95,]    0    0
#>  [96,]    0    0
#>  [97,]    0    0
#>  [98,]    0    0
#>  [99,]    0    0
#> [100,]    0    0
#> [101,]    0    0
#> [102,]    0    0
#> [103,]    0    0
#> [104,]    0    0
#> [105,]    0    0
#> [106,]    0    0
#> [107,]    0    0
#> [108,]    0    0
#> [109,]    0    0
#> [110,]    0    0
#> [111,]    0    0
#> [112,]    0    0
#> [113,]    0    0
#> [114,]    0    0
#> [115,]    0    0
#> [116,]    0    0
#> [117,]    0    0
#> [118,]    0    0
#> [119,]    0    0
#> [120,]    0    0
#> [121,]    0    0
#> [122,]    0    0
#> [123,]    0    0
#> [124,]    0    0
#> [125,]    0    0
#> [126,]    0    0
#> [127,]    0    0
#> [128,]    0    0
#> [129,]    0    0
#> [130,]    0    0
#> [131,]    0    0
#> [132,]    0    0
#> [133,]    0    0
#> [134,]    0    0
#> [135,]    0    0
#> [136,]    0    0
#> [137,]    0    0
#> [138,]    0    0
#> [139,]    0    0
#> [140,]    0    0
#> [141,]    0    0
#> [142,]    0    0
#> [143,]    0    0
#> [144,]    0    0
#> [145,]    0    0
#> [146,]    0    0
#> [147,]    0    0
#> [148,]    0    0
#> [149,]    0    0
#> [150,]    0    0
#> [151,]    0    0
#> [152,]    0    0
#> [153,]    0    0
#> [154,]    0    0
#> [155,]    0    0
#> [156,]    0    0
#> [157,]    0    0
#> [158,]    0    0
#> [159,]    0    0
#> [160,]    0    0
#> [161,]    0    0
#> [162,]    0    0
#> [163,]    0    0
#> [164,]    0    0
#> [165,]    0    0
#> [166,]    0    0
#> [167,]    0    0
#> [168,]    0    0
#> [169,]    0    0
#> [170,]    0    0
#> [171,]    0    0
#> [172,]    0    0
#> [173,]    0    0
#> [174,]    0    0
#> [175,]    0    0
#> [176,]    0    0
#> [177,]    0    0
#> [178,]    0    0
#> [179,]    0    0
#> [180,]    0    0
#> [181,]    0    0
#> [182,]    0    0
#> [183,]    0    0
#> [184,]    0    0
#> [185,]    0    0
#> [186,]    0    0
#> [187,]    0    0
#> [188,]    0    0
#> [189,]    0    0
#> [190,]    0    0
#> [191,]    0    0
#> [192,]    0    0
#> [193,]    0    0
#> [194,]    0    0
#> [195,]    0    0
#> [196,]    0    0
#> [197,]    0    0
#> [198,]    0    0
#> [199,]    0    0
#> [200,]    0    0
#> [201,]    0    0
#> [202,]    0    0
#> [203,]    0    0
#> [204,]    0    0
#> [205,]    0    0
#> [206,]    0    0
#> [207,]    0    0
#> [208,]    0    0
#> [209,]    0    0
#> [210,]    0    0
#> [211,]    0    0
#> [212,]    0    0
#> [213,]    0    0
#> [214,]    0    0
#> [215,]    0    0
#> [216,]    0    0
#> [217,]    0    0
#> [218,]    0    0
#> [219,]    0    0
#> [220,]    0    0
#> [221,]    0    0
#> [222,]    0    0
#> [223,]    0    0
#> [224,]    0    0
#> [225,]    0    0
#> [226,]    0    0
#> [227,]    0    0
#> [228,]    0    0
#> [229,]    0    0
#> [230,]    0    0
#> [231,]    0    0
#> [232,]    0    0
#> [233,]    0    0
#> [234,]    0    0
#> [235,]    0    0
#> [236,]    0    0
#> [237,]    0    0
#> [238,]    0    0
#> [239,]    0    0
#> [240,]    0    0
#> [241,]    0    0
#> [242,]    0    0
#> [243,]    0    0
#> [244,]    0    0
#> [245,]    0    0
#> [246,]    0    0
#> [247,]    0    0
#> [248,]    0    0
#> [249,]    0    0
#> [250,]    0    0
#> [251,]    0    0
#> [252,]    0    0
#> [253,]    0    0
#> [254,]    0    0
#> [255,]    0    0
#> [256,]    0    0
#> [257,]    0    0
#> [258,]    0    0
#> [259,]    0    0
#> [260,]    0    0
#> [261,]    0    0
#> [262,]    0    0
#> [263,]    0    0
#> [264,]    0    0
#> [265,]    0    0
#> [266,]    0    0
#> [267,]    0    0
#> [268,]    0    0
#> [269,]    0    0
#> [270,]    0    0
#> [271,]    0    0
#> [272,]    0    0
#> [273,]    0    0
#> [274,]    0    0
#> [275,]    0    0
#> [276,]    0    0
#> [277,]    0    0
#> [278,]    0    0
#> [279,]    0    0
#> [280,]    0    0
#> [281,]    0    0
#> [282,]    0    0
#> [283,]    0    0

# sf method
sf_pts <- sf::st_as_sf(pts, coords = c("x", "y"), crs = crs(bf))
as_distr(sf_pts, bf)
#>        [,1] [,2]
#>   [1,]    1    0
#>   [2,]    0    1
#>   [3,]    0    0
#>   [4,]    0    0
#>   [5,]    0    0
#>   [6,]    0    0
#>   [7,]    0    0
#>   [8,]    0    0
#>   [9,]    0    0
#>  [10,]    0    0
#>  [11,]    0    0
#>  [12,]    0    0
#>  [13,]    0    0
#>  [14,]    0    0
#>  [15,]    0    0
#>  [16,]    0    0
#>  [17,]    0    0
#>  [18,]    0    0
#>  [19,]    0    0
#>  [20,]    0    0
#>  [21,]    0    0
#>  [22,]    0    0
#>  [23,]    0    0
#>  [24,]    0    0
#>  [25,]    0    0
#>  [26,]    0    0
#>  [27,]    0    0
#>  [28,]    0    0
#>  [29,]    0    0
#>  [30,]    0    0
#>  [31,]    0    0
#>  [32,]    0    0
#>  [33,]    0    0
#>  [34,]    0    0
#>  [35,]    0    0
#>  [36,]    0    0
#>  [37,]    0    0
#>  [38,]    0    0
#>  [39,]    0    0
#>  [40,]    0    0
#>  [41,]    0    0
#>  [42,]    0    0
#>  [43,]    0    0
#>  [44,]    0    0
#>  [45,]    0    0
#>  [46,]    0    0
#>  [47,]    0    0
#>  [48,]    0    0
#>  [49,]    0    0
#>  [50,]    0    0
#>  [51,]    0    0
#>  [52,]    0    0
#>  [53,]    0    0
#>  [54,]    0    0
#>  [55,]    0    0
#>  [56,]    0    0
#>  [57,]    0    0
#>  [58,]    0    0
#>  [59,]    0    0
#>  [60,]    0    0
#>  [61,]    0    0
#>  [62,]    0    0
#>  [63,]    0    0
#>  [64,]    0    0
#>  [65,]    0    0
#>  [66,]    0    0
#>  [67,]    0    0
#>  [68,]    0    0
#>  [69,]    0    0
#>  [70,]    0    0
#>  [71,]    0    0
#>  [72,]    0    0
#>  [73,]    0    0
#>  [74,]    0    0
#>  [75,]    0    0
#>  [76,]    0    0
#>  [77,]    0    0
#>  [78,]    0    0
#>  [79,]    0    0
#>  [80,]    0    0
#>  [81,]    0    0
#>  [82,]    0    0
#>  [83,]    0    0
#>  [84,]    0    0
#>  [85,]    0    0
#>  [86,]    0    0
#>  [87,]    0    0
#>  [88,]    0    0
#>  [89,]    0    0
#>  [90,]    0    0
#>  [91,]    0    0
#>  [92,]    0    0
#>  [93,]    0    0
#>  [94,]    0    0
#>  [95,]    0    0
#>  [96,]    0    0
#>  [97,]    0    0
#>  [98,]    0    0
#>  [99,]    0    0
#> [100,]    0    0
#> [101,]    0    0
#> [102,]    0    0
#> [103,]    0    0
#> [104,]    0    0
#> [105,]    0    0
#> [106,]    0    0
#> [107,]    0    0
#> [108,]    0    0
#> [109,]    0    0
#> [110,]    0    0
#> [111,]    0    0
#> [112,]    0    0
#> [113,]    0    0
#> [114,]    0    0
#> [115,]    0    0
#> [116,]    0    0
#> [117,]    0    0
#> [118,]    0    0
#> [119,]    0    0
#> [120,]    0    0
#> [121,]    0    0
#> [122,]    0    0
#> [123,]    0    0
#> [124,]    0    0
#> [125,]    0    0
#> [126,]    0    0
#> [127,]    0    0
#> [128,]    0    0
#> [129,]    0    0
#> [130,]    0    0
#> [131,]    0    0
#> [132,]    0    0
#> [133,]    0    0
#> [134,]    0    0
#> [135,]    0    0
#> [136,]    0    0
#> [137,]    0    0
#> [138,]    0    0
#> [139,]    0    0
#> [140,]    0    0
#> [141,]    0    0
#> [142,]    0    0
#> [143,]    0    0
#> [144,]    0    0
#> [145,]    0    0
#> [146,]    0    0
#> [147,]    0    0
#> [148,]    0    0
#> [149,]    0    0
#> [150,]    0    0
#> [151,]    0    0
#> [152,]    0    0
#> [153,]    0    0
#> [154,]    0    0
#> [155,]    0    0
#> [156,]    0    0
#> [157,]    0    0
#> [158,]    0    0
#> [159,]    0    0
#> [160,]    0    0
#> [161,]    0    0
#> [162,]    0    0
#> [163,]    0    0
#> [164,]    0    0
#> [165,]    0    0
#> [166,]    0    0
#> [167,]    0    0
#> [168,]    0    0
#> [169,]    0    0
#> [170,]    0    0
#> [171,]    0    0
#> [172,]    0    0
#> [173,]    0    0
#> [174,]    0    0
#> [175,]    0    0
#> [176,]    0    0
#> [177,]    0    0
#> [178,]    0    0
#> [179,]    0    0
#> [180,]    0    0
#> [181,]    0    0
#> [182,]    0    0
#> [183,]    0    0
#> [184,]    0    0
#> [185,]    0    0
#> [186,]    0    0
#> [187,]    0    0
#> [188,]    0    0
#> [189,]    0    0
#> [190,]    0    0
#> [191,]    0    0
#> [192,]    0    0
#> [193,]    0    0
#> [194,]    0    0
#> [195,]    0    0
#> [196,]    0    0
#> [197,]    0    0
#> [198,]    0    0
#> [199,]    0    0
#> [200,]    0    0
#> [201,]    0    0
#> [202,]    0    0
#> [203,]    0    0
#> [204,]    0    0
#> [205,]    0    0
#> [206,]    0    0
#> [207,]    0    0
#> [208,]    0    0
#> [209,]    0    0
#> [210,]    0    0
#> [211,]    0    0
#> [212,]    0    0
#> [213,]    0    0
#> [214,]    0    0
#> [215,]    0    0
#> [216,]    0    0
#> [217,]    0    0
#> [218,]    0    0
#> [219,]    0    0
#> [220,]    0    0
#> [221,]    0    0
#> [222,]    0    0
#> [223,]    0    0
#> [224,]    0    0
#> [225,]    0    0
#> [226,]    0    0
#> [227,]    0    0
#> [228,]    0    0
#> [229,]    0    0
#> [230,]    0    0
#> [231,]    0    0
#> [232,]    0    0
#> [233,]    0    0
#> [234,]    0    0
#> [235,]    0    0
#> [236,]    0    0
#> [237,]    0    0
#> [238,]    0    0
#> [239,]    0    0
#> [240,]    0    0
#> [241,]    0    0
#> [242,]    0    0
#> [243,]    0    0
#> [244,]    0    0
#> [245,]    0    0
#> [246,]    0    0
#> [247,]    0    0
#> [248,]    0    0
#> [249,]    0    0
#> [250,]    0    0
#> [251,]    0    0
#> [252,]    0    0
#> [253,]    0    0
#> [254,]    0    0
#> [255,]    0    0
#> [256,]    0    0
#> [257,]    0    0
#> [258,]    0    0
#> [259,]    0    0
#> [260,]    0    0
#> [261,]    0    0
#> [262,]    0    0
#> [263,]    0    0
#> [264,]    0    0
#> [265,]    0    0
#> [266,]    0    0
#> [267,]    0    0
#> [268,]    0    0
#> [269,]    0    0
#> [270,]    0    0
#> [271,]    0    0
#> [272,]    0    0
#> [273,]    0    0
#> [274,]    0    0
#> [275,]    0    0
#> [276,]    0    0
#> [277,]    0    0
#> [278,]    0    0
#> [279,]    0    0
#> [280,]    0    0
#> [281,]    0    0
#> [282,]    0    0
#> [283,]    0    0

# SpatRaster method
r <- rast(bf, which = 1)
as_distr(r, bf)
#>   [1] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>   [6] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [11] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [16] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [21] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [26] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [31] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [36] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [41] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [46] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [51] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [56] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [61] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [66] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [71] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [76] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [81] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [86] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [91] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#>  [96] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [101] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [106] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [111] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [116] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [121] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [126] 0.000000e+00 2.654108e-06 9.882774e-04 3.971355e-03 0.000000e+00
#> [131] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [136] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [141] 0.000000e+00 0.000000e+00 5.919668e-07 4.710217e-04 4.330653e-04
#> [146] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [151] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [156] 0.000000e+00 0.000000e+00 3.464510e-06 1.961725e-03 6.931312e-03
#> [161] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [166] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [171] 7.508743e-06 2.957621e-03 8.718165e-03 4.529720e-03 0.000000e+00
#> [176] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [181] 2.482801e-05 2.028553e-04 9.213331e-07 0.000000e+00 0.000000e+00
#> [186] 2.838783e-03 4.215964e-02 4.163246e-02 6.921357e-03 0.000000e+00
#> [191] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00
#> [196] 3.273664e-03 8.458369e-03 6.163124e-03 1.959965e-03 4.947349e-04
#> [201] 3.204921e-02 4.898101e-02 4.168029e-02 1.578872e-02 0.000000e+00
#> [206] 0.000000e+00 0.000000e+00 0.000000e+00 0.000000e+00 3.752682e-04
#> [211] 1.400020e-02 1.569149e-02 2.634848e-02 1.136832e-02 2.790600e-02
#> [216] 5.111686e-02 3.304982e-02 1.808712e-02 2.444598e-03 6.770740e-06
#> [221] 1.619776e-05 8.352012e-05 1.513218e-03 4.433005e-04 2.247404e-03
#> [226] 1.239867e-02 1.664490e-02 4.570713e-02 2.850836e-02 2.633825e-02
#> [231] 3.541156e-02 1.931686e-02 5.252171e-04 5.706915e-04 4.045021e-03
#> [236] 1.625290e-02 6.044832e-03 1.712079e-04 5.228329e-03 1.918284e-02
#> [241] 5.111686e-02 1.977860e-02 1.168555e-02 1.966511e-02 4.374494e-02
#> [246] 0.000000e+00 3.067777e-04 9.318547e-04 9.440010e-03 1.819547e-02
#> [251] 7.850784e-03 1.659561e-03 1.632366e-03 7.892153e-03 1.439658e-02
#> [256] 5.863142e-03 2.924571e-03 1.240335e-03 3.411255e-06 6.777501e-04
#> [261] 4.919647e-03 7.542769e-03 9.197147e-03 9.636015e-03 3.672142e-03
#> [266] 7.859617e-04 1.457520e-04 1.932125e-03 6.706695e-03 1.859059e-03
#> [271] 1.894553e-03 1.634350e-07 8.295965e-05 1.789877e-03 3.678946e-03
#> [276] 1.492053e-04 3.081023e-04 4.024127e-05 6.266951e-04 1.115313e-03
#> [281] 2.556100e-04 2.410929e-06 9.835884e-07
#> attr(,"time")
#> [1] "January 4"
# }