ess_generate: Generate ESS shape

View source: R/create_scatterer.R

ess_generateR Documentation

Generate ESS shape

Description

Generate ESS shape

Usage

ess_generate(
  shape = "sphere",
  x_body = NULL,
  y_body = NULL,
  z_body = NULL,
  radius_shell,
  shell_thickness = NULL,
  g_fluid = NULL,
  h_fluid = NULL,
  g_shell,
  h_shell,
  theta_shell = pi/2,
  ID = NULL,
  theta_units = "radians",
  length_units = "m"
)

Arguments

shape

Optional input argument that dictates shape-type, if desired, for generalized shapes.

x_body

Vector containing x-axis body (m) shape data.

y_body

Vector containing y-axis body (m) shape data.

z_body

Vector containing z-axis body (m) shape data.

radius_shell

Radius of shell (m).

shell_thickness

Optional shell thickness (m).

g_fluid

Optional density contrast for fluid-like body.

h_fluid

Optional sound speed contrast for fluid-like body.

g_shell

Density contrast for the shell.

h_shell

Sound speed contrast for the shell.

theta_shell

Object orientation relative to incident sound wave.

ID

Optional metadata entry.

theta_units

Units used for orientation. Defaults to "radians".

length_units

Units used for position vector. Defaults to "m".


brandynlucca/acousticTS documentation built on July 4, 2025, 12:43 a.m.