Skip to content

Commit 3ee12c5

Browse files
committed
Update equation links to sfs.rtfd.io/
Did it by running the following command: grep -rli "http\:\/\/sfstoolbox\.org" * | xargs -i@ sed -i \ "s/http\:\/\/sfstoolbox\.org/https\:\/\/sfs.rtfd.io\/en\/3\.2/" @ and manually editing NEWS afterwards
1 parent bbeb6a5 commit 3ee12c5

21 files changed

+52
-52
lines changed

NEWS

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
- fix greens_function_mono() for plane wave and 3D
7676
- replace conf.ir.useoriglength by conf.ir.hrirpredelay
7777
- update default WFS driving functions
78-
- add links to equations in online theory at http://sfstoolbox.org
78+
- add links to equations in online theory at https://sfs.rtfd.io/
7979

8080
2.1.0 (10. March 2016)
8181
- make conf struct mandatory

SFS_general/secondary_source_selection.m

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
% a = <
9999
% \ 0, else
100100
%
101-
% See http://sfstoolbox.org/#equation-wfs.pw.selection
101+
% See https://sfs.rtfd.io/en/3.2/#equation-wfs.pw.selection
102102
%
103103
% Direction of plane wave (nk) is set above
104104
idx = nx0*nk(:) >= eps;
@@ -111,7 +111,7 @@
111111
% a = <
112112
% \ 0, else
113113
%
114-
% See http://sfstoolbox.org/#equation-wfs.ps.selection
114+
% See https://sfs.rtfd.io/en/3.2/#equation-wfs.ps.selection
115115
%
116116
idx = sum(nx0.*x0,2) - nx0*xs(1:3).' >= -2*eps;
117117

@@ -126,7 +126,7 @@
126126
% where v = x0-xs - <x0-xs,nxs > nxs,
127127
% and |nxs| = 1.
128128
%
129-
% See http://sfstoolbox.org/#equation-wfs.ls.selection
129+
% See https://sfs.rtfd.io/en/3.2/#equation-wfs.ls.selection
130130
%
131131
%NOTE: We don't check if we are in a 2D or 3D scenario and use xs(4:6)
132132
% whenever it is present. This can only provide problems if you use the
@@ -152,7 +152,7 @@
152152
% a = <
153153
% \ 0, else
154154
%
155-
% See http://sfstoolbox.org/#equation-wfs.fs.selection
155+
% See https://sfs.rtfd.io/en/3.2/#equation-wfs.fs.selection
156156
%
157157
nxs = xs(4:6); % vector for orientation of focused source
158158
xs = xs(1:3); % vector for position of focused source

SFS_monochromatic/driving_functions_mono/driving_function_mono_nfchoa_ls.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
% 2pi r0 m=-N (2)
9898
% Hm(w/c r0)
9999
%
100-
% See http://sfstoolbox.org/#equation-D.nfchoa.ls.2D
100+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.ls.2D
101101
%
102102
for m=-N:N
103103
D = D + 1 ./ (2.*pi.*r0) ...
@@ -126,7 +126,7 @@
126126
% 2r0 m=-N (2)
127127
% w/c h|m|(w/c r0)
128128
%
129-
% See http://sfstoolbox.org/#equation-D.nfchoa.ls.2.5D
129+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.ls.2.5D
130130
%
131131
for m=-N:N
132132
D = D + 1 ./ (2.*r0) ...
@@ -166,7 +166,7 @@
166166
% m
167167
% x Yn(beta0,alpha0)
168168
%
169-
% See http://sfstoolbox.org/#equation-D.nfchoa.ls.3D
169+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.ls.3D
170170
%
171171
for n=-N:N
172172
for m=-n:n

SFS_monochromatic/driving_functions_mono/driving_function_mono_nfchoa_ps.m

