The acousticTS package uses a variety of defined S4-class objects
comprising different types of scatterers, such as fish with gas-filled
swimbladders (SBF) and fluid-like crustaceans
(FLS).
Slots
metadataList containing relevant metadata
model_parametersModel parameters necessary for predicting TS
Data Organization
metadata:A
listcomprising any identifying information associated with the scatterer. The default metadata entry includesIDthat uses a defaultcharactervalue of"UID"(i.e.ID = "UID"). This can otherwise be formatted in any manner for book keeping purposes.body/bladder:A
listthat includes information relevant to the scatterer's position vector, material properties, tilt/orientation, etc. For some scatterers, this may only includebody, but other targets may have an additional parameter such asbladder. Generally, each entry includes:rpos: the relevant position vector (r0) that includes axes such as
x,y,z, etc., that depend on the type of scatterer being used.radius: in some cases this includes the radius measurements for each cylinders depending on the type of scatterer object.theta: the orientation of the scatterer relative to the transmitting transducer or sound source (θanimal) that can be represented either by degrees or radians, although all functions require radians.g, h: material properties that represent the density and sound speed contrasts (g and h, respectively) relative to the ambient/surrounding fluid. Some targets may instead have standard sound speed (canimal, m s-1) and density (ρanimal, kg m3).
shape_parameters:A
listthat includes metadata pertaining to the shape of the scatterer and any other features of interest (e.g. gas-filled swimbladder). Generally, each entry includes: overall body length, the number of discrete cylinders that make up the shape (if applicable), and the units related to both θanimal (e.g. rad, °) and length (e.g. mm, m).model_parameters:A
listthat contains relevant model parameterization once an object has been initialized for modeling σbs. This is typically broken up into three categories:parameters: Alistthat includes information such as frequency (Hz), acoustic wavenumber (i.e. k), etc.medium: Adata.frameincluding information such as the material properties of the ambient medium.scatterer: Alistcontaining summarized information used to parameterize certain scattering models.
model:A
listthat collects model results from one or more models in the linear domain (i.e. σbs).
