Skip to content

Commit c7722e4

Browse files
committed
Update comments of sofa related functions
1 parent ea6a918 commit c7722e4

File tree

5 files changed

+11
-14
lines changed

5 files changed

+11
-14
lines changed

SFS_ir/sofa_get_data_fir.m

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,11 @@
55
%
66
% Input parameters:
77
% sofa - impulse response data set (SOFA struct/file)
8-
% idx - index of the single impulse responses that should be returned
8+
% idx - index of the single impulse responses that should be returned.
99
% idx could be a single value, then only one impulse response
1010
% will be returned, or it can be a vector then all impulse
1111
% responses for the corresponding index positions will be
12-
% returned.
13-
% If no index is specified all data will be returned.
12+
% returned (default: return all impulse responses)
1413
%
1514
% Output parameters:
1615
% ir - impulse response (M,2,N), where

SFS_ir/sofa_get_data_fire.m

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@
1010
% idxM could be a single value, then only one impulse response
1111
% will be returned, or it can be a vector then all impulse
1212
% responses for the corresponding index positions will be
13-
% returned.
14-
% If no index is specified all measurements will be returned.
13+
% returned (default: all measurements).
1514
% idxE - index of the emitter for which the single impulse
16-
% responses should be returned. The rest is identical to idxM.
15+
% responses should be returned (default: all measurements).
1716
%
1817
% Output parameters:
1918
% ir - impulse response (M,2,E,N), where

SFS_ir/sofa_get_head_orientations.m

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
%
66
% Input parameters:
77
% sofa - impulse response data set (SOFA struct/file)
8-
% idx - index of secondary sources that should be returned.
9-
% If no index is specified all sources will be returned.
8+
% idx - index of measurement for which head orientation should be
9+
% returned (default: return all head orientations)
1010
%
1111
% Output parameters:
12-
% phi - head orientations in the horizontal plane
13-
% theta - head orientations in the median plane
12+
% phi - head orientations in the horizontal plane / rad
13+
% theta - head orientations in the median plane / rad
1414
%
1515
% SOFA_GET_HEAD_ORIENTATIONS(sofa,idx) returns head orientation [phi,theta] as
1616
% defined in the given SOFA file or struct, specified by idx. If no idx is

SFS_ir/sofa_get_listener_position.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
%SOFA_GET_LISTENER_POSITION returns the listener position from the given SOFA
33
%data set
44
%
5-
% Usage: X = sofa_get_listener_position(sofa,[idx])
5+
% Usage: X = sofa_get_listener_position(sofa,[coordinate_system])
66
%
77
% Input parameters:
88
% sofa - impulse response data set (SOFA struct/file)

SFS_ir/sofa_get_secondary_sources.m

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55
%
66
% Input parameters:
77
% sofa - impulse response data set (SOFA struct/file)
8-
% idx - index of secondary sources that should be returned.
9-
% If no index is specified all sources will be
10-
% returned.
8+
% idx - index of secondary sources that should be returned
9+
% (default: return all secondary sources).
1110
% coordinate_system - coordinate system the position and direction of the
1211
% secondary sources should be specified in:
1312
% 'cartesian' (default)

0 commit comments

Comments
 (0)