diff --git a/docs/other_software.md b/docs/other_software.md index 470f61b..ac6ad7b 100644 --- a/docs/other_software.md +++ b/docs/other_software.md @@ -7,7 +7,7 @@ Other software that provides source code for acoustic scattering models of relev - [scatmod](https://github.com/SvenGastauer/scatmod): Open source acoustic scattering models for fisheries acoustics. Python and R code for fluid spheres. - [FishAcoustics](https://github.com/gavinmacaulay/FishAcoustics): Contains a Python module that implements the phase-tracking DWBA model. - [KRM Model](https://www.fisheries.noaa.gov/data-tools/krm-model): A web page that uses the KRM model to estimate the TS of predefined or user-supplied shapes over a range of input parameters. -- [KRMr](https://github.com/SvenGastauer/KRMr): KRM model for fish in R. +- [KRMr](https://github.com/SvenGastauer/KRMr): KRM model for fish in R. - [Liquid spheroid](https://github.com/elavia/liquid_spheroid): Julia and C++ code to calculate the scattering by fluid prolate and oblate spheroids. - [SDWBA Model](https://www.fisheries.noaa.gov/data-tools/sdwba-model): A web page that uses the SDWBA model to estimate the TS of predefined shapes over a range of input parameters. - [SDWBA_TS](https://github.com/ccamlr/SDWBA_TS): Matlab code that implements the SDWBA model for Antarctic krill. diff --git a/src/echosms/ptdwbamodel.py b/src/echosms/ptdwbamodel.py index aa0994e..ad1524a 100644 --- a/src/echosms/ptdwbamodel.py +++ b/src/echosms/ptdwbamodel.py @@ -1,4 +1,4 @@ -"""The phase-tracking distorted wave Born approximation model.""" +"""The phase-tracking distorted-wave Born approximation model.""" import numpy as np from scipy import ndimage @@ -6,11 +6,11 @@ class PTDWBAModel(ScatterModelBase): - """Phase-tracking distorted wave Born approximation scattering model.""" + """Phase-tracking distorted-wave Born approximation scattering model.""" def __init__(self): super().__init__() - self.long_name = 'phase-tracking distorted wave Born approximation' + self.long_name = 'phase-tracking distorted-wave Born approximation' self.short_name = 'pt-dwba' self.analytical_type = 'approximate' self.boundary_types = 'weakly scattering' @@ -18,9 +18,9 @@ def __init__(self): self.max_ka = 20 def calculate_ts_single(self, volume, theta, phi, f, voxel_size, target_rho, target_c): - """Phase-tracking distorted wave Born approximation scattering model. + """Phase-tracking distorted-wave Born approximation scattering model. - Implements the phase-tracking distorted wave Born approximation + Implements the phase-tracking distorted-wave Born approximation model for calculating the acoustic backscatter from weakly scattering bodies. Warning @@ -73,7 +73,7 @@ def calculate_ts_single(self, volume, theta, phi, f, voxel_size, target_rho, tar References ---------- Jones, B. A. (2006). Acoustic scattering of broadband echolocation signals - from prey of Blainville’s beaked whales: Modeling and analysis. Master of Science, + from prey of Blainville's beaked whales: Modeling and analysis. Master of Science, Massachusetts Institute of Technology. Jones, B. A., Lavery, A. C., & Stanton, T. K. (2009). Use of the distorted