Skip to content

Commit 043e9dd

Browse files
Frank Schultzfs446
Frank Schultz
authored andcommitted
docstring mods wfs.py in td/fd follow up #168, reference to v0.6.1
1 parent 51d8493 commit 043e9dd

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

Diff for: sfs/fd/wfs.py

+2-3
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,8 @@ def point_25d(omega, x0, n0, xs, xref=[0, 0, 0], c=None, omalias=None):
171171
Sequence of normal vectors of secondary sources.
172172
xs : (3,) array_like
173173
Position of virtual point source.
174-
xref : (3,) array_like, optional
175-
Reference point xref or contour xref(x0) for amplitude correct
176-
synthesis.
174+
xref : (N, 3) array_like or (3,) array_like
175+
Contour xref(x0) for amplitude correct synthesis, reference point xref.
177176
c : float, optional
178177
Speed of sound in m/s.
179178
omalias: float, optional

Diff for: sfs/td/wfs.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ def plane_25d(x0, n0, n=[0, 1, 0], xref=[0, 0, 0], c=None):
128128
def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
129129
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
130130
131-
.. versionchanged:: 0.61
131+
.. versionchanged:: 0.6.1
132132
see notes, old handling of `point_25d()` is now `point_25d_legacy()`
133133
134134
Parameters
@@ -140,7 +140,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
140140
xs : (3,) array_like
141141
Virtual source position.
142142
xref : (N, 3) array_like or (3,) array_like
143-
Reference curve of correct amplitude xref(x0)
143+
Contour xref(x0) for amplitude correct synthesis, reference point xref.
144144
c : float, optional
145145
Speed of sound
146146
@@ -159,7 +159,6 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
159159
160160
Notes
161161
-----
162-
163162
Eq. (2.138) in :cite:`Schultz2016`:
164163
165164
.. math::
@@ -217,7 +216,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
217216
def point_25d_legacy(x0, n0, xs, xref=[0, 0, 0], c=None):
218217
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
219218
220-
.. versionadded:: 0.61
219+
.. versionadded:: 0.6.1
221220
`point_25d()` was renamed to `point_25d_legacy()` (and a new
222221
function with the name `point_25d()` was introduced). See notes below
223222
for further details.

0 commit comments

Comments
 (0)