PPBCRectLat3: Generator of 3D body-centered rectangular lattices of...

Description Usage Arguments Value See Also Examples

View source: R/pgs.R

Description

Create a FigLat-class object representing a 3D body-centered rectangular lattice of horizontal point patterns lying in a rectangle.

Usage

1
PPBCRectLat3(dx=1,dy=dx,dz=dx,n=1,xp=dx/5,yp=xp,h3=TRUE)

Arguments

dx

the spacing of the vector lattice along the x-axis. Default: 1.

dy

the spacing of the vector lattice along the y-axis. Default: dx.

dz

the spacing of the vector lattice along the y-axis. Default: dx.

n

the number of points in each point pattern. Valid values for n: 1, 4, 5, 6, 7, 8 or 9 (see PP3 or PP2 documentations). Default: 1 (lattice of points).

xp

the side length of the bounding rectangle, parallel to the x-axis. Default: dx/5.

yp

the side length of the bounding rectangle, parallel to the y-axis. Default: xp (square bounding box for each point pattern).

h3

determines the orientation of the point pattern when n=6, 7 or 8, see PP3 or PP2 documentations.

Value

A FigLat-class object.

See Also

Generators FigLat, PointPattern, PP3, BCRectLat3, generators of other 3D lattices of point patterns PPFCRectLat3, PPRectLat3.

Examples

1
2
PPBCRectLat3()# 3D unit body-centered rectangular vector lattice
print(PPBCRectLat3(dx=1,n=7))

pgs documentation built on May 29, 2017, 5:30 p.m.