fm_hexagon_lattice: Create hexagon lattice points

In fmesher: Triangle Meshes and Related Geometry Tools

Create hexagon lattice points

Description

from ⁠0.3.0.9001⁠. Create hexagon lattice points within a boundary. By default, the hexagonal lattice is anchored at the coordinate system origin, so that grids with different but overlapping boundaries will have matching points.

Usage

fm_hexagon_lattice(
  bnd,
  edge_len = NULL,
  buffer_n = 0.49,
  align = "origin",
  meta = FALSE
)

Arguments

bnd	Boundary object (currently must be an sf polygon)
edge_len	Triangle edge length. Default diff(fm_bbox(bnd)[[1]]) / 250.
buffer_n	Number of triangle height multiples for buffer inside the boundary object to the start of the lattice. Default 0.49.
align	Alignment of the hexagon lattice, either a length-2 numeric, or character, a sf/sfc/sfg object containing a single point), or character, default "origin": "origin" align the lattice with the coordinate system origin "bbox" align the lattice with the midpoint of the bounding box of bnd "centroid" align the lattice with the centroid of the boundary, sf::st_centroid(bnd)
meta	logical; if TRUE, return a list with diagnostic information from the lattice construction (including the points themselves in lattice)

Value

An sfc object with points, if meta is FALSE (default), or if meta=TRUE, a list:

lattice

sfc with lattice points

edge_len

numeric with edge length

bnd_inner

sf object with the inner boundary used to filter points outside of a edge_len * buffer_n distance from the boundary

grid_n

integer with the number of points in each direction prior to filtering

align

numeric with the alignment coordinates of the hexagon lattice

Author(s)

Man Ho Suen [e-mail], Finn Lindgren [e-mail]

See Also

fm_mesh_2d()

Examples

(m <- fm_mesh_2d(
  fm_hexagon_lattice(
    fmexample$boundary_sf[[1]],
    edge_len = 0.1 * 5
  ),
  max.edge = c(0.2, 1) * 5,
  boundary = fmexample$boundary_sf
))

(m2 <- fm_mesh_2d(
  fm_hexagon_lattice(
    fmexample$boundary_sf[[1]],
    edge_len = 0.1 * 5,
    align = "centroid"
  ),
  max.edge = c(0.2, 1) * 5,
  boundary = fmexample$boundary_sf
))

if (require("ggplot2", quietly = TRUE) &&
  require("patchwork", quietly = TRUE)) {
  ((ggplot() +
    geom_fm(data = m) +
    geom_point(aes(0, 0), col = "red")) |
    (ggplot() +
      geom_fm(data = m2) +
      geom_point(aes(0, 0), col = "red") +
      geom_sf(data = sf::st_centroid(fmexample$boundary_sf[[1]]))
    )
  )
}

fmesher documentation built on June 12, 2025, 5:09 p.m.