ltfathelp.m

Matlab时频分析工具箱,希望能对大家有所帮助啊

function op1=ltfathelp(q,modulename)
%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

% 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/>.

global TF_CONF;

% Verify that TF_CONF has been initialized
if numel(TF_CONF)==0
  disp(' ');
  disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
  disp(' ')
  disp('To start the toolbox, call LTFATSTART as the first command.');
  disp(' ');
  return;
end;

if nargin==0
  disp(' ');
  disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
  disp(' ')

  disp(['Version ',TF_CONF.ltfat_version]);
  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 [e-mail].'); 
    
  return
end;
  
if ischar(q);

  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;
    case {'m','modules'}
      op1={};
      for ii=1:length(TF_CONF.modules);

	p=TF_CONF.modules{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;
    case {'a','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');
			   
    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;