Package index • acousticTS

All functions

CAL-class CAL: Solid and calibration sphere (CAL) object/class.

DCM(): Calculates the theoretical TS of a target using the deformed cylinder model (DCM).

DWBA(): Calculates the theoretical TS of a fluid-like scatterer at a given frequency using the distorted Born wave approximation (DWBA) model.

DWBA_curved(): Calculates the theoretical TS of a fluid-like scatterer at a given frequency using the distorted Born wave approximation (DWBA) model.

ESS-class ESS: Elastic shelled scatterer (ESS) object/class.

FLS-class FLS: Fluid-like scatterer (FLS) object/class.

GAS-class GAS: Generic gas-filled scatterer (GAS) object/class.

KRM(): Calculates the theoretical TS using Kirchoff-ray Mode approximation.

MSS_anderson(): Calculates the theoretical TS of a fluid sphere using an exact modal series solution proposed by Andersen (1950).

MSS_goodman_stern(): Calculates the theoretical TS of an elastic-shelled sphere using the modal series solution from Goodman and Stern (1962).

Pn(): Legendre Polynomial function (Pn) of the first kind.

SBF-class SBF: Swimbladdered fish (SBF) object/class.

SDWBA(): Calculates the theoretical TS of a fluid-like scatterer at a given frequency using the stochastic distorted Born wave approximation (DWBA) model.

SDWBA_curved(): Calculates the theoretical TS of a fluid-like scatterer at a given frequency using the stochastic distorted Born wave approximation (DWBA) model using Eq. (6) froom Stanton et al. (1998).

arbitrary(): Creates arbitrary body shape from user inputs

bladder_rotation(): Support rotation function for KRM (swimbladder)

body_rotation(): Support rotating function for KRM (body)

brake(): Support function for bending scatterer body shape and position matrix

brake_df(): Support function for bending scatterer position matrix dataframe

brake_scatterer(): Support function for bending scatterer body shape scatterer object

bulk(): Calculate the bulk modulus (K).

cal_generate(): Generate a CAL-class object.

cal_plot(): Plotting for CAL-class objects

cal_show(): show(...) for CAL-class objects.

calculate_bessel_cache(): Calculate Bessel function cache for the Goodman and Stern (1962) model

calibration(): Calculates theoretical TS of a solid sphere of a certain material at a given frequency.

calibration_initialize(): Initialize CAL-class object for modeling.

cod: Sample code shape with fully inflated swimbladder.

create_shape(): A wrapper function that automatically creates generalized and/or canonical shapes for TS modeling.

cylinder(): Creates a cylinder.

dcm_initialize(): Initialize object for modeling using the DCM.

degrees(): Convert angular measurements from radians to degrees

discover_reforge_params(): Get reforge parameters from known method signatures

dwba_curved_initialize(): Initialize FLS-class object for TS modeling.

dwba_initialize(): Initialize FLS-class object for TS modeling.

ess_generate(): Generate ESS shape

ess_plot(): Plotting for ESS-class objects

ess_show(): show(...) for ESS-class objects.

extract(): Primary accessor function for dredging specific data from scatterer objects

fls_generate(): Manually generate a FLS object.

fls_plot(): Plotting for FLS-class objects

fls_show(): show(...) for FLS-class objects.

gas_generate(): Create GAS object

gas_plot(): Plotting for GAS-class objects

gas_show(): show(...) for GAS_class objects

hc() hcd(): Cylindrical Bessel (Hankel) function of the third kind and its derivative

high_pass_stanton(): Calculates the theoretical TS of a shelled organism using the non-modal High Pass (HP) model

high_pass_stanton_initialize(): Initialize object for Stanton high-pass approximation

hs() hsd(): Spherical Bessel function of the third kind and its respective derivative

jc() jcd() jcdd(): Cylindrical Bessel function of the first kind and its respective derivatives

js() jsd() jsdd(): Spherical Bessel function of the first kind and its respective derivatives

k(): Calculate the acoustic wavenumber (k) based on the sound speed of water.

kappa(): Calculate the compressibility material properties of a scatterer's tissue or shell (kappa)

krill: Sample krill (Euphausia superba) shape taken from McGehee et al. (1998)

krm_initialize(): Initialize SBF-class object for KRM calculations.

lame(): Calculate Lamé's first parameter (\(\lambda\))

linear() db(): Convert backscatter values from log- to linear-domain.

model_palette: Base plotting color palette

model_registry: Model registry: maps model names to their functions

mss_anderson_initialize(): Initialize GAS-object for modal series solution.

mss_goodman_stern_initialize(): Initialize ESS-object for modal series solution.

phase_integrate(): Wrapper function incorporating phase deviation into contour integration

plot(): Method for what is printed for objects.

pois(): Calculate the Poisson's ratio (\(\nu\))

polynomial_cylinder(): Creates a polynomial deformed cylinder

prolate_spheroid(): Creates a prolate spheroid.

radians(): Convert angular measurements from degrees to radians.

reflection_coefficient(): Plane wave/plane interface reflection coefficient

reforge(<FLS>): Reforge FLS-class object.

reforge(<SBF>): Resizing function for swimbladdered targets

reforge(): Resize or reparameterize a scatterer object

rho(): Calculate the mass density material properties of a scatterer's tissue or shell (kappa)

sardine: Sample sardine shape with fully inflated swimbladder

sbf_generate(): Manually generate a SBF-class object.

sbf_plot(): Plotting for SBF-class objects

sbf_show(): show(...) for SBF-class objects.

scatterer-class: scatterer-class

sdwba_curved_initialize(): Initialize FLS-class object for SDWBA modeling

sdwba_initialize(): Initialize FLS-class object for SDWBA modeling

sdwba_resample(): Resample shape for SDWBA model with piecewise constant radius

segmentize(): Discretize vector into separate intervals of different length

shape-class: Generic scattering shape object used throughout this package.

shear(): Calculate the shear modulus (G)

show(<scatterer>): Generic function for show(...) for different scatterers.

sigma_bs(): Calculates the linear backscattering coefficient (sigma_bs) from the linear scattering length, f_bs.

simulate_ts(): Simulate target strength (TS) with flexible parameterization and batching

sphere(): Creates a sphere.

target_strength(): Wrapper function to model acoustic target strength

transmission_coefficient(): Transmission coefficient for transmission between two mediums

vecnorm(): Calculates the Euclidean norm across each row of a given matrix.

yc() ycd(): Cylindrical Bessel (Neumann) function of the second kind and its derivative

young(): Calculate Young's modulus (E).

ys() ysd() ysdd(): Spherical Bessel function of the second kind and its respective derivative