csfLettersStaticRun.m

% csfLettersRun.m
% Measure threshold for 4 spatial frequencies at four eccentricities, with and
% without noise. 
% May 9, 2018
% Denis Pelli

% gabor target at 1 of 4 orientations
% P=0.75, assuming 4 alternatives
% binocular, right field?

%% GET READY
clear o oo
o.questPlusEnable=false;
if ~exist('struct2table','file')
    error('This MATLAB %s is too old. We need MATLAB 2013b or better to use the function "struct2table".',version('-release'));
end
if o.questPlusEnable && ~exist('qpInitialize','file')
    error('This script requires the QuestPlus package. Please get it from https://github.com/BrainardLab/mQUESTPlus.')
end
addpath(fullfile(fileparts(mfilename('fullpath')),'lib')); % Folder in same directory as this M file.
cal=OurScreenCalibrations(0);
% o.useFractionOfScreenToDebug=0.4; % 0: normal, 0.5: small for debugging.
o.observer='ideal';
% o.observer='junk';
o.trialsDesired=1000;
o.printLogOfIdeal=true;
Screen('Preference', 'Verbosity',0);

%% SPECIFY BASIC CONDITION
o.experiment='csfLettersStatic'; % Mistakenly set to EvsN. Oops!!
o.eyes='both'; % 'left', 'right', 'both'.
o.viewingDistanceCm=50;
o.targetGaborCycles=3;
o.pThreshold=0.75;
o.isNoiseDynamic=false;
o.moviePreAndPostSecs=[0.2 0.2];
o.fixationMarkDeg=3;
o.fixationBlankingRadiusReEccentricity=0;
o.fixationBlankingRadiusReTargetHeight=0;
o.targetMarkDeg=1;
o.noiseType='gaussian'; % 'gaussian' or 'uniform' or 'binary' or 'ternary'
if 1
    % Target letter
    o.targetKind='letter';
    o.targetFont='Sloan';
    o.alphabet='DHKNOSVZ';
    o.contrast=-1;
else
    % Target gabor
    o.targetKind='gabor';
    o.targetGaborOrientationsDeg=[0 45 90 135];
    o.targetGaborNames='1234';
    o.alphabet=o.targetGaborNames;
    % o.targetGaborSpaceConstantCycles=0.75; % The 1/e space constant of the gaussian envelope in cycles of the sinewave.
    % o.targetGaborCycles=3; % cycles of the sinewave in targetHeight
    o.contrast=1;
end
o.alternatives=length(o.alphabet);
if false
    % Use QuestPlus to measure steepness.
    o.questPlusEnable=true;
    o.questPlusSteepnesses=1:0.1:5;
    o.questPlusGuessingRates=1/o.alternatives;
    o.questPlusLapseRates=0:0.01:0.05;
    o.questPlusLogIntensities=-2.5:0.05:0.5;
    o.questPlusPrint=true;
    o.questPlusPlot=true;
end

%% SPECIFY CONDITIONS IN ooo STRUCT
ooo={};
o.fixationBlankingRadiusReTargetHeight=nan;
o.targetDurationSecs=0.2;
o.desiredLuminanceAtEye=[];
o.desiredLuminanceFactor=1;
o.useFilter=false;
o.fixationThicknessDeg=0.03; % Typically 0.03. Make it thicker for scotopic testing.
o.noiseType='ternary';
o.noiseType='gaussian';
o.saveStimulus=false;
o.noiseCheckFrames=2;
for ecc=[0 1 4 16 32]
    o.eccentricityXYDeg=[ecc 0];
    for sf=[0.5 2 8 16]
        if NominalAcuityDeg(ecc)>o.targetGaborCycles/sf
            continue
        end
        o.targetCyclesPerDeg=sf;
        o.alphabetPlacement='left';
        o.nearPointXYInUnitSquare=[0.80 0.5];
        o.targetHeightDeg=o.targetGaborCycles/o.targetCyclesPerDeg;
        if isfield(o,'observer') && streq(o.observer,'ideal')
            % Don't waste time generating noise far from the signal.
            o.noiseRadiusDeg=o.targetHeightDeg/2;
        else
            o.noiseRadiusDeg=4*o.targetHeightDeg;
        end
        o.noiseCheckDeg=o.targetHeightDeg/20;
        if all(o.eccentricityXYDeg==0)
            o.isTargetLocationMarked=false;
            o.fixationBlankingRadiusReTargetHeight=0.6;
            o.fixationMarkDeg=inf;
        else
            o.isTargetLocationMarked=true;
            o.fixationBlankingRadiusReTargetHeight=0;
            o.fixationMarkDeg=3;
        end
            switch o.targetKind
                case 'gabor'
                    o.conditionName=sprintf('ec-%.0f-deg-%.1f-cpd',o.eccentricityXYDeg(1),o.targetCyclesPerDeg);
                case 'letter'
                    o.conditionName=sprintf('ec-%.0f-deg-sz-%.1f-deg',o.eccentricityXYDeg(1),o.targetHeightDeg);
            end
        oo=[]; % Interleave these conditions.
        for sd=[0 MaxNoiseSD(o.noiseType)]
            o.noiseSD=sd;
            if o.noiseSD==0 && streq(o.observer,'ideal')
