write_expsummary.m

function expsummary = write_expsummary(Data)

%     This file is part of prana, an open-source GUI-driven program for
%     calculating velocity fields using PIV or PTV.
%
%     Copyright (C) 2012-2013  Virginia Polytechnic Institute and State
%     University
% 
%     Copyright 2014-2015.  Los Alamos National Security, LLC. This material was
%     produced under U.S. Government contract DE-AC52-06NA25396 for Los 
%     Alamos National Laboratory (LANL), which is operated by Los Alamos 
%     National Security, LLC for the U.S. Department of Energy. The U.S. 
%     Government has rights to use, reproduce, and distribute this software.
%     NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC MAKES ANY
%     WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF
%     THIS SOFTWARE.  If software is modified to produce derivative works,
%     such modified software should be clearly marked, so as not to confuse
%     it with the version available from LANL.
%
%     prana is free software: you can redistribute it and/or modify
%     it under the terms of the GNU General Public License as published by
%     the Free Software Foundation, either version 3 of the License, or
%     (at your option) any later version.
% 
%     This program is distributed in the hope that it will be useful,
%     but WITHOUT ANY WARRANTY; without even the implied warranty of
%     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%     GNU General Public License for more details.
% 
%     You should have received a copy of the GNU General Public License
%     along with this program.  If not, see <http://www.gnu.org/licenses/>.


% Here are all the different string options that are used durring this
% function call.
y_n={'No','Yes'};
% These are the PIV methods
methods={'Multipass - DWO','Multigrid - DWO','Multigrid - Deform (DWO)',...
    'Multigrid - Ensemble (DWO)','Multigrid - Ensemble Deform (DWO)','Multigrid - Multiframe (DWO)','Multigrid - 1st Order Forward Deform'};
% These are the different interpolation methods for the velocity field
velinterp={'Nearest Neighbor','Bilinear','Cubic'};
% These are the interpolation methods for the image deformations % added
% matlab interp2
iminterp={  'Sinc Function (8 point)'; 'Sinc w/ Blackman filter'; 'Bicubic' ; 'B-splines (7th order)'};
% These are the different peak fitting schemes
peak={'Three-Point Gaussian','Four-Point Gaussian','Gaussian Least Squares'};
% This is the number of peaks the user is outputing
peaks={'1','1,2','1,2,3'};
% This is for validation method
uod_type={'Mean','Median'};
% This is for the tracking for multiple purposes
s_d = {'Static','Dynamic','Combined'};
% These are the different sizing methods for the particle sizing
sizing_meth = {'Intensity_Weighted Centroid','Three Point Gaussian','Four Point Gaussian',...
    'Continuous Four Point Gaussian','Least Sqaures Gaussian','Continuous Least Squares Gaussian'};
% This is the prediction method used for the tracking
PIV_PTV = {'None','PTV','PIV','PIV-PTV'};

% Start Building the experimental summary string.
expsummary = [];

expsummary = [expsummary sprintf(['Summary for PIV Job: ',Data.batchname,'\n'])];
expsummary = [expsummary sprintf(['PIV Code Version: ',Data.version,'\n'])];
expsummary = [expsummary sprintf(['PTV Code Version: ',Data.ptv_version,'\n'])];
expsummary = [expsummary sprintf('\n--------------------Experiment Parameters--------------------\n')];
expsummary = [expsummary sprintf(['Date of Experiment:            ',Data.exp_date,'\n'])];
expsummary = [expsummary sprintf(['Laser Wavelength (um):         ',Data.exp_wavelength,'\n'])];
expsummary = [expsummary sprintf(['Laser Pulse Separation (us):   ',Data.wrsep,'\n'])];
expsummary = [expsummary sprintf(['Camera Frame Rate (Hz):        ',Data.wrsamp,'\n'])];
expsummary = [expsummary sprintf(['Pixel Size (um):               ',Data.exp_pixelsize,'\n'])];
expsummary = [expsummary sprintf(['Image Resolution (um/pix):     ',Data.wrmag,'\n'])];
expsummary = [expsummary sprintf(['Lens Focal Length (mm):        ',Data.exp_lensfocal,'\n'])];
if ~str2double(Data.exp_micro)
    expsummary = [expsummary sprintf(['Lens f#:                       ',Data.exp_lensfnum,'\n'])];
