hcpcluster: Generate spherical clusters with hexagonal close packed...

View source: R/rapt_cluster-sim.R

hcpclusterR Documentation

Generate spherical clusters with hexagonal close packed spacing.

Description

Generates perfectly spherical clusters with structred order of hexagonal close packing (HCP). Can define cluster separation, cluster radius, inter cluster density, background density, and window size.

Usage

hcpcluster(csep_r, R, sigma1, sigma2, win, background, filepath)

Arguments

csep_r

Cluster separation radius. That is, the radius of the spheres in the HCP structure.

R

Cluster radius.

sigma1

Inter cluster density. Value between 0 and 1.

sigma2

Background density. Value between 0 and 1.

win

A box3 object containing the window of the cluster set you want to make.

background

Either 'poisson' or 'rcp'. Whether to have Poission distributed points or RCP points for the points in the clusters and in the background.

filepath

Needed if background = 'rcp'. Vector with the filepath to 1 the FinalConfig file of the RCP pattern desired, 2 the system file of the RCP pattern desired

Value

A list of [1] A pp3 object containing the cluster points, [2] The overall intensity of the point pattern; Total number of points/total volume.


aproudian2/rapt documentation built on Dec. 15, 2022, 4:24 a.m.