nodeSpatial: Vertices as Spatial points.

In mdsumner/rbgm: Tools for 'Box Geometry Model' (BGM) Files and Topology for the Atlantis Ecosystem Model

Vertices as Spatial points.

Description

Obtain all vertices as a SpatialPointsDataFrame or a sf dataframe.

Usage

nodeSpatial(bgm)

node_sf(bgm)

pointSpatial(bgm)

point_sf(bgm)

Arguments

bgm	BGM object from bgmfile

Details

Nodes are the unique coordinates (or vertices), points are the instances of those coordinates that exist in the model. point_sp or point_sf return all instances of the vertices with information about which boxes they belong to. node_sp and node_sf return all vertices.

Value

SpatialPointsDataFrame or sf data frame

Warning

The sf objects created by 'box_sf()', 'node_sf()', 'face_sf()', 'boundary_sf()' and 'point_sf()' were not created by the sf package. They were created with reference to the sf format prior to November 2019. If you have problems it may be necessary to recreate the 'crs' part of the of the object with code like 'x <- node_sf(bgm); library(sf); st_crs(x) <- st_crs(attr(x$geometry, "crs")$proj)'.

Get in touch ([create an issue](https://github.com/AustralianAntarcticDivision/rbgm/issues)) if you have any troubles.

Examples

fname <- bgmfiles::bgmfiles(pattern = "antarctica_28")
bgm <- bgmfile(fname)
spnode <- node_sp(bgm)
names(spnode)
nrow(spnode)  ## only unique vertices
nrow(bgm$vertices)

sppoints <- point_sp(bgm)
names(sppoints)
nrow(sppoints)
names(point_sf(bgm))

mdsumner/rbgm documentation built on June 15, 2025, 6:14 a.m.