comparison sinest.h @ 5:5f3c32dc6e17

* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile

 #ifndef SinEstH
 #define SinEstH
 
-/*
-  SinEst.cpp - sinusoid estimation algorithms
+/**
+  \file sinest.h - sinusoid estimation algorithms
 */
 
 
 #include <string.h>
 #include "xcomplex.h"

 void DerivativePiecewiseII(double* p, double* q, int L, double* f, int T, cdouble* s, int M, void (*SpecifyA)(int L, int T, int M, int &N, double*** &A, MList* mlist, int mode), int ssAmode, void (*SpecifyB)(int L, int T, int M, int &N, double*** &B, MList* mlist, int mode), int ssBmode, int WinOrder=2, int I=2, int endmode=0, cdouble* ds=0);
 void DerivativePiecewiseIII(double* p, double* q, int L, double* f, int T, cdouble* s, int M,	void (*SpecifyA)(int L, int T, int M, int &N, double*** &A, MList* mlist, int mode), int ssAmode,	void (*SpecifyB)(int L, int T, int M, int &N, double*** &B, MList* mlist, int mode), int ssBmode,	int WinOrder=2, int I=2, int endmode=0, cdouble* ds=0);
 double AmpPhCorrectionExpA(cdouble* s2, int N, cdouble* aita, int L, int T, cdouble* sre, int M, double** h, double** dih, double*** A,	void (*SpecifyA)(int L, int T, int M, int &N, double*** &A, MList* mlist, int mode), int WinOrder);
 
 //--local derivative algorithms - general------------------------------------
-/*
+/**
   template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version,
   i.e. using tuned test functions.
 
   In: s[Wid]: waveform data
       v[I][Wid], dv[I][Wid]: test functions and their derivatives

   delete[] ind;
   DeAlloc2(A);
   return result;
 }//DerivativeLSv
 
-/*
+/**
   template DerivativeLS: local derivative algorithm for estimating time-varying sinusoids, "u" version,
   i.e. using base-band test functions.
 
   In: s[Wid]: waveform data
       u[I][Wid], du[I][Wid]: base-band test functions and their derivatives

   cdouble result=DerivativeLSv(Wid, s, I, v, dv, M, h, lmd, p0s, p0, q0s, q0);
   DeAlloc2(v); DeAlloc2(dv);
   return result;
 }//DerivativeLS
 
-/*
+/**
   template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u"
   version
 
   In: sv0: inner product of signal s[Wid] and test function v0
       u0[Wid], omg: base-band test function and carrier frequency used for computing v0[]

     e0+=exp(expo)**(cdouble(u0[n]).rotate(omg*(n-hWid)));
   }
   return log(sv0/e0);
 }//DerivativeLS_AmpPh
 
-/*
+/**
   template DerivativeLS_AmpPh: amplitude and phase estimation in the local derivative algorithm, "u"
   version.
 
   In: s[Wid]: waveform data
       u0[Wid], omg: base-band test function and carrier frequency used for computing v0[]

   return log(ss0/e0);
 }//DerivativeLS_AmpPh
 
 cdouble DerivativeLSv_AmpPh(int, int, double**, cdouble*, cdouble*, cdouble); //the "v" version is implemented as a normal function in SinEst.cpp.
 
-/*
+/**
   template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "v" version.
 
   In: s[Wid]: waveform data
       v[I][Wid], dv[I][Wid]: test functions and their derivatives
       h[M+1][Wid], integr_h[M+1][Wid]: basis functions and their integrals

 {
   cdouble sv0=DerivativeLSv(Wid, s, I, v, dv, M, h, lmd, p0s, p0, q0s, q0);
   lmd[0]=DerivativeLSv_AmpPh(Wid, M, integr_h, lmd, v[0], sv0);
 }//DerivativeLSv_AmpPh
 
-/*template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version.
+/**
+  template DerivativeLSv: local derivative algorithm for estimating time-varying sinusoids, "u" version.
 
   In: s[Wid]: waveform data
       u[I][Wid], du[I][Wid]: base-band test functions and their derivatives
       omg: angular frequency onto which u[I] and du[I] are modulated to give the test functions
       h[M+1][Wid], integr_h[M+1][Wid]: basis functions and their integrals

 {
   cdouble sv0=DerivativeLS(Wid, s, I, omg, u, du, M, h, lmd, p0s, p0, q0s, q0);
   lmd[0]=DerivativeLS_AmpPh(Wid, M, integr_h, lmd, omg, u[0], s); //sv0);
 }//DerivativeLSv
 
-/*
+/**
   template CosineWindows: generates the Hann^(K/2) window and its L-1 derivatives as Result[L][Wid+1]
 
   In: K, L, Wid
   Out: w[L][Wid+1]: Hann^(K/2) window function and its derivatives up to order L-1