Skip to content

Commit d7fe45d

Browse files
hagenwhagenw
committed
Simplify help messages
1 parent d15421e commit d7fe45d

File tree

224 files changed

+340
-667
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

224 files changed

+340
-667
lines changed

‎SFS_analysis/freq_response_line_source.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_line_source(X,xs,conf)
2-
%FREQ_RESPONSE_WFS simulates the frequency response for a line source at the
3-
%given listener position
2+
%FREQ_RESPONSE_LINE_SOURCE frequency response of a line source
43
%
54
% Usage: [S,f] = freq_response_line_source(X,xs,conf)
65
%

‎SFS_analysis/freq_response_localwfs_sbl.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_localwfs_sbl(X,xs,src,conf)
2-
%FREQ_RESPONSE_LOCALWFS_SBL simulates the frequency response for WFS at the given
3-
%listener position
2+
%FREQ_RESPONSE_LOCALWFS_SBL frequency response for local WFS
43
%
54
% Usage: [S,f] = freq_response_loaclwfs_sbl(X,xs,src,conf)
65
%

‎SFS_analysis/freq_response_localwfs_vss.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_localwfs_vss(X,xs,src,conf)
2-
%FREQ_RESPONSE_LOCALWFS_VSS simulates the frequency response for local WFS at
3-
%the given listener position
2+
%FREQ_RESPONSE_LOCALWFS_VSS frequency response for local WFS
43
%
54
% Usage: [S,f] = freq_response_localwfs_vss(X,xs,src,conf)
65
%

‎SFS_analysis/freq_response_nfchoa.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_nfchoa(X,xs,src,conf)
2-
%FREQ_RESPONSE_NFCHOA simulates the frequency response for NFC-HOA at the given
3-
%listener position
2+
%FREQ_RESPONSE_NFCHOA frequency response for NFC-HOA
43
%
54
% Usage: [S,f] = freq_response_nfchoa(X,xs,src,conf)
65
%

‎SFS_analysis/freq_response_point_source.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_point_source(X,xs,conf)
2-
%FREQ_RESPONSE_WFS simulates the frequency response for a point source at the
3-
%given listener position
2+
%FREQ_RESPONSE_POINT_SOURCE frequency response of a point
43
%
54
% Usage: [S,f] = freq_response_point_source(X,xs,conf)
65
%

‎SFS_analysis/freq_response_wfs.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = freq_response_wfs(X,xs,src,conf)
2-
%FREQ_RESPONSE_WFS simulates the frequency response for WFS at the given
3-
%listener position
2+
%FREQ_RESPONSE_WFS frequency response for WFS
43
%
54
% Usage: [S,f] = freq_response_wfs(X,xs,src,conf)
65
%

‎SFS_analysis/time_response_line_source.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_line_source(X,xs,conf)
2-
%TIME_RESPONSE_LINE_SOURCE simulates the time response for a line source at
3-
%the given listener position
2+
%TIME_RESPONSE_LINE_SOURCE time response of a line source
43
%
54
% Usage: [s,t] = time_response_line_source(X,xs,conf)
65
%

‎SFS_analysis/time_response_localwfs_sbl.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_localwfs_sbl(X,xs,src,conf)
2-
%TIME_RESPONSE_LOCALWFS_SBL simulates the time response for LOCAL WFS at the
3-
%given listener position
2+
%TIME_RESPONSE_LOCALWFS_SBL time response for local WFS
43
%
54
% Usage: [s,t] = time_response_localwfs_sbl(X,xs,src,conf)
65
%

‎SFS_analysis/time_response_localwfs_vss.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_localwfs_vss(X,xs,src,conf)
2-
%TIME_RESPONSE_LOCALWFS_VSS simulates the time response for LOCAL WFS at the
3-
%given listener position
2+
%TIME_RESPONSE_LOCALWFS_VSS time response for local WFS
43
%
54
% Usage: [s,t] = time_response_localwfs_vss(X,xs,src,conf)
65
%

‎SFS_analysis/time_response_nfchoa.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_nfchoa(X,xs,src,conf)
2-
%TIME_RESPONSE_NFCHOA simulates the time response for NFC-HOA at the given
3-
%listener position
2+
%TIME_RESPONSE_NFCHOA time response for NFC-HOA
43
%
54
% Usage: [s,t] = time_response_nfchoa(X,xs,src,conf)
65
%

‎SFS_analysis/time_response_point_source.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_point_source(X,xs,conf)
2-
%TIME_RESPONSE_POINT_SOURCE simulates the time response for a point source at
3-
%the given listener position
2+
%TIME_RESPONSE_POINT_SOURCE time response of a point source
43
%
54
% Usage: [s,t] = time_response_point_source(X,xs,conf)
65
%