else
    expsummary = [expsummary sprintf(['Numerical Aperture:            ',Data.exp_NA,'\n'])];
    expsummary = [expsummary sprintf(['Index of Refraction:           ',Data.exp_n,'\n'])];
end
expsummary = [expsummary sprintf(['Particle Diameter (um):        ',Data.exp_partD,'\n'])];
expsummary = [expsummary sprintf(['Particle Density (kg/m^3):     ',Data.exp_partdensity,'\n'])];
expsummary = [expsummary sprintf(['Fluid Density (kg/m^3):        ',Data.exp_density,'\n'])];
expsummary = [expsummary sprintf(['Dynamic Viscosity (Pa*s):      ',Data.exp_viscosity,'\n'])];
expsummary = [expsummary sprintf(['Surface Tension (N/m):         ',Data.exp_surfacetension,'\n'])];
expsummary = [expsummary sprintf(['Characteristic Length (m):     ',Data.exp_L,'\n'])];
expsummary = [expsummary sprintf(['Characteristic Velocity (m/s): ',Data.exp_v0,'\n'])];
expsummary = [expsummary sprintf(['Reynolds Number:               ',Data.exp_Re,'\n'])];
expsummary = [expsummary sprintf(['Particle Stokes Number:        ',Data.exp_St,'\n'])];
expsummary = [expsummary sprintf(['Magnification Factor:          ',Data.exp_M,'\n'])];
expsummary = [expsummary sprintf(['Region of Interest (m):        ',Data.exp_ROI,'\n'])];
expsummary = [expsummary sprintf(['Diffraction Diameter (um):     ',Data.exp_diffractiondiameter,'\n'])];
expsummary = [expsummary sprintf(['Depth of Focus (um):           ',Data.exp_depthoffocus,'\n'])];

for i=1:size(Data.exp_notes,1)
    expsummary = [expsummary sprintf('Experimental Notes:\n')];
    expsummary = [expsummary sprintf([Data.exp_notes{i},'\n'])];
end

