PP3: Generator of 3D horizontal PointPattern objects with...

Description Usage Arguments Details Value See Also Examples

View source: R/pgs.R

Description

Create a PointPattern-class object representing a 3D point pattern with 1,4,5,6,7,8 or 9 points lying in a horizontal rectangle.

Usage

1
PP3(n=4,xp=1,yp=xp,h3=TRUE)

Arguments

n

the number of points. Must be 1,4,5,6,7,8 or 9. Default, 4.

xp

the side length of the bounding rectangle, parallel to the x-axis. Default, 1.

yp

the side length of the bounding rectangle, parallel to the y-axis. Default, xp.

h3

if TRUE, alignments of 3 points (see details below) are made in the direction of the x-axis (in the direction of the y-axis if FALSE). Used only for n=6, 7 or 8.

Details

The 3D point pattern follows the construction rules of the 2D point pattern generator PP2: when n=4, the four points lie at the four corners of the rectangle. When n=5, the fifth point lies at the center of the rectangle. When n=6 (and h3 is TRUE), four points lie at the rectangle corners and the two other points lie at the centres of the "top" and "bottom" edges (parallel to the x-axis). When n=7 (and h3 is TRUE), the point pattern consists of 3 "horizontal" alignments of 2, 3 and 2 points. When n=8 (and h3 is TRUE), the point pattern consists of 3 "horizontal" alignments of 3, 2 and 3 points. When n=9, the point pattern consists of 3 ("horizontal" or "vertical") alignments of 3 points.

Value

A PointPattern-class object.

See Also

Generators of point patterns PointPattern, PP2, generators of point pattern lattices PPBCRectLat3, PPFCRectLat3, PPRectLat3.

Examples

1
PP3(5,1,2)

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