diff options
| -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 48b8f9e..2bbf0ec 100644 --- a/xtract/xtract_scalar.h +++ b/xtract/xtract_scalar.h @@ -324,8 +324,8 @@ 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 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 *data: a pointer to the first element in an array of doubles representing a harmonic spectrum of size N/2, and a frequency spectrum of size N/2 (This is the output format of xtract_harmonic_spectrum()) + * \param N: the number of elements to be considered. * \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 */ |