%                 continue
            end
            if isempty(oo)
                oo=o;
            else
                oo(end+1)=o;
            end
        end
        ooo{end+1}=oo;
    end % for sf
end % for ecc
for i=1:length(ooo)
    [ooo{i}.block]=deal(i); % Number the blocks
end
% ooo{1}(1).trialsDesired=1;
% ooo{2}(1).trialsDesired=1;
% ooo=ooo(1:2);
% o.useFractionOfScreenToDebug=0.4; % 0: normal, 0.5: small for debugging.

%% PRINT THE CONDITIONS (ONE PER ROW) AS TABLE TT.
% All these vars must be defined in every condition.
vars={'block' 'experiment' 'conditionName' ...
    'eccentricityXYDeg' 'targetCyclesPerDeg' 'noiseSD' ...
    'targetDurationSecs' 'targetHeightDeg' ...
    'targetGaborCycles'};
tt=table;
for i=1:length(ooo)
    t=struct2table(ooo{i},'AsArray',true);
    tt(i,:)=t(1,vars);
end
disp(tt) % Print list of conditions.

%% RUN THE CONDITIONS.
ooo=RunExperiment(ooo);

%% PRINT SUMMARY OF RESULTS AS TABLE TT.
% Include whatever you're intersted in. We skip rows missing any value.
vars={ 'block' 'conditionName' ...
    'eccentricityXYDeg' 'targetCyclesPerDeg' 'noiseSD' 'N' 'E' 'contrast' ...
    'targetHeightDeg' 'targetGaborCycles'  'noiseCheckFrames'...
    'noiseType' 'dataFilename'};
tt=table;
for i=1:length(ooo)
    t=struct2table(ooo{i},'AsArray',true);
    % Skip empty rows.
    if ~all(ismember({'trials' 'contrast' 'transcript'},t.Properties.VariableNames)) || isempty(t.trials) || all(t.trials==0)
        % Skip condition without data.
        continue
    end
    tt(end+1:end+height(t),:)=t(:,vars);
end
% for i=1:length(oo)
%     % Grab the variables we want into a one-row table.
%     t=struct2table(oo{i},'AsArray',true);
%     % Check that all vars are present. Skip any incomplete condition after
%     % warning which fields were missing.
%     ok=ismember(vars,t.Properties.VariableNames);
%     if ~all(ok)
%         missing=join(vars(~ok),' ');
%         warning('Skipping incomplete condition %d, because it lacks: %s',i,missing{1});
%         continue
%     end
%     % Add the complete row to our table of completed conditions.
%     tt(end+1,:)=t(1,vars);
% end
disp(tt) % Print summary.
if isempty(tt)
    return
end

%% SAVE SUMMARY OF RESULTS OF EXPERIMENT.
o=ooo{1}(1);
o.summaryFilename=[o.dataFilename '.summary'];
writetable(tt,fullfile(o.dataFolder,[o.summaryFilename '.csv']));
save(fullfile(o.dataFolder,[o.summaryFilename '.mat']),'tt','ooo');
fprintf('Experiment summary (with %d blocks) saved in data folder as "%s" with extensions ".csv" and ".mat".\n',length(ooo),o.summaryFilename);