‎SFS_analysis/time_response_wfs.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = time_response_wfs(X,xs,src,conf)
2-
%TIME_RESPONSE_WFS simulates the time response for WFS at the given
3-
%listener position
2+
%TIME_RESPONSE_WFS time response for WFS
43
%
54
% Usage: [s,t] = time_response_wfs(X,xs,src,conf)
65
%

‎SFS_analysis/wave_fronts_wfs.m

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function varargout = wave_fronts_wfs(X,phi,xs,src,gnuplot,conf)
2-
%WAVE_FRONTS_WFS returns direction, amplitude and time of the single wave
3-
% fronts for WFS
2+
%WAVE_FRONTS_WFS direction, amplitude and time of WFS wave fronts
43
%
54
% Usage: [alpha,a,t] = wave_fronts_wfs(X,phi,xs,src,[gnuplot],conf)
65
%

‎SFS_binaural_synthesis/compensate_headphone.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function ir = compensate_headphone(ir,conf)
2-
%COMPENSATE_HEADPHONE applies a headphone compensation to the IR
2+
%COMPENSATE_HEADPHONE applies a headphone compensation to an impulse response
33
%
44
% Usage: ir = compensate_headphone(ir,conf)
55
%

‎SFS_binaural_synthesis/ir_generic.m

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
function ir = ir_generic(X,head_orientation,x0,d,sofa,conf)
2-
%IR_GENERIC generates driving signals including the impulse responses from the
3-
%secondary sources to the listener position
2+
%IR_GENERIC impulse response of secondary sources including driving signals
43
%
54
% Usage: ir = ir_generic(X,head_orientation,x0,d,sofa,conf)
65
%
@@ -18,7 +17,9 @@
1817
% (nx2 matrix)
1918
%
2019
% IR_GENERIC(X,head_orientation,x0,d,sofa,conf) calculates a binaural room
21-
% impulse response for the given secondary sources and driving signals.
20+
% impulse response using the provided sofa database for the sound travelling
21+
% from the secondary sources to the listener position. In addition, the given
22+
% driving signals d are incorporated.
2223
%
2324
% See also: ir_wfs, ir_nfchoa, ir_point_source, auralize_ir
2425

‎SFS_binaural_synthesis/ir_localwfs.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [ir,x0] = ir_localwfs(X,head_orientation,xs,src,sofa,conf)
2-
%IR_LOCALWFS generates a binaural simulation of local WFS
2+
%IR_LOCALWFS binaural simulation of local WFS
33
%
44
% Usage: [ir,x0] = ir_localwfs(X,head_orientation,xs,src,sofa,conf)
55
%
@@ -19,7 +19,7 @@
1919
% x0 - secondary sources / m
2020
%
2121
% IR_LOCALWFS(X,head_orientation,xs,src,sofa,conf) calculates a binaural room
22-
% impulse response for a virtual source at xs for a virtual LOCAL WFS array
22+
% impulse response for a virtual source at xs for a virtual local WFS array
2323
% and a listener located at X.
2424
%
2525
% See also: ssr_brs_wfs, ir_point_source, auralize_ir

‎SFS_binaural_synthesis/ir_nfchoa.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [ir,x0,delay] = ir_nfchoa(X,head_orientation,xs,src,sofa,conf)
2-
%IR_NFCHOA generates a binaural simulation of NFCHOA
2+
%IR_NFCHOA binaural simulation of NFCHOA
33
%
44
% Usage: [ir,x0,delay] = ir_nfchoa(X,head_orientation,xs,src,sofa,conf)
55
%

‎SFS_binaural_synthesis/ir_point_source.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function ir = ir_point_source(X,head_orientation,xs,sofa,conf)
2-
%IR_POINT_SOURCE generates a binaural simulation of a point source
2+
%IR_POINT_SOURCE binaural simulation of a point source
33
%
44
% Usage: ir = ir_point_source(X,head_orientation,xs,sofa,conf)
55
%

‎SFS_binaural_synthesis/ir_wfs.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [ir,x0,delay] = ir_wfs(X,head_orientation,xs,src,sofa,conf)
2-
%IR_WFS generates a binaural simulation of WFS
2+
%IR_WFS binaural simulation of WFS
33
%
44
% Usage: [ir,x0,delay] = ir_wfs(X,head_orientation,xs,src,sofa,conf)
55
%

