# harminv **Repository Path**: mirrors_NanoComp/harminv ## Basic Information - **Project Name**: harminv - **Description**: harmonic inversion algorithm of Mandelshtam: decompose signal into sum of decaying sinusoids - **Primary Language**: Unknown - **License**: GPL-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2023-11-10 - **Last Updated**: 2026-10-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README  # Harminv [](https://travis-ci.org/NanoComp/harminv) Harmonic Inversion of Time Signals by the Filter Diagonalization Method (FDM), implemented by [Steven G. Johnson](http://math.mit.edu/~stevenj/), Massachusetts Institute of Technology. ## Introduction Harminv is a free program (and accompanying library) to solve the problem of "harmonic inversion." Given a discrete, finite-length signal that consists of a sum of finitely-many sinusoids (possibly exponentially decaying), it determines the frequencies, decay constants, amplitudes, and phases of those sinusoids. It can, in principle, provide much better accuracy than straightforward FFT based methods, essentially because it assumes a specific form for the signal. (Fourier transforms, in contrast, attempt to represent *any* data as a sum of sinusoidal components.) We use a low-storage **"filter diagonalization method"** (FDM) for finding the sinusoids near a given frequency interval, described in: * [V. A. Mandelshtam](http://www.faculty.uci.edu/profile.cfm?faculty_id=4582) and H. S. Taylor, ["Harmonic inversion of time signals,"](http://dx.doi.org/10.1063/1.475324) J. Chem. Phys., vol. 107, no. 17, p. 6756-6769 (Nov. 1 1997). See also erratum, ibid, vol. 109, no. 10, p. 4128 (Sep. 8 1998). This kind of spectral analysis has wide applications in many areas of physics and engineering, as well as other fields. For example, it could be used to extract the vibrational or "eigen" modes of a system from its response to some stimulus, and also their rates of decay in dissipative systems. FDM has been applied to analyze, e.g., NMR experimental data and numerical simulations of quantum mechanics or [electromagnetism](http://dx.doi.org/doi:10.1016/j.cpc.2009.11.008). In general, it is useful when you know on physical grounds that your system consists of a **small number of decaying & oscillating modes in the bandwidth of interest,** plus a limited amount of noise, and is **not appropriate to analyze completely arbitrary waveforms.** ## Download The latest version is Harminv 1.4.1, which can be downloaded in source-code form at: * https://github.com/NanoComp/harminv/releases/download/v1.4.1/harminv-1.4.1.tar.gz What's new in each version is described in the [Harminv release notes](NEWS.md). Harminv is distributed under the [GNU GPL](http://www.gnu.org/copyleft/gpl.html) and comes with **NO WARRANTY** (see the license for more details). Development sources can be found on GitHub: * [Harminv GitHub repository](https://github.com/NanoComp/harminv) It would be courteous of you to **cite Harminv** and its author in any publication for which you find it useful, in addition to citing a Mandelshtam reference (either the one above or the review article below). To install Harminv, please see our [installation instructions](doc/installation.md). If you use [Debian GNU/Linux](https://en.wikipedia.org/wiki/Debian) or [Ubuntu](https://en.wikipedia.org/wiki/Ubuntu_(operating_system)), you can use the Debian package of harminv, packaged by Loic Le Guyader. A Python interface to Harminv was developed by Aaron O'Leary: [pharminv](https://github.com/aaren/harminv). Please file bug reports or feature requests as [harminv Github issues](https://github.com/NanoComp/harminv/issues). ## Usage Most people will use Harminv via the stand-alone `harminv` program [as described in its manual](doc/harminv-man.md). To briefly summarize, it takes a sequence of numbers (real or complex) from standard input and a range of frequencies to search and outputs the frequencies it finds. It is also possible to [call Harminv as library](doc/library.md) from a C/C++ program. ## Test Cases/Examples The input for harminv should just be a list of numbers (real or complex), one per line, as described in the harminv man page. You can use the program `sines`, in the harminv source directory, to test harminv and to generate example inputs. The sines program generates a signal consisting of a sum of decaying sinuoids with specified complex frequencies. For example, ``` ./sines 0.1+0.01i 0.08+0.001i ``` generates 10000 data points consisting of a signal with complex frequencies 0.1+0.01i and 0.08+0.001i, with amplitudes 1 and 2 respectively, sampled at time intervals dt=1.0. If we input this data into harminv, it should be able to extract these frequencies, decay rates, and amplitudes. ``` ./sines 0.1+0.01i 0.08+0.001i | harminv 0.05-0.15 ``` The output should be something like: ``` frequency, decay constant, Q, amplitude, phase, error 0.08, 1.000000e-03, 251.327, 2, 3.14159, 1.064964e-16 0.1, 1.000000e-02, 31.4159, 1, -4.31228e-15, 2.265265e-15 ``` as expected. Note that we have to pass harminv a range of frequencies to search, here 0.05-0.15, which shouldn't be too large and should normally not include 0. In most cases, one would also specify the sampling interval to harminv via `harminv -t