sHexPolygon: Function to extract polygon location per hexagon within a...

Description Usage Arguments Value Note See Also Examples

Description

sHexPolygon is supposed to extract polygon location per hexagon within a supra-hexagonal grid

Usage

1
sHexPolygon(sObj, area.size = 1)

Arguments

sObj

an object of class "sMap" or "sInit" or "sTopol" or "sHex"

area.size

an integer or a vector specifying the area size of each hexagon

Value

a tibble of 7 columns ('index','x','y','node','edge','stepCentroid','angleCentroid') storing polygon location per hexagon. 'node' for nodes (including n1,n2,n3,n4,n5,n6), and 'edge' for a list-column where each is a tibble with a single column 'edge' containing two rows (such as edges 'e12' and 'e16' for the node 'n1').

Note

None

See Also

sHexGridVariant, sPipeline

Examples

1
2
sObj <- sTopology(xdim=4, ydim=4, lattice="hexa", shape="suprahex")
df_polygon <- sHexPolygon(sObj, area.size=1)

hfang-bristol/supraHex documentation built on May 24, 2021, 3:13 p.m.