+2-2
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
% 2pi r0 m=-N (2)
114114
% h|m|(w/c r0)
115115
%
116-
% See http://sfstoolbox.org/#equation-D.nfchoa.ps.2.5D
116+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.ps.2.5D
117117
for m=-N:N
118118
D = D + 1 ./ (2.*pi.*r0) ...
119119
.* win(abs(m)+1) ...
@@ -144,7 +144,7 @@
144144
% m
145145
% x Yn(theta0,phi0)
146146
%
147-
% See http://sfstoolbox.org/#equation-D.nfchoa.ps.3D
147+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.ps.3D
148148
%
149149
for n=0:N
150150
for m=-n:n

SFS_monochromatic/driving_functions_mono/driving_function_mono_nfchoa_pw.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
% pi r0 m=-N (2)
9494
% Hm(w/c r0)
9595
%
96-
% See http://sfstoolbox.org/#equation-D.nfchoa.pw.2D
96+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.pw.2D
9797
%
9898
for m=-N:N
9999
D = D - 2.*1i ./ (pi.*r0) ...
@@ -122,7 +122,7 @@
122122
% r0 m=-N (2)
123123
% i w/c h|m|(w/c r0)
124124
%
125-
% See http://sfstoolbox.org/#equation-D.nfchoa.pw.2.5D
125+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.pw.2.5D
126126
%
127127
for m=-N:N
128128
D = D - 2./r0 ...
@@ -154,7 +154,7 @@
154154
% m
155155
% x Yn(theta0,phi0)
156156
%
157-
% See http://sfstoolbox.org/#equation-D.nfchoa.pw.3D
157+
% See https://sfs.rtfd.io/en/3.2/#equation-D.nfchoa.pw.3D
158158
%
159159
for n=0:N
160160
for m=-n:n

SFS_monochromatic/driving_functions_mono/driving_function_mono_sdm_kx_ps.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@
108108
% \ ----------_-_-_-_-_-_---------, |kx|>|w/c|
109109
% K1( \|kx^2-(w/c)^2 yref )
110110
%
111-
% See http://sfstoolbox.org/#equation-D.sdm.ps.2.5D
111+
% See https://sfs.rtfd.io/en/3.2/#equation-D.sdm.ps.2.5D
112112
%
113113
D(idxpr) = exp(1i*kx(idxpr)*xs(1)) .* ...
114114
besselh(1,2,sqrt( (omega/c)^2 - kx(idxpr).^2 )*abs(xref(2)-xs(2))) ./ ...

SFS_monochromatic/driving_functions_mono/driving_function_mono_sdm_kx_pw.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
% H0 | - nky*xrefy |
101101
% \c /
102102
%
103-
% See http://sfstoolbox.org/#equation-D.sdm.pw.2.5D
103+
% See https://sfs.rtfd.io/en/3.2/#equation-D.sdm.pw.2.5D
104104
%
105105
idx = find(kx>=omega/c*nk(:,1),1,'first');
106106
D(idx) = 4*1i*exp(-1i*omega/c*nk(2).*xref(2)) / ...

SFS_monochromatic/driving_functions_mono/driving_function_mono_sdm_pw.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
% H0 | - nky*xrefy |
104104
% \c /
105105
%
106-
% See http://sfstoolbox.org/#equation-D.sdm.pw.2.5D
106+
% See https://sfs.rtfd.io/en/3.2/#equation-D.sdm.pw.2.5D
107107
%
108108
D = 4*1i.*exp(-1i*omega/c.*nk(:,2).*xref(:,2)) ./ ...
109109
besselh(0,2,omega/c.*nk(:,2).*xref(:,2)) .* ...

