dLoad_HRsettings.m

function parametersHR = dLoad_HRsettings

%%% BANDPASS FILTER AND FFT PARAMS %%
parametersHR.bpRanges = [10000,90000]; % Bandpass filter params in Hz [min,max]
parametersHR.filterOrder = 5; % butterworth filter order used for band pass
parametersHR.frameLengthUs = 2000; % For fft computation
parametersHR.overlap = .5; % FFT overlap (in decimal, not percent form)
parametersHR.chan = 1; % which channel do you want to look at?
parametersHR.clipThreshold = .98;%  Normalized clipping threshold btwn 0 and 1.  If empty, 
% assumes no clipping.

parametersHR.saveNoise = 0; % Make 1 if you want to save noise samples with each click.
parametersHR.saveForTPWS = 1; % Save just enough data to build TPWS files. Should help
% limit metadata size.

%%% RECIEVED LEVEL THRESHOLD %%%
parametersHR.dBpp = 118;% minimum  RL threshold - dB peak to peak.

% Only used if transfer function is not provided (Keep consistent with low-res)
parametersHR.countThresh = sqrt(10000); 
% Keep count threshold less than equivalent pp threshold. 
%   dBs = 10*log10(abs(fft(counts *2^14))) - 10*log10(fs/(length(fftWindow)))...
%            + transfer function
% note: array uses 2^15

%%% CLICK ENVELOPE PARAMS %%%
parametersHR.energyThr = 0.25; % n-percent energy threshold for envelope duration
parametersHR.dEvLims = [-.2,.9];  % [min,max] Envelope energy distribution comparing 
% first half to second half of high energy envelope of click. If there is
% more energy in the first half of the click (dolphin) dEv >0, If it's more
% in the second half (boats?) dEv<0. If it's about the same (beaked whale)
% dEnv ~= 0 , but still allow a range...
parametersHR.delphClickDurLims = [30,300];% [min,max] duration in microsec 
% allowed for high energy envelope of click


%%% OTHER DETECTION THRESHOLD PARAMS %%%
% parametersHR.bw3dbMin = 2; % In kHz. discard click if less than this wide. 
% Helps with false detections from things like echosounders and rain.
parametersHR.cutPeakBelowKHz = 16; % discard click if peak frequency below X kHz
parametersHR.cutPeakAboveKHz = 75; % discard click if peak frequency above Y kHz 
parametersHR.minClick_us = 16;% Minimum duration of a click in us 
parametersHR.maxClick_us = 1000; % Max duration of a click including echos
parametersHR.maxNeighbor = 10; % max time in seconds allowed between neighboring 
% clicks. Clicks that are far from neighbors can be rejected using this parameter,
% good for dolphins in noisy environments because lone clicks or pairs of
% clicks are likely false positives

parametersHR.mergeThr = 100;% min gap between energy peaks in us. Anything less
% will be merged into one detection the beginning of the next is fewer
% samples than this, the signals will be merged.

parametersHR.energyPrctile = 70; % sets the threshold at which click start 
% and end are defined. In a time window of interest, the detector finds the
% maximum energy peak, and then walks forward and back in time, until it
% gets to an energy level set by this threshold, ie. 70th percentile of
%  energy in the time window. 

%%% GUIDED DETECTOR OPTIONS %%%%%%%
parametersHR.guidedDetector = 0; % set to 1 for guided detections.


%%% WAV FILE NAMING OPTION %%%%%%%%
% if you're using wav files that have a time stamp in the name, put a
% regular expression for extracting that here:
parametersHR.DateRE = '_(\d*)_(\d*)';
% mine look like "filename_20110901_234905.wav" 
% ie "*_yyyymmdd_HHMMSS.wav"


%%% POST PROCESSING FLAGS %%%%%%%%
% 1 for true, 0 for false
parametersHR.rmLonerClicks = 1;
parametersHR.rmEchos = 0;
if parametersHR.rmEchos
    parametersHR.lockOut = 0.05; %min gap between clicks
end
%%% Output file extensions. Probably don't need to be changed %%%
parametersHR.clickAnnotExt = 'cTg';
parametersHR.ppExt = 'pTg';
parametersHR.groupAnnotExt = 'gTg';