‎SFS_general/aliasing_frequency.m

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
function [fal,dx0] = aliasing_frequency(x0,conf)
2-
%ALIASING_FREQUENCY returns the aliasing frequency for the given secondary
3-
%sources
2+
%ALIASING_FREQUENCY aliasing frequency for the given secondary sources
43
%
54
% Usage: [fal,dx0] = aliasing_frequency([x0],conf)
65
%
7-
% Input options:
6+
% Input parameters:
87
% x0 - secondary sources / m
98
% conf - configuration struct (see SFS_config)
109
%
11-
% Output options:
10+
% Output parameters:
1211
% fal - aliasing frequency / Hz
1312
% dx0 - mean distance between secondary sources / m
1413
%

‎SFS_general/asslegendre.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [ Lnm ] = asslegendre(n,m,arg)
2-
%ASSLEGENDRE calculates associates Legendre function of degree n and order m
2+
%ASSLEGENDRE associates Legendre function of degree n and order m
33
%
44
% Usage: Lnm = asslegendre(n,m,arg)
55
%
@@ -11,9 +11,6 @@
1111
% Output parameters:
1212
% Lnm - associates Legendre function
1313
%
14-
% ASSLEGENDRE(n,m,arg) calculates the associates Legendre function of degree
15-
% n and order m for the values arg.
16-
%
1714
% See also: sphharmonics, legendre
1815

1916
%*****************************************************************************

‎SFS_general/bandpass.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function sig = bandpass(sig,flow,fhigh,conf)
2-
%BANDPASS filters a signal by a bandpass
2+
%BANDPASS applies a bandpass to a signal
33
%
44
% Usage: sig = bandpass(sig,flow,fhigh,conf)
55
%
@@ -12,9 +12,6 @@
1212
% Output parameters:
1313
% sig - filtered signal
1414
%
15-
% BANDPASS(sig,flow,fhigh,conf) filters the given signal with a bandpass
16-
% filter with cutoff frequencies of flow and fhigh.
17-
%
1815
% See also: sound_field_imp_wfs
1916

2017
%*****************************************************************************

‎SFS_general/bilinear_transform.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [b,a] = bilinear_transform(sos,conf)
2-
%BILINEAR_TRANSFORM returns the second-order section as filter coefficients
2+
%BILINEAR_TRANSFORM second-order section as filter coefficients
33
%
44
% Usage: [b,a] = bilinear_transform(sos,conf)
55
%

‎SFS_general/cm2in.m

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@
33
%
44
% Usage: y = cm2in(x)
55
%
6-
% Input options:
6+
% Input parameters:
77
% x - input / cm
88
%
9-
% Output options:
9+
% Output parameters:
1010
% y - output / inches
1111
%
12-
% CM2IN(x) returns the given value x in inches.
13-
%
1412
% See also: cm2px, px2in, px2cm, in2cm, in2px
1513

1614
%*****************************************************************************

‎SFS_general/cm2px.m

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,12 @@
33
%
44
% Usage: y = cm2px(x)
55
%
6-
% Input options:
6+
% Input parameters:
77
% x - input / cm
88
%
9-
% Output options:
9+
% Output parameters:
1010
% y - output / px
1111
%
12-
% CM2PX(x) returns the given value x in pixels.
13-
%
1412
% See also: cm2in, px2in, px2cm, in2cm, in2px
1513

1614
%*****************************************************************************

‎SFS_general/column_vector.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function varargout = column_vector(varargin)
2-
%COLUMN_VECTOR makes a column vector from the given vector
2+
%COLUMN_VECTOR returns the given vectors as column vectors
33
%
44
% Usage: [x1,x2,...] = column_vector(x1,x2,...)
55
%
@@ -9,9 +9,6 @@
99
% Output parameters:
1010
% x1,x2,... - input vectors as column vectors
1111
%
12-
% COLUMN_VECTOR(x1,x2,...) returns the given vectors x1,x2,... as column
13-
% vectors.
14-
%
1512
% See also: row_vector
1613

1714
%*****************************************************************************

‎SFS_general/correct_azimuth.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function phi = correct_azimuth(phi)
2-
%CORRECT_AZIMUTH ensures correct values for azimuth angles
2+
%CORRECT_AZIMUTH ensures azimuth angle between -pi and +pi-eps
33
%
44
% Usage: phi = correct_azimuth(phi)
55
%
@@ -9,9 +9,6 @@
99
% Output paramteres:
1010
% phi - angle between -pi and +pi-eps / rad
1111
%
12-
% CORRECT_AZIMUTH(phi) returns a value for azimuth phi between
13-
% -pi and +pi-eps.
14-
%
1512
% See also: correct_elevation, get_ir
1613