channel = {'Red (Grey Scale)','Green','Blue','Weighted Average','Mean','Color Ensemble'};
expsummary = [expsummary sprintf('\n----------------------Images and Masking---------------------\n')];
expsummary = [expsummary sprintf(['Image Directory:               ',Data.imdirec,'\n'])];
expsummary = [expsummary sprintf(['Image Basename:                ',Data.imbase,'\n'])];
expsummary = [expsummary sprintf(['Image Zeros:                   ',Data.imzeros,'\n'])];
expsummary = [expsummary sprintf(['Image Extension:               ',Data.imext,'\n'])];
expsummary = [expsummary sprintf(['Image Frame Start:             ',Data.imfstart,'\n'])];
expsummary = [expsummary sprintf(['Image Frame Step:              ',Data.imfstep,'\n'])];
expsummary = [expsummary sprintf(['Image Frame End:               ',Data.imfend,'\n'])];
expsummary = [expsummary sprintf(['Image Correlation Step:        ',Data.imcstep,'\n'])];
expsummary = [expsummary sprintf(['Image Color Channel:           ',channel{str2double(Data.channel)},'\n'])];
expsummary = [expsummary sprintf(['Output Directory:              ',Data.outdirec,'\n'])];
expsummary = [expsummary sprintf('Masking Type:                  ')];
if strcmp(Data.masktype,'static')
    if ispc
        slshind=strfind(Data.staticmaskname,'\');
    else
        slshind=strfind(Data.staticmaskname,'/');
    end
    expsummary = [expsummary sprintf('Static\n')];
    expsummary = [expsummary sprintf(['Mask Directory:                ',Data.staticmaskname(  1:slshind(end))  ,'\n'])];
    expsummary = [expsummary sprintf(['Mask File:                     ',Data.staticmaskname(slshind(end)+1:end),'\n'])];
elseif strcmp(Data.masktype,'dynamic')
    expsummary = [expsummary sprintf('Dynamic\n')];
    expsummary = [expsummary sprintf(['Mask Directory:               ',Data.maskdirec,'\n'])];
    expsummary = [expsummary sprintf(['Mask Basename:                ',Data.maskbase,'\n'])];
    expsummary = [expsummary sprintf(['Mask Zeros:                   ',Data.maskzeros,'\n'])];
    expsummary = [expsummary sprintf(['Mask Extension:               ',Data.maskext,'\n'])];
    expsummary = [expsummary sprintf(['Mask Frame Start:             ',Data.maskfstart,'\n'])];
    expsummary = [expsummary sprintf(['Mask Frame Step:              ',Data.maskfstep,'\n'])];
else
    expsummary = [expsummary sprintf('None\n')];
end

expsummary = [expsummary sprintf('\n---------------------Parallel Processing----------------------\n')];
expsummary = [expsummary sprintf(['Parallel Processing:           ',y_n{str2double(Data.par)+1},'\n'])];
if str2double(Data.par) == 1
    expsummary = [expsummary sprintf(['Number of Processors:          ',Data.parprocessors,'\n'])];
end

% This section is for displaying all of the settings pretaining to PIV.
if str2double(Data.runPIV)
    
    expsummary = [expsummary sprintf('\n-----------------------PIV Processing------------------------\n')];
    expsummary = [expsummary sprintf(['Algorithm:                     ',methods{str2double(Data.method)},'\n'])];
    if str2double(Data.method)~=1 && str2double(Data.method)~=6
        expsummary = [expsummary sprintf(['Velocity Interp Function:      ',velinterp{str2double(Data.velinterp)},'\n'])];
    end
    if any(str2double(Data.method)==[3 5])
        expsummary = [expsummary sprintf(['Image Interpolation Function:  ',iminterp{str2double(Data.iminterp)},'\n'])];
    end
    if str2double(Data.method)>=6
        expsummary = [expsummary sprintf(['PIV Error:                     ',Data.PIVerror,'\n'])];
        expsummary = [expsummary sprintf(['Maximum Framestep:             ',Data.framestep,'\n'])];
    end
        
    for i=1:str2double(Data.passes)
%         corr={'SCC','RPC','GCC','FWC','SPC'};
        A=eval(['Data.PIV' num2str(i)]);
        expsummary = [expsummary sprintf(['\n------------------------Pass ',num2str(i),' Setup-------------------------\n'])];
        if isfield(A,'winres1')
            expsummary = [expsummary sprintf(['Window Resolution (first image) (pix):        ',A.winres1,'\n'])];
            expsummary = [expsummary sprintf(['Window Resolution (second image) (pix):       ',A.winres2,'\n'])];
        else
            expsummary = [expsummary sprintf(['Window Resolution (first image) (pix):        ',A.winres,'\n'])];
            expsummary = [expsummary sprintf(['Window Resolution (second image) (pix):       ',A.winres,'\n'])];
        end
        expsummary = [expsummary sprintf(['Window Size (pix):                            ',A.winsize,'\n'])];
        expsummary = [expsummary sprintf(['Grid Resolution (pix):                        ',A.gridres,'\n'])];
        expsummary = [expsummary sprintf(['Window Overlap Percentage:                    ',A.winoverlap,'\n'])];
        expsummary = [expsummary sprintf(['Grid Buffer (pix):                            ',A.gridbuf,'\n'])];
        if i==1
            expsummary = [expsummary sprintf(['Bulk Window Offset (pix):                     ',A.BWO,'\n'])];
        else
            expsummary = [expsummary sprintf(['Bulk Window Offset (pix):                     ','0,0','\n'])];
        end
        expsummary = [expsummary sprintf(['Correlation:                                  ',A.corr,'\n'])];
        if strcmpi(A.corr,'RPC')
            expsummary = [expsummary sprintf(['   RPC Diameter:                              ',A.RPCd,'\n'])];
        elseif strcmpi(A.corr,'DRPC')
            expsummary = [expsummary sprintf(['   RPC Diameter:                              ','Dynamic','\n'])];
        elseif strcmpi(A.corr,'FWC')
            expsummary = [expsummary sprintf(['   FWC Weight:                                ',A.frac_filt,'\n'])];
        end
        expsummary = [expsummary sprintf(['Zero-Mean Image Windows:                      ',y_n{str2double(A.zeromean)+1},'\n'])];
        expsummary = [expsummary sprintf(['Subpixel Peak Location Method:                ',peak{str2double(A.peaklocator)},'\n'])];
        expsummary = [expsummary sprintf(['Smoothing:                                    ',y_n{str2double(A.velsmooth)+1},'\n'])];
        if str2double(A.velsmooth)
            expsummary = [expsummary sprintf(['   Smoothing Weight (STD):                    ',A.velsmoothfilt,'\n'])];
        end
        if any(str2double(Data.method)==[3 5])
            expsummary = [expsummary sprintf(['Deformation Infromation:\n'])];
            expsummary = [expsummary sprintf(['   Minimum Number of Iterations:              ',A.deform_min,'\n'])];
            expsummary = [expsummary sprintf(['   Maximum Number of Iterations:              ',A.deform_max,'\n'])];
            expsummary = [expsummary sprintf(['   Convergence Error:                         ',A.deform_conv,'\n'])];
        end
        expsummary = [expsummary sprintf('Validation Type(s):                           ')];
        if str2double(A.val)
            if str2double(A.thresh)
                expsummary = [expsummary sprintf('Velocity Thresholding ')];
            end
            if str2double(A.corrpeaktest)
                expsummary = [expsummary sprintf('Correlation Thresholding ')];
            end
            if str2double(A.uod)
                expsummary = [expsummary sprintf('UOD ')];
            end
            if str2double(A.bootstrap)
                expsummary = [expsummary sprintf('Bootstrapping')];
            end
            expsummary = [expsummary sprintf('\n')];
            if str2double(A.thresh)
                expsummary = [expsummary sprintf(['Umin, Umax (pix):                             ',A.valuthresh,'\n'])];
                expsummary = [expsummary sprintf(['Vmin, Vmax (pix):                             ',A.valvthresh,'\n'])];
            end
            if str2double(A.corrpeaktest)
                expsummary = [expsummary sprintf(['Peak Height Threshold:                        ',A.corrpeak_absthresh,'\n'])];
                expsummary = [expsummary sprintf(['Peak Ratio Threshold:                         ',A.corrpeak_ratiothresh,'\n'])];
            end
            if str2double(A.uod)
                expsummary = [expsummary sprintf(['UOD Type:                                     ',uod_type{str2double(A.uod_type)},'\n'])];
                expsummary = [expsummary sprintf(['UOD Window Sizes:                             ',A.uod_window,'\n'])];
                expsummary = [expsummary sprintf(['UOD Thresholds:                               ',A.uod_thresh,'\n'])];
            end
            if str2double(A.bootstrap)
                expsummary = [expsummary sprintf(['Bootstrap Percent Sampled:                    ',A.bootstrap_percentsampled,'\n'])];
                expsummary = [expsummary sprintf(['Bootstrap Iterations:                         ',A.bootstrap_iterations,'\n'])];
                expsummary = [expsummary sprintf(['Bootstrap Passes:                             ',A.bootstrap_passes,'\n'])];
            end
            expsummary = [expsummary sprintf(['Try Additional Peaks:                         ',y_n{str2double(A.valextrapeaks)+1},'\n'])];
        else
            expsummary = [expsummary sprintf('None\n')];
        end
        expsummary = [expsummary sprintf(['Write Output:                                 ',y_n{str2double(A.write)+1},'\n'])];
        if str2double(A.write)
            expsummary = [expsummary sprintf(['Output Basename:                              ',A.outbase,'\n'])];
            expsummary = [expsummary sprintf(['Save Add. Peak Info:                          ',y_n{str2double(A.savepeakinfo)+1},'\n'])];
            if str2double(A.savepeakinfo)
                expsummary = [expsummary sprintf(['Save Data for Peaks:                          ',peaks{str2double(A.corrpeaknum)},'\n'])];
                expsummary = [expsummary sprintf(['Save Peak Magnitude:                          ',y_n{str2double(A.savepeakmag)+1},'\n'])];
                expsummary = [expsummary sprintf(['Save Resulting Vel.:                          ',y_n{str2double(A.savepeakvel)+1},'\n'])];
            end
            expsummary = [expsummary sprintf(['Save Correlation Planes:                      ',y_n{str2double(A.saveplane)+1},'\n'])];
        end
    end
end

if any([str2double(Data.ID.runid) str2double(Data.Size.runsize) str2double(Data.Track.runtrack)])
    expsummary = [expsummary sprintf('\n--------------------ID, Size, & Tracking---------------------')];
    if str2double(Data.ID.runid)
        expsummary = [expsummary sprintf('\n-----------------------------ID------------------------------\n')];
        expsummary = [expsummary sprintf(['Identification Method:                        ',s_d{str2double(Data.ID.method)},'\n'])];
        expsummary = [expsummary sprintf(['Image Threshold:                              ',Data.ID.imthresh,'\n'])];
        expsummary = [expsummary sprintf(['ID Output Basename:                           ',Data.ID.savebase,'\n'])];
        expsummary = [expsummary sprintf(['ID Ouput Location:                            ',Data.ID.save_dir,'\n'])];
    end
    if str2double(Data.Size.runsize)
        expsummary = [expsummary sprintf('\n---------------------------Sizing----------------------------\n')];
        expsummary = [expsummary sprintf(['Sizing Method:                                ',Data.Size.method,'\n'])];
        expsummary = [expsummary sprintf(['Standard Deviation:                           ',Data.Size.std,'\n'])];
        expsummary = [expsummary sprintf(['Sizing Output Basename:                       ',Data.Size.savebase,'\n'])];
        expsummary = [expsummary sprintf(['Sizing Output Location:                       ',Data.Size.save_dir,'\n'])];
    end
    if str2double(Data.Track.runtrack)
        expsummary = [expsummary sprintf('\n--------------------------Tracking---------------------------\n')];
        expsummary = [expsummary sprintf(['Tracking Method:                              ',PIV_PTV{str2double(Data.Track.method)},'\n'])];
        expsummary = [expsummary sprintf(['Prediction Method:                            ',s_d{str2double(Data.Track.prediction)},'\n'])];
        if str2double(Data.Track.method) == 3
            expsummary = [expsummary sprintf(['PIV-PTV Weight:                               ',Data.Track.PIVweight,'\n'])];
        end
        expsummary = [expsummary sprintf(['Search Radius (pix):                          ',Data.Track.radius,'\n'])];
        expsummary = [expsummary sprintf(['Inter-Particle Distance Weight:               ',Data.Track.disweight,'\n'])];
        expsummary = [expsummary sprintf(['Sizing Weight:                                ',Data.Track.sizeweight,'\n'])];
        expsummary = [expsummary sprintf(['Maximum Intensity Weight:                     ',Data.Track.intensityweight,'\n'])];
        expsummary = [expsummary sprintf(['Estimation Radius:                            ',Data.Track.estradius,'\n'])];
        expsummary = [expsummary sprintf(['Estimation Weight:                            ',Data.Track.estweight,'\n'])];
        expsummary = [expsummary sprintf(['Estimation Min Number of Vectors:             ',Data.Track.vectors,'\n'])];
        expsummary = [expsummary sprintf(['Estimation Max Iteractions:                   ',Data.Track.iterations,'\n'])];
        if str2double(Data.Track.valprops.run)
            expsummary = [expsummary sprintf('\n-------------------------Validation--------------------------\n')];
            expsummary = [expsummary sprintf(['Coefficent Threshold:                         ',Data.Track.valprops.valcoef,'\n'])];
            expsummary = [expsummary sprintf(['Validation Radious (vectors):                 ',Data.Track.valprops.valrad,'\n'])];
            expsummary = [expsummary sprintf(['Validation Threshold U:                       ',Data.Track.valprops.MAD_U,'\n'])];
            expsummary = [expsummary sprintf(['Validation Threshold V:                       ',Data.Track.valprops.MAD_V,'\n'])];
        end
        expsummary = [expsummary sprintf(['Tracking Output Basename:                     ',Data.Track.savebase,'\n'])];
        expsummary = [expsummary sprintf(['Tracking Output Location:                     ',Data.Track.save_dir,'\n'])];
        if str2double(Data.Track.trackdat) == 1
            expsummary = [expsummary sprintf(['  Tracking Output Type:                       ','*.dat','\n'])];
        end
        if str2double(Data.Track.trackmat) == 1
            expsummary = [expsummary sprintf(['  Tracking Output Type:                       ','*.mat','\n'])];
        end
    end
end

% This string contains the date and time this function was called and
% appends it to the end of the expsummary.  This way when the jobs
% internals are changed but not the batch name a different text file will
% be created and not over written.
if nargout == 0 %Only write file if there is no output requested from the function.
    dateinfo = datestr(now);
    dateinfo(12) = '-';
    dateinfo([15 18]) = '.';
    if str2double(Data.runPIV)
        fname=fullfile(Data.outdirec, ['ExpSummary_',Data.batchname,'_',dateinfo,'.txt']);
    elseif str2double(Data.ID.runid)
        fname=fullfile(Data.ID.save_dir, ['ExpSummary_',Data.batchname,'_',dateinfo,'.txt']);
    elseif str2double(Data.Size.runsize)
        fname=fullfile(Data.Size.save_dir, ['ExpSummary_',Data.batchname,'_',dateinfo,'.txt']);
    elseif str2double(Data.Track.runtrack)
        fname=fullfile(Data.Track.save_dir, ['ExpSummary_',Data.batchname,'_',dateinfo,'.txt']);
    end
    fid=fopen(fname,'w');
    if fid==-1
        try
            % For PIV
            if str2double(Data.runPIV)
                mkdir(Data.outdirec)
                fid=fopen(fname,'w');
                if fid==-1
                    error(['error writing experiment summary ',fname])
                end
            % For ID
            elseif str2double(Data.ID.runid)
                mkdir(Data.ID.save_dir)
                fid=fopen(fname,'w');
                if fid==-1
                    error(['error writing experiment summary ',fname])
                end
            % For Sizing
            elseif str2double(Data.Size.runsize)
                mkdir(Data.Size.save_dir)
                fid=fopen(fname,'w');
                if fid==-1
                    error(['error writing experiment summary ',fname])
                end
            % For Tracking
            elseif str2double(Data.Track.runtrack)
                mkdir(Data.Track.save_dir)
                fid=fopen(fname,'w');
                if fid==-1
                    error(['error writing experiment summary ',fname])
                end
            end
        catch ME
            error('Error writing experiment summary %s\n\n%s\n',fname,ME(1).message)
        end
    end
    fprintf(fid,expsummary);
    
    fclose(fid);
end