SFS_monochromatic/driving_functions_mono/driving_function_mono_wfs_fs.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
% D(x0,w) = --- --- ----------- e^(i w/c |x0-xs|)
108108
% 2pi c |x0-xs|^2
109109
%
110-
% See http://sfstoolbox.org/#equation-D.wfs.fs
110+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.fs
111111
%
112112
% r = |x0-xs|
113113
r = vector_norm(x0-xs,2);
@@ -141,7 +141,7 @@
141141
% D(x0,w) = - -- --------- H1 | - |x0-xs| |
142142
% 2c |x0-xs| \ c /
143143
%
144-
% See http://sfstoolbox.org/#equation-D.wfs.fs.ls
144+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.fs.ls
145145
%
146146
% r = |x0-xs|
147147
r = vector_norm(x0-xs,2);
@@ -199,7 +199,7 @@
199199
% D_2.5D(x0,w) = g0 _ |--- _ |--- ------------- e^(i w/c |x0-xs|)
200200
% \|2pi \| c |x0-xs|^(3/2)
201201
%
202-
% See http://sfstoolbox.org/en/update_wfs_ps/#equation-D.wfs.fs.2.5D
202+
% See https://sfs.rtfd.io/en/3.2/en/update_wfs_ps/#equation-D.wfs.fs.2.5D
203203
%
204204
% Driving signal
205205
D = 1./sqrt(2.*pi) .* sqrt(-1i.*omega./c) .* g0 ...