1714
%*****************************************************************************

‎SFS_general/correct_elevation.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function delta = correct_elevation(delta)
2-
%CORRECT_ELEVATION ensures correct values for elevation angles
2+
%CORRECT_ELEVATION ensures elevation angle between -pi/2 and pi/2
33
%
44
% Usage: delta = correct_elevation(delta)
55
%
@@ -9,9 +9,6 @@
99
% Output paramteres:
1010
% delta - angle between -pi/2 and +pi/2 / rad
1111
%
12-
% CORRECT_ELEVATION(delta) returns a value for elevation delta between
13-
% -pi/2 and pi/2.
14-
%
1512
% See also: correct_azimuth, get_ir
1613

1714
%*****************************************************************************

‎SFS_general/deg.m

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
function phi = deg(phi)
2-
%DEG returns the given angle in deg
2+
%DEG angle in deg
33
%
44
% Usage: phi = deg(phi)
55
%
6-
% Input options:
6+
% Input parameters:
77
% phi - angle / rad, can be a scalar or matrix (rad)
88
%
9-
% Output options:
9+
% Output parameters:
1010
% phi - angle / degree
1111
%
12-
% DEG(phi) returns the given angles phi in degree.
13-
%
1412
% See also: rad
1513

1614
%*****************************************************************************

‎SFS_general/delayline.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [sig,delay_offset] = delayline(sig,dt,weight,conf)
2-
%DELAYLINE implements a (fractional) delay line with weights
2+
%DELAYLINE (fractional) delay line with weights
33
%
44
% Usage: [sig,delay_offset] = delayline(sig,dt,weight,conf)
55
%

‎SFS_general/direction_vector.m

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function directions = direction_vector(x1,x2)
2-
%DIRECTION_VECTOR return unit vector(s) pointing from x1 to x2
2+
%DIRECTION_VECTOR unit vector(s) pointing from x1 to x2
33
%
44
% Usage: n = direction_vector(x1,x2)
55
%
@@ -10,9 +10,6 @@
1010
% Output parameters:
1111
% n - unit vector(s) pointing in the direction(s) from x1 to x2
1212
%
13-
% DIRECTION_VECTOR(x1,x2) calculates the unit vectors pointing from
14-
% n-dimensional points x1 to the n-dimensional points x2.
15-
%
1613
% See also: secondary_source_positions
1714

1815
%*****************************************************************************

‎SFS_general/findcols.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function k = findcols(A,b)
2-
%FINDCOLS finds indices of a given column within a matrix.
2+
%FINDCOLS finds a column within a matrix.
33
%
44
% Usage: idx = findcols(A,b)
55
%

‎SFS_general/findnearestneighbour.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function [idx,weights] = findnearestneighbour(A,b,N)
2-
%FINDNEARESTNEIGHBOUR finds the N nearest neighbours and weights (for N<=2)
2+
%FINDNEARESTNEIGHBOUR finds the N nearest neighbours
33
%
44
% Usage: [idx,weights] = findnearestneighbour(A,b,N)
55
%

‎SFS_general/findrows.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function k = findrows(A,b)
2-
%FINDROWS finds indices of a given row within a matrix.
2+
%FINDROWS finds a row vector within a matrix.
33
%
44
% Usage: idx = findrows(A,b)
55
%

‎SFS_general/fix_length.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function sig = fix_length(sig,N)
2-
%FIX_LENGTH pads zeros or removes entries from the signal according to length N
2+
%FIX_LENGTH pads zeros or removes entries from signal accroding to length N
33
%
44
% Usage: sig = fix_length(sig,N)
55
%

‎SFS_general/gaindb.m

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
% Output parameters:
1111
% inoutsig - given signal with new level
1212
%
13-
% GAINDB(insig,gn) changes the level of the signal by gn dB.
14-
%
1513
% See also: rms, db, setleveldb
1614

1715
%*****************************************************************************

‎SFS_general/get_shelve_lagrange.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
function H = get_shelve_lagrange(f,H,FlagSub,fSub,FlagAliasing,fAliasing,Bandwidth_in_Oct)
2-
%GET_SHELVE_LAGRANGE does an Lagrange interpolation towards shelving filter
2+
%GET_SHELVE_LAGRANGE Lagrange interpolation towards shelving filter
33
%
44
% Usage: H = get_shelve_lagrange(f,H,FlagSub,fSub,FlagAliasing, ...
55
% fAliasing,Bandwidth_in_Oct)

0 commit comments

Comments
 (0)