tfr.h

Go to the documentation of this file.

 
#ifndef _LIBTFR_H
#define _LIBTFR_H
 
/* keep in step with [project] version in pyproject.toml, which is the
   single source of truth; the python module reads it from package
   metadata, but a C header has no way to do that */
#define LIBTFR_VERSION "2.2.0"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef double cmplx_t[2];
 
typedef struct mfft_s mfft;
 
/* initialization and destruction functions */
 
mfft * mtm_init(int nfft, int npoints, int ntapers);
 
mfft * mtm_init_dpss(int nfft, int npoints, double nw, int ntapers);
 
mfft * mtm_init_herm(int nfft, int npoints, int order, double tm);
 
void mtm_copy(mfft * mtmh, const double * tapers, const double * weights);
 
void mtm_destroy(mfft * mtm);
 
/* utility functions */
 
int mtm_nfft(mfft const * mtm);
int mtm_npoints(mfft const * mtm);
int mtm_ntapers(mfft const * mtm);
int mtm_nreal(mfft const * mtm);
int mtm_nframes(mfft const * mtm, int signal_size, int step_size);
double const * mtm_buffer(mfft const * mtm);
double const * mtm_tapers(mfft const * mtm);
 
 
/* transformation functions */
 
void mtm_tapers_fft(mfft * mtm, double scale);
 
void mtm_tapers_interp(mfft const * mtm, double * out, double const * times,
                       int ntimes, double t0, double dt);
 
double mtfft(mfft * mtm, double const * data, int nbins);
 
/* spectrogram functions */
 
void mtpower(mfft const * mtm, double * pow, double sigpow);
 
 
void mtcomplex(mfft const * mtm, cmplx_t * out);
 
void mtm_spec(mfft * mtm, double * spec, const double *samples, int nsamples, int shift,
              int adapt);
 
void mtm_zspec(mfft * mtm, cmplx_t *spec, const double *samples, int nsamples,
               int shift);
 
void tfr_spec(mfft * mtm, double *spec, const double *samples, int nsamples, int k,
              int shift, double flock, int tlock, int nfreq, const double *fgrid);
 
/* taper generating functions */
 
int dpss(double *tapers, double *lambda, int npoints, double nw, int k);
 
int hermf(int N, int M, double tm, double *h, double *Dh, double *Th);
 
/* reassignment functions */
 
void tfr_displacements(mfft const * mtm, double *q, double *tdispl, double *fdispl);
 
void tfr_reassign(double *spec, const double *q, const double *tdispl, const double *fdispl,
                  int N, int nfreq, const double *fgrid,
                  double dt, double qthresh, double flock, int tminlock, int tmaxlock);
 
#ifdef __cplusplus
}
#endif
 
#endif