View source: R/create_scatterer.R
fls_generate | R Documentation |
Manually generate a FLS object.
fls_generate(
shape = "arbitrary",
x_body = NULL,
y_body = NULL,
z_body = NULL,
length_body = NULL,
radius_body = NULL,
radius_curvature_ratio = NULL,
n_segments = 18,
g_body,
h_body,
theta_body = pi/2,
ID = NULL,
length_units = "m",
theta_units = "radians",
...
)
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. |
length_body |
Optional input for a generic length value input. |
radius_body |
Vector containing radii (m). |
radius_curvature_ratio |
Length-to-curvature ratio (pc/L). |
n_segments |
Number of body segments. |
g_body |
Density contrast. |
h_body |
Soundspeed contrast |
theta_body |
Orientation of the target relative to the transmit source
( |
ID |
Optional metadata entry. |
length_units |
Units used for position vector. Defaults to "m". |
theta_units |
Units used for orientation. Defaults to "radians". |
... |
Additional parameters. |
Calls in an FLS-class object from a *.csv file
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.