diff options
Diffstat (limited to 'xtract/xtract_scalar.h')
| -rw-r--r-- | xtract/xtract_scalar.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/xtract/xtract_scalar.h b/xtract/xtract_scalar.h index 59c92dc..eae8afc 100644 --- a/xtract/xtract_scalar.h +++ b/xtract/xtract_scalar.h @@ -117,7 +117,7 @@ int xtract_irregularity_j(float *data, int N, void *argv, float *result); /** \brief Calculate the Tristimulus of an input vector using a method described by Pollard and Jansson (1982) * - * \param *data: a pointer to the first element in an array of floats representing the amplitudes of the harmonic spectrum of an audio vector + * \param *data: a pointer to the first element in an array of floats representing the amplitudes of the harmonic spectrum of an audio vector e.g. a pointer to the second half of the array pointed to by *result from xtract_harmonics() * \param N: the number of elements to be considered * \param *argv: a pointer to NULL * \param *result: the tristimulus of N values from the array pointed to by *data @@ -246,8 +246,8 @@ int xtract_power(float *data, int N, void *argv, float *result); /* 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 floats representing the harmonic spectrum of an audio vector - * \param N: the number of elements to be considered + * \param *data: a pointer to the first element in an array of floats representing the frequencies of the harmonic spectrum of an audio vector. It is sufficient to pass in a pointer to the array pointed to by *result from xtract_harmonics. + * \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 frequencies of the peaks. * \param *argv: a pointer to NULL * \param *result: the odd/even harmonic ratio of N values from the array pointed to by *data */ |