Dimensions of a BirdFlow object

Functions to return BirdFlow model dimensions and other basic information

Usage

# S3 method for class 'BirdFlow'
nrow(x)

# S3 method for class 'BirdFlow'
ncol(x)

# S3 method for class 'BirdFlow'
dim(x)

n_timesteps(x)

n_distr(x)

n_transitions(x)

n_active(x)

# S4 method for class 'BirdFlow'
crs(x, proj = FALSE, describe = FALSE, parse = FALSE)

# S4 method for class 'BirdFlow'
ext(x)

# S4 method for class 'BirdFlow'
res(x)

# S4 method for class 'BirdFlow'
xres(x)

# S4 method for class 'BirdFlow'
yres(x)

# S4 method for class 'BirdFlow'
xmin(x)

# S4 method for class 'BirdFlow'
ymin(x)

# S4 method for class 'BirdFlow'
xmax(x)

# S4 method for class 'BirdFlow'
ymax(x)

is_cyclical(x)

n_parameters(x)

Arguments

x: A BirdFlow object
proj: logical. If TRUE the crs is returned in PROJ-string notation
describe: logical. If TRUE the name, EPSG code, and the name and extent of the area of use are returned if known
parse: logical. If TRUE, wkt parts are parsed into a vector (each line becomes an element)

Value

nrow() returns the number of rows in the raster extent of the BirdFlow model

ncol() number of columns in the raster extent

dim() number of rows and columns in the raster extent.

n_timesteps() number of timesteps distributions.

n_distr() number of distributions

n_transitions() number of transitions, if the model is circular in time this will equal n_timesteps().

n_active() number of active cells (locations).

crs() the coordinate reference system, a character with well known text (WKT) by default, but see arguments.

ext() a SpatExtent object, which contains the xmin, xmax, ymin, and ymax of the extent.

res() two numbers, the cell width and height (x and y resolution).

xres() the width of the cells (x resolution).

yres() the height of the cells (y resolution).

xmin() minimum x coordinate of extent.

ymin() minimum y coordinate of extent.

xmax() maximum x coordinate of extent.

ymax() maximum y coordinate of extent.

is_cyclical() returns TRUE if the BirdFlow model has a transition from the last timestep to the first and FALSE otherwise.

n_parameters() the number of of parameters that the BirdFlow model contains or will contain. This is the number of cells in the marginal matrices + the sum of the dynamic mask for the first timestep (number of unmasked cells at the first timestep). If the model isn't dynamically masked this is equivalent to n_active(x)^2 * n_transitons(x) + n_active(x)

Usage

Arguments

Value

See also