Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

[84b1c9]: ltfathelp.m Maximize Restore History

Download this file

ltfathelp.m    161 lines (132 with data), 3.9 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
function op1=ltfathelp(varargin)
%LTFATHELP Help on the LTFAT toolbox.
% Usage: ltfathelp;
% v=ltfathelp('version');
% mlist=ltfathelp('modules');
%
% LTFATHELP displays some general help on the LTFAT toolbox.
%
% LTFATHELP('version') returns the version number.
%
% LTFATHELP('modules') returns a cell array of installed modules and
% corresponding version numbers.
%
% LTFATHELP('authors') lists the name of the authors.
%
% See also: ltfatstart
% AUTHOR : Peter Soendergaard.
% TESTING: NA
% REFERENCE: NA
% Verify that ltfatarghelper is in path
if ~exist('ltfatarghelper','file')
disp(' ');
disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
disp(' ')
disp('To start the toolbox, call LTFATSTART as the first command.');
disp(' ');
return;
end;
bp=ltfatbasepath;
definput.keyvals.versiondata=[];
definput.keyvals.modulesdata=[];
definput.flags.mode={'general','version','modules','authors'};
[flags,kv]=ltfatarghelper({},definput,varargin);
if flags.do_general
disp(' ');
disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
disp(' ')
disp(['Version ',kv.versiondata]);
disp(' ');
disp('Installed modules:');
disp(' ');
disp('Name: Version: Description');
modinfo=ltfathelp('modules');
for ii=1:length(modinfo);
s=sprintf(' %-15s %7s %s',modinfo{ii}.name,modinfo{ii}.version, ...
modinfo{ii}.description);
disp(s);
end;
disp(' ')
if isoctave
disp('Type ltfathelp("modulename") where "modulename" is the name of one');
disp('of the modules to see help on that module.');
else
disp('Type "help modulename" where "modulename" is the name of one')
disp('of the modules to see help on that module.')
end;
disp(' ');
disp('For other questions, please don''t hesitate to send an email to ltfat-help@lists.sourceforge.net.');
end;
if flags.do_version
op1=kv.versiondata;
end;
if flags.do_modules
op1={};
for ii=1:numel(kv.modulesdata)
p=kv.modulesdata{ii};
% Get the first line of the help file
[FID, MSG] = fopen ([bp,p.name,filesep,'Contents.m'],'r');
if FID==-1
error('Module %s does not contain a Contents.m file.',p.name);
end;
firstline = fgetl (FID);
fclose(FID);
% Load the information into the cell array.
op1{ii}.name=p.name;
op1{ii}.version=p.version;
op1{ii}.description=firstline(2:end);
end;
end;
if flags.do_authors
disp('Peter L. Soendergaard, Centre for Applied Hearing Research,');
disp(' Technical University of Denmark.');
disp(' ');
disp('Bruno Torresani, LABORATOIRE D''ANALYSE, TOPOLOGIE ET PROBABILITES');
disp(' Universite de Provence, Marseille, France');
disp(' ');
disp('Peter Balazs, Acoustics Research Institute');
disp(' Austrian Academy of Sciences, Vienna, Austria');
disp(' ');
disp('Florent Jaillet, IRISA');
disp(' Rennes, France');
end;
if 0
bp=TF_CONF.basepath;
switch(lower(q))
case {'v','version'}
if nargin==1
op1=TF_CONF.ltfat_version;
else
for ii=1:length(TF_CONF.modules);
% strcmpi does not exist in older versions of Octave,
% therefore use strcmp(lower(...
if strcmp(lower(modulename),TF_CONF.modules{ii}.name)
found=1;
op1=TF_CONF.modules{ii}.version;
return
end;
end;
% If we get here, it means that no module matched 'modulename'.
error('Unknown module name.');
end;
otherwise
found=0;
for ii=1:length(TF_CONF.modules);
if strcmp(lower(q),TF_CONF.modules{ii}.name)
found=1;
p=TF_CONF.modules{ii};
if isoctave
s=pwd;
cd([bp,p.name]);
help Contents
cd(s);
else
help(lower(q))
end;
end;
end;
if ~found
error('Unknown command or module name.');
end;
end;
end;