SFS_monochromatic/driving_functions_mono/driving_function_mono_wfs_ls.m

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
% D(x0,w) = - -- ----------- H1 | - |x0-xs| |
8686
% 2c |x0-xs| \ c /
8787
%
88-
% See http://sfstoolbox.org/#equation-D.wfs.ls
88+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ls
8989
%
9090
% r = |x0-xs|
9191
r = vector_norm(x0-xs,2);
@@ -122,7 +122,7 @@
122122
% D_2.5D(x0,w) = - -- _ |--- ----------- H1 | - |x0-xs| |
123123
% 2 \| c |x0-xs| \ c /
124124
%
125-
% See http://sfstoolbox.org/#equation-D.wfs.ls.2.5D
125+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ls.2.5D
126126
%
127127
% r = |x0-xs|
128128
r = vector_norm(x0-xs,2);
@@ -152,8 +152,8 @@
152152
% where v = x0-xs - <x0-xs,nxs > nxs,
153153
% and |nxs| = 1.
154154
%
155-
% See http://sfstoolbox.org/#equation-d.wfs.ls
156-
% and http://sfstoolbox.org/#equation-v.ls
155+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.ls
156+
% and https://sfs.rtfd.io/en/3.2/#equation-v.ls
157157
%
158158
% v = (I - nxs'nxs)(x0-xs)
159159
% r = |v|

SFS_monochromatic/driving_functions_mono/driving_function_mono_wfs_ps.m

+4-4
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
% D(x0,w) = --- --- ----------- e^(-i w/c |x0-xs|)
9595
% 2pi c |x0-xs|^2
9696
%
97-
% See http://sfstoolbox.org/#equation-D.wfs.ps
97+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ps
9898
%
9999
% r = |x0-xs|
100100
r = vector_norm(x0-xs,2);
@@ -110,7 +110,7 @@
110110
% D(x0,w) = --- | --- - ------- | ----------- e^(-i w/c |x0-xs|)
111111
% 2pi \ c |x0-xs| / |x0-xs|^2
112112
%
113-
% See http://sfstoolbox.org/#equation-D.wfs.ps.woapprox
113+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ps.woapprox
114114
%
115115
% r = |x0-xs|
116116
r = vector_norm(x0-xs,2);
@@ -186,7 +186,7 @@
186186
% g0 _ |--- _ |--- ------------- e^(-i w/c |x0-xs|)
187187
% \|2pi \| c |x0-xs|^(3/2)
188188
%
189-
% See http://sfstoolbox.org/#equation-D.wfs.ps.2.5D
189+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ps.2.5D
190190
%
191191
% Driving signal
192192
D = 1./sqrt(2*pi) .* sqrt(1i.*omega./c) .* g0 ...
@@ -214,7 +214,7 @@
214214
% g0 _ |--- _ |--- ------------- e^(-i w/c |x0-xs|)
215215
% \|2pi \| c |x0-xs|^(3/2)
216216
%
217-
% See http://sfstoolbox.org/#equation-D.wfs.ps.2.5D.refline
217+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.ps.2.5D.refline
218218
%
219219
% r = |x0-xs|
220220
r = vector_norm(x0-xs,2);

SFS_monochromatic/driving_functions_mono/driving_function_mono_wfs_pw.m

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
% D(x0,w) = 2 --- nk nx0 e^(-i w/c nk x0)
8787
% c
8888
%
89-
% See http://sfstoolbox.org/#equation-D.wfs.pw
89+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.pw
9090
%
9191
D = 2.*1i.*omega./c .* vector_product(nk,nx0,2) ...
9292
.* exp(-1i.*omega./c.*vector_product(nk,x0,2));
@@ -119,7 +119,7 @@
119119
% D_2.5D(x0,w) = 2g0 nk nx0 _ |--- e^(-i w/c nk x0)
120120
% \| c
121121
%
122-
% See http://sfstoolbox.org/#equation-D.wfs.pw.2.5D
122+
% See https://sfs.rtfd.io/en/3.2/#equation-D.wfs.pw.2.5D
123123
%
124124
D = 2.*g0 .* vector_product(nk,nx0,2) .* sqrt(1i.*omega./c) ...
125125
.* exp(-1i.*omega./c.*vector_product(nk,x0,2));

SFS_monochromatic/greens_function_mono.m

+4-4
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
% G(x-xs,w) = --- -----------------
7575
% 4pi |x-xs|
7676
%
77-
% See http://sfstoolbox.org/#equation-S.ps
77+
% See https://sfs.rtfd.io/en/3.2/#equation-S.ps
7878
%
7979
G = 1/(4*pi) * exp(-1i*omega/c .* sqrt((x-xs(1)).^2+(y-xs(2)).^2+(z-xs(3)).^2)) ./ ...
8080
sqrt((x-xs(1)).^2+(y-xs(2)).^2+(z-xs(3)).^2);
@@ -86,7 +86,7 @@
8686
% ---- G(x-xs,w) = --- | ----- + ------- | ----------- e^(-i w/c |x-xs|)
8787
% d ns 4pi \ c |x-xs| / |x-xs|^2
8888
%
89-
% See http://sfstoolbox.org/#equation-S.dps
89+
% See https://sfs.rtfd.io/en/3.2/#equation-S.dps
9090
%
9191
% r = |x-xs|
9292
r = sqrt((x-xs(1)).^2+(y-xs(2)).^2+(z-xs(3)).^2);
@@ -102,7 +102,7 @@
102102
% G(x-xs,w) = - - H0 | - |x-xs| |
103103
% 4 \ c /
104104
%
105-
% See http://sfstoolbox.org/#equation-S.ls
105+
% See https://sfs.rtfd.io/en/3.2/#equation-S.ls
106106
%
107107
G = -1i/4 * besselh(0,2,omega/c* ...
108108
sqrt( (x-xs(1)).^2 + (y-xs(2)).^2 + (z-xs(3)).^2 ));
@@ -112,7 +112,7 @@
112112
%
113113
% G(x,w) = e^(-i w/c n x)
114114
%
115-
% See: http://sfstoolbox.org/#equation-S.pw
115+
% See: https://sfs.rtfd.io/en/3.2/#equation-S.pw
116116
%
117117
% Direction of plane wave
118118
nxs = xs(:,1:3) / norm(xs(:,1:3));

SFS_monochromatic/sound_field_mono.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@
130130
% P(x,omega) = | D(x0,omega) G(x-x0,omega) dx0
131131
% /
132132
%
133-
% See http://sfstoolbox.org/#equation-single-layer
133+
% See https://sfs.rtfd.io/en/3.2/#equation-single-layer
134134
%
135135
% x0(ii,7) is a weight for the single secondary sources which includes for
136136
% example a tapering window for WFS or a weighting of the sources for

SFS_time_domain/driving_functions_imp/driving_function_imp_wfs_fs.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
% d(x0,t) = h(t) * --- ----------- delta(t+|x0-xs|/c)
9696
% 2pi |x0-xs|^2
9797
%
98-
% See http://sfstoolbox.org/#equation-d.wfs.fs
98+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.fs
9999
%
100100
% r = |x0-xs|
101101
r = vector_norm(x0-xs,2);
@@ -110,7 +110,7 @@
110110
% d(x0,t) = h(t) * _ |--- ------------- delta(t+|x0-xs|/c)
111111
% \|2pi |x0-xs|^(3/2)
112112
%
113-
% See http://sfstoolbox.org/#equation-d.wfs.fs.ls
113+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.fs.ls
114114
%
115115
% r = |x0-xs|
116116
r = vector_norm(x0-xs,2);
@@ -167,7 +167,7 @@
167167
% d_2.5D(x0,t) = h_pre(-t) * g0 _ |--- ------------- delta(t+|x0-xs|/c)
168168
% \|2pi |x0-xs|^(3/2)
169169
%
170-
% See http://sfstoolbox.org/#equation-d.wfs.fs.2.5D
170+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.fs.2.5D
171171
%
172172
% Delay and amplitude weight
173173
delay = -1./c .* r;

SFS_time_domain/driving_functions_imp/driving_function_imp_wfs_ls.m

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
% See also: sound_field_imp, sound_field_imp_wfs, driving_function_mono_wfs_ls
2222
%
2323
% References:
24-
% http://sfstoolbox.org
24+
% https://sfs.rtfd.io/en/3.2
2525

2626
%*****************************************************************************
2727
% The MIT License (MIT) *
@@ -88,7 +88,7 @@
8888
% d(x0,t) = h(t) * _ |--- ------------- delta(t-|x0-xs|/c)
8989
% \|2pi |x0-xs|^(3/2)
9090
%
91-
% See http://sfstoolbox.org/#equation-d.wfs.ls
91+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.ls
9292
%
9393
% r = |x0-xs|
9494
r = vector_norm(x0-xs,2);
@@ -134,8 +134,8 @@
134134
% where v = x0-xs - <x0-xs,nxs > nxs,
135135
% and |nxs| = 1.
136136
%
137-
% See http://sfstoolbox.org/#equation-d.wfs.ls
138-
% and http://sfstoolbox.org/#equation-v.ls
137+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.ls
138+
% and https://sfs.rtfd.io/en/3.2/#equation-v.ls
139139
%
140140
% v = (I - nxs'nxs)(x0-xs)
141141
% r = |v|

SFS_time_domain/driving_functions_imp/driving_function_imp_wfs_ps.m

+2-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
% d(x0,t) = h(t) * --- ----------- delta(t-|x0-xs|/c)
8686
% 2pi |x0-xs|^2
8787
%
88-
% See http://sfstoolbox.org/#equation-d.wfs.ps
88+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.ps
8989
%
9090
% r = |x0-xs|
9191
r = vector_norm(x0-xs,2);
@@ -142,7 +142,7 @@
142142
% d_2.5D(x0,t) = h_pre(t) * g0 _ |--- ------------- delta(t-|x0-xs|/c)
143143
% \|2pi |x0-xs|^(3/2)
144144
%
145-
% See http://sfstoolbox.org/#equation-d.wfs.ps.2.5D
145+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.ps.2.5D
146146
%
147147
% Delay and amplitude weight
148148
delay = 1./c .* r;

SFS_time_domain/driving_functions_imp/driving_function_imp_wfs_pw.m

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
%
8181
% d_2D(x0,t) = h(t) * 2 nk nx0 delta(t - 1/c nk x0)
8282
%
83-
% See http://sfstoolbox.org/#equation-d.wfs.pw
83+
% See https://sfs.rtfd.io/en/3.2/#equation-d.wfs.pw
8484
%
8585
% Delay and amplitude weight
8686
delay = 1./c .* vector_product(nk,x0,2);
@@ -111,7 +111,7 @@
111111
%
112112
% d_2.5D(x0,t) = h(t) * 2 g0 nk nx0 delta(t - 1/c nk x0)
113113
%
114-
% See http://sfstoolbox.org/en/update_wfs_ps/#equation-d.wfs.pw.2.5D
114+
% See https://sfs.rtfd.io/en/3.2/en/update_wfs_ps/#equation-d.wfs.pw.2.5D
115115
%
116116
% Delay and amplitude weight
117117
delay = 1./c .* vector_product(nk,x0,2);

0 commit comments

Comments
 (0)