function data = data_ziegelwanger2013(varargin)
%DATA_ZIEGELWANGER2013 Data from Ziegelwanger and Majdak (2013)
% Usage: data = data_ziegelwanger2013(flag)
%
% DATA_ZIEGELWANGER2013(flag) returns results for different HRTF
% databases from Ziegelwanger and Majdak (2013).
%
% The flag may be one of:
%
% 'ARI' ARI database. The output has the following
% fields: data.results and data.subjects.
%
% 'CIPIC' CIPIC database. The output has the following fields:
% data.results and data.subjects.
%
% 'LISTEN' LISTEN database. The output has the following fields.
% data.results and data.subjects.
%
% 'SPHERE_ROT' HRTF sets for a rigid sphere placed in the center of
% the measurement setup and varying rotation. The
% output has the following fields: data.results,
% data.subjects, data.phi, data.theta and data.radius.
%
% 'SPHERE_DIS' HRTF sets for a rigid sphere with various positions in
% the measurement setup. The output has the following fields:
% data.results, data.subjects, data.xM, data.yM,
% data.zM and data.radius.
%
% 'NH89' HRTF set of listener NH89 of the ARI database: The
% output has the following fields: data.hM,
% data.meta and data.stimPar.
%
% 'cached' Reload previously calculated results from the cache
%
% 'redo' Recalculate the results
%
% The fields are given by:
%
% 'results' Results for all HRTF sets
%
% 'subjects' IDs for HRTF sets
%
% 'phi' Azimuth of ear position
%
% 'theta' Elevation of ear position
%
% 'radius' sphere radius
%
% 'xM' x-coordinate of sphere center
%
% 'yM' y-coordinate of sphere center
%
% 'zM' z-coordinate of sphere center
%
% 'data' SOFA object
%
% Requirements:
% -------------
%
% 1) SOFA API from http://sourceforge.net/projects/sofacoustics for Matlab (in e.g. thirdparty/SOFA)
%
% 2) Optimization Toolbox for Matlab
%
% 3) Data in auxdata/ziegelwanger2013
%
% Examples:
% ---------
%
% To get results from the ARI database, use:
%
% data=data_ziegelwanger2013('ARI');
%
% See also: ziegelwanger2013, ziegelwanger2013_onaxis,
% ziegelwanger2013_offaxis, exp_ziegelwanger2013
%
% References:
% P. Majdak and H. Ziegelwanger. Continuous-direction model of the
% broadband time-of-arrival in the head-related transfer functions. In
% ICA 2013 Montreal, volume 19, page 050016, Montreal, Canada, 2013. ASA.
%
% H. Ziegelwanger and P. Majdak. Modeling the broadband time-of-arrival
% of the head-related transfer functions for binaural audio. In
% Proceedings of the 134th Convention of the Audio Engineering Society,
% page 7, Rome, 2013.
%
%
% Url: http://amtoolbox.org/amt-1.6.0/doc/data/data_ziegelwanger2013.php
% #StatusDoc: OK
% #StatusCode: OK
% #Verification: Verified
% #Requirements: SOFA M-Signal M-Optimization
% #Author: Harald Ziegelwanger (2013): Original implementation for the AMT.
% This file is licensed unter the GNU General Public License (GPL) either
% version 3 of the license, or any later version as published by the Free Software
% Foundation. Details of the GPLv3 can be found in the AMT directory "licences" and
% at <https://www.gnu.org/licenses/gpl-3.0.html>.
% You can redistribute this file and/or modify it under the terms of the GPLv3.
% This file is distributed without any warranty; without even the implied warranty
% of merchantability or fitness for a particular purpose.
% Explain Data in description
%% ------ Check input options --------------------------------------------
% Define input flags
definput.import={'amt_cache'}; % get the flags of amt_cache
definput.flags.type = {'missingflag','ARI','CIPIC','LISTEN','SPHERE_DIS','SPHERE_ROT','NH89'};
% Parse input options
[flags,keyvals] = ltfatarghelper({},definput,varargin);
if flags.do_missingflag
flagnames=[sprintf('%s, ',definput.flags.type{2:end-2}),...
sprintf('%s or %s',definput.flags.type{end-1},definput.flags.type{end})];
error('%s: You must specify one of the following flags: %s.',upper(mfilename),flagnames);
end
%% ARI database
if flags.do_ARI
tmp=amt_load('ziegelwanger2013','info.mat');
data=tmp.info.ARI;
results=amt_cache('get','ARI',flags.cachemode);
if isempty(results)
for ii=1:length(data.subjects)
Obj=amt_load('ziegelwanger2013', ['ARI_' data.subjects{ii} '.sofa']);
idx=find(mod(Obj.SourcePosition(:,2),10)==0);
Obj.Data.IR=Obj.Data.IR(idx,:,:);
Obj.SourcePosition=Obj.SourcePosition(idx,:);
Obj.MeasurementSourceAudioChannel=Obj.MeasurementSourceAudioChannel(idx,:);
Obj.MeasurementAudioLatency=Obj.MeasurementAudioLatency(idx,:);
Obj.API.M=length(idx);
amt_disp(['Calculating TOA models from the ARI database, ' data.subjects{ii} ' (' num2str(ii) '/' num2str(length(data.subjects)) ')']);
[Obj,tmp]=ziegelwanger2013(Obj,4,1);
results(ii).meta=tmp;
results(ii).meta.performance(4)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,1,0);
results(ii).meta.performance(1)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,2,0);
results(ii).meta.performance(2)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,3,0);
results(ii).meta.performance(3)=tmp.performance;
clear hM; clear meta; clear stimPar;
end
amt_cache('set','ARI',results);
end
data.results=results;
end
%% CIPIC database
if flags.do_CIPIC
tmp=amt_load('ziegelwanger2013','info.mat');
data=tmp.info.CIPIC;
results=amt_cache('get','CIPIC',flags.cachemode);
if isempty(results)
for ii=1:length(data.subjects)
Obj=amt_load('ziegelwanger2013', ['CIPIC_' data.subjects{ii} '.sofa']);
amt_disp(['Calculating TOA models from the CIPIC database, ' data.subjects{ii} ' (' num2str(ii) '/' num2str(length(data.subjects)) ')']);
[Obj,tmp]=ziegelwanger2013(Obj,4,1);
results(ii).meta=tmp;
results(ii).meta.performance(4)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,1,0);
results(ii).meta.performance(1)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,2,0);
results(ii).meta.performance(2)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,3,0);
results(ii).meta.performance(3)=tmp.performance;
clear hM; clear meta; clear stimPar;
end
amt_cache('set','CIPIC',results);
end
data.results=results;
end
%% LISTEN database
if flags.do_LISTEN
tmp=amt_load('ziegelwanger2013','info.mat');
data=tmp.info.LISTEN;
results=amt_cache('get','LISTEN',flags.cachemode);
if isempty(results)
for ii=1:length(data.subjects)
if ~strcmp(data.subjects{ii},'34')
Obj=amt_load('ziegelwanger2013', ['LISTEN_' data.subjects{ii} '.sofa']);
Obj.Data.SamplingRate=48000;
amt_disp(['Calculating TOA models from the LISTEN database, ' data.subjects{ii} ' (' num2str(ii) '/' num2str(length(data.subjects)) ')']);
[Obj,tmp]=ziegelwanger2013(Obj,4,1);
results(ii).meta=tmp;
results(ii).meta.performance(4)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,1,0);
results(ii).meta.performance(1)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,2,0);
results(ii).meta.performance(2)=tmp.performance;
[~,tmp]=ziegelwanger2013(Obj,3,0);
results(ii).meta.performance(3)=tmp.performance;
clear hM; clear meta; clear stimPar;
end
end
amt_cache('set','LISTEN',results);
end
data.results=results;
end
%% SPHERE (Displacement) database
if flags.do_SPHERE_DIS
tmp=amt_load('ziegelwanger2013','info.mat');
data=tmp.info.Displacement;
results=amt_cache('get','SPHERE_DIS',flags.cachemode);
if isempty(results)
results.p_onaxis=zeros(4,2,length(data.subjects));
results.p_offaxis=zeros(7,2,length(data.subjects));
for ii=1:length(data.subjects)
Obj=amt_load('ziegelwanger2013', ['Sphere_Displacement_' data.subjects{ii} '.sofa']);
amt_disp(['Calculating TOA models for displaced SPHERE, ' data.subjects{ii} ' (' num2str(ii) '/' num2str(length(data.subjects)) ')']);
[~,tmp]=ziegelwanger2013(Obj,4,1);
results.p_onaxis(:,:,ii)=tmp.p_onaxis;
results.p_offaxis(:,:,ii)=tmp.p_offaxis;
end
amt_cache('set','SPHERE_DIS',results);
end
data.results=results;
end
%% SPHERE (Rotation) database
if flags.do_SPHERE_ROT
tmp=amt_load('ziegelwanger2013','info.mat');
data=tmp.info.Rotation;
results=amt_cache('get','SPHERE_ROT',flags.cachemode);
if isempty(results)
results.p=zeros(4,2,length(data.phi));
for ii=1:length(data.subjects)
Obj=amt_load('ziegelwanger2013', ['Sphere_Rotation_' data.subjects{ii} '.sofa']);
amt_disp(['Calculating TOA models for rotated SPHERE, ' data.subjects{ii} ' (' num2str(ii) '/' num2str(length(data.subjects)) ')']);
[~,tmp]=ziegelwanger2013(Obj,4,1);
results.p_onaxis(:,:,ii)=tmp.p_onaxis;
end
amt_cache('set','SPHERE_ROT',results);
end
data.results=results;
end
%% ARI database (NH89)
if flags.do_NH89
data=amt_load('ziegelwanger2013', 'ARI_NH89.sofa');
end