morph_rods: Simulate morphology of guest rods in a two-phase system

View source: R/rapt_cluster-sim.R

morph_rodsR Documentation

Simulate morphology of guest rods in a two-phase system

Description

Simulate morphology of guest rods in a two-phase system

Usage

morph_rods(
  lambda,
  frac,
  rod.norm = "z",
  rod.den,
  rod.spacing = "grid",
  rcp.path = NULL,
  point.den = 1,
  toplot = FALSE,
  win = box3(c(0, 1), c(0, 1), c(0, 1))
)

Arguments

lambda

Intensity for the background Poisson process.

frac

Fraction of points to select as guest points. Between zero and one.

rod.norm

Either 'x', 'y', or 'z'; defines which axis the rods should be alligned with.

rod.den

Rod density; 2D vector containing a linear density for both directions.

rod.spacing

One of: "grid", "rcp", "hexagonal", or "random". The method used to space the rods.

rcp.path

If rod.spacing is set to 'rcp', then set the file path to the folder contining the rcp FinalConfig and system files

point.den

Point density within the volume of the rods.

toplot

TRUE or FALSE; Plot results or not.

win

The simulation window.

Value

A list of: [1] a pp3 object contining the guest points. [2] A pp3 object containing the entire background underlying point pattern.

See Also

Other simulation functions: clustersim(), lattice(), makecluster(), morph_lamellar(), nmers(), read.rcp(), scaleRCP(), stitch.size()

Other morphology generators: morph_lamellar()


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