diff options
author | Sean Enderby <sean.enderby@gmail.com> | 2014-02-24 14:32:04 +0000 |
---|---|---|
committer | Sean Enderby <sean.enderby@gmail.com> | 2014-02-24 14:32:04 +0000 |
commit | 2b976e4bce32413fc3e76dc81a48178f4d871270 (patch) | |
tree | d2100c69124eece8ec5c1811144ecdaacee82469 /xtract/xtract_scalar.h | |
parent | f0e868fcf448ca3b546d318ff59f6dab12156279 (diff) | |
download | LibXtract-2b976e4bce32413fc3e76dc81a48178f4d871270.tar.gz LibXtract-2b976e4bce32413fc3e76dc81a48178f4d871270.tar.bz2 LibXtract-2b976e4bce32413fc3e76dc81a48178f4d871270.zip |
correction to xtract_odd_even_ratio
Diffstat (limited to 'xtract/xtract_scalar.h')
-rw-r--r-- | xtract/xtract_scalar.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/xtract/xtract_scalar.h b/xtract/xtract_scalar.h index e18aea6..48b8f9e 100644 --- a/xtract/xtract_scalar.h +++ b/xtract/xtract_scalar.h @@ -324,9 +324,9 @@ int xtract_power(const double *data, const int N, const void *argv, double *resu /* Odd to even harmonic ratio */ /** \brief Extract the Odd to even harmonic ratio of an input vector * - * \param *data: a pointer to the first element in an array of doubles representing the amplitudes of the harmonic spectrum of an audio vector. It is sufficient to pass in a pointer to the first half of the array pointed to by *result from xtract_harmonic_spectrum(). + * \param *data: a pointer to the first element in an array of doubles representing the amplitudes of the harmonic spectrum of an audio vector. It is sufficient to pass in a pointer to array pointed to by *result from xtract_harmonic_spectrum(). * \param N: the number of elements to be considered. If using the array pointed to by *result from xtract_harmonics, N should equal half the total array size i.e., just the amplitudes of the peaks. - * \param *argv: a pointer to NULL + * \param *argv: a pointer to a double representing the fundamental frequency of the input vector. * \param *result: the even/odd harmonic ratio of N values from the array pointed to by *data */ int xtract_odd_even_ratio(const double *data, const int N, const void *argv, double *result); |