@@ -128,7 +128,7 @@ def plane_25d(x0, n0, n=[0, 1, 0], xref=[0, 0, 0], c=None):
128
128
def point_25d (x0 , n0 , xs , xref = [0 , 0 , 0 ], c = None ):
129
129
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
130
130
131
- .. versionchanged:: 0.61
131
+ .. versionchanged:: 0.6.1
132
132
see notes, old handling of `point_25d()` is now `point_25d_legacy()`
133
133
134
134
Parameters
@@ -140,7 +140,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
140
140
xs : (3,) array_like
141
141
Virtual source position.
142
142
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.
144
144
c : float, optional
145
145
Speed of sound
146
146
@@ -159,7 +159,6 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
159
159
160
160
Notes
161
161
-----
162
-
163
162
Eq. (2.138) in :cite:`Schultz2016`:
164
163
165
164
.. math::
@@ -217,7 +216,7 @@ def point_25d(x0, n0, xs, xref=[0, 0, 0], c=None):
217
216
def point_25d_legacy (x0 , n0 , xs , xref = [0 , 0 , 0 ], c = None ):
218
217
r"""Driving function for 2.5-dimensional WFS of a virtual point source.
219
218
220
- .. versionadded:: 0.61
219
+ .. versionadded:: 0.6.1
221
220
`point_25d()` was renamed to `point_25d_legacy()` (and a new
222
221
function with the name `point_25d()` was introduced). See notes below
223
222
for further details.
0 commit comments