Przeglądaj źródła

some corrections to documentation of functions, add missing licenses

Fernando Pablo Lopez-Lezcano 10 lat temu
rodzic
commit
0036753f8c

+ 3 - 2
capsule_plot.m

@@ -4,10 +4,11 @@
 %% capsule_plot: plot the polar response of a capsule
 %% capsule_plot: plot the polar response of a capsule
 %%
 %%
 %% usage:
 %% usage:
-%%   capsule_plot(R, fmin, fmax)
+%%   capsule_plot(R, fmin, fmax, col)
 %%
 %%
 %% R: capsule response in frequency range
 %% R: capsule response in frequency range
-%% fmin, fmax: range of frequencies to consider (to title plot)
+%% fmin, fmax: frequency range (plot title)
+%% col: plot line color
 %%
 %%
 %% Copyright Fernando Lopez-Lezcano 2016
 %% Copyright Fernando Lopez-Lezcano 2016
 %% nando@ccrma.stanford.edu
 %% nando@ccrma.stanford.edu

+ 2 - 2
capsule_polar_response.m

@@ -1,10 +1,10 @@
 %%
 %%
 %% *SpHEAR Project
 %% *SpHEAR Project
 %%
 %%
-%% capsule_polar_response: plot polar response of capsule for different frequency bands
+%% capsule_polar_response: plot polar response of capsule in a frequency band
 %%
 %%
 %% usage:
 %% usage:
-%%   [] = capsule_polar_respones()
+%%   [] = capsule_polar_respones(measurements, fmin, fmax, N, Npre)
 %%
 %%
 %% The names of reference microphone impulse response and capsule measurements are
 %% The names of reference microphone impulse response and capsule measurements are
 %% currently hardwired into this file, this needs to be fixed and turned into
 %% currently hardwired into this file, this needs to be fixed and turned into

+ 1 - 1
capsule_polar_response_all.m

@@ -13,7 +13,7 @@
 %%       covered by equally spaced frequency bands
 %%       covered by equally spaced frequency bands
 %% Fs: sampling rate
 %% Fs: sampling rate
 %% Nsamp: time domain samples to use
 %% Nsamp: time domain samples to use
-%% Npre: samples to use before the main impulse peak
+%% Npre: samples to use before the main peak of impulse response
 %%
 %%
 %% Copyright 2016, Fernando Lopez-Lezcano, All Rights Reserved
 %% Copyright 2016, Fernando Lopez-Lezcano, All Rights Reserved
 %% nando@ccrma.stanford.edu
 %% nando@ccrma.stanford.edu

+ 16 - 3
make_figures_aes.m

@@ -1,8 +1,21 @@
 %%
 %%
-%% Make all figures for the AES paper
+%% Make all figures for the AES SFC 2016 Conference paper
 %%
 %%
-%% Copyright Fernando Lopez-Lezcano 2016
+%% Copyright 2016, Fernando Lopez-Lezcano, All Rights Reserved
 %% nando@ccrma.stanford.edu
 %% nando@ccrma.stanford.edu
+%%
+%%  This program 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/>.
 
 
 function [FIR] = make_figures_aes(col)
 function [FIR] = make_figures_aes(col)
 
 
@@ -11,7 +24,7 @@ function [FIR] = make_figures_aes(col)
   clear all;
   clear all;
   sphear_common;
   sphear_common;
 
 
-  global AESDIR = "../papers/AES_SFCconf2016/AES_SFCconf2016_template_abstractOnly/";
+  global AESDIR = "../figures/";
 
 
   %% color figures
   %% color figures
   cext = "_color";
   cext = "_color";

+ 20 - 6
sphear_bf_power_fons.m

@@ -1,21 +1,35 @@
 %%
 %%
 %% *SpHEAR Project
 %% *SpHEAR Project
 %%
 %%
-%% sphear_a_power: return array of power for all capsules in a range of frequencies
+%% sphear_bf_power_fons: return array of power for all capsules in a range of frequencies
 %%
 %%
 %% usage:
 %% usage:
-%%   [R] = sphear_a_power(fmin, fmax, N, Npre)
+%%   [R] = sphear_a_power_fons(fmin, fmax, N, Fs, plotz)
 %%
 %%
 %% fmin, fmax: range of frequencies to consider
 %% fmin, fmax: range of frequencies to consider
-%% Npre: number of samples before the main impulse
-%% N: total number of samples to analyze
+%% N: fft size
+%% Fs: sampling rate
+%% plotz: 0 -> calculate cardioid, 1 -> calculate Z
 %%
 %%
 %% The names of reference microphone impulse response and capsule measurements are
 %% The names of reference microphone impulse response and capsule measurements are
 %% currently hardwired into this file, this needs to be fixed and turned into
 %% currently hardwired into this file, this needs to be fixed and turned into
 %% input parameters
 %% input parameters
 %%
 %%
-%% Copyright Fernando Lopez-Lezcano 2016
-%% 
+%% Copyright 2016, Fernando Lopez-Lezcano, All Rights Reserved
+%% nando@ccrma.stanford.edu
+%%
+%%  This program 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/>.
 
 
 function [B] = sphear_bf_power_fons(fmin, fmax, N, Fs, plotz)
 function [B] = sphear_bf_power_fons(fmin, fmax, N, Fs, plotz)
   pkg load signal;
   pkg load signal;