aboutsummaryrefslogtreecommitdiff
path: root/xtract/xtract_scalar.h
diff options
context:
space:
mode:
authorSean Enderby <sean.enderby@gmail.com>2014-02-24 14:57:02 +0000
committerSean Enderby <sean.enderby@gmail.com>2014-02-24 14:57:02 +0000
commitee2b29b3b5a0de5e1ed1026ebe5d753469e43201 (patch)
treedd799cae8be350f60f3668fc6bda9a7d55e0e850 /xtract/xtract_scalar.h
parent2b976e4bce32413fc3e76dc81a48178f4d871270 (diff)
downloadLibXtract-ee2b29b3b5a0de5e1ed1026ebe5d753469e43201.tar.gz
LibXtract-ee2b29b3b5a0de5e1ed1026ebe5d753469e43201.tar.bz2
LibXtract-ee2b29b3b5a0de5e1ed1026ebe5d753469e43201.zip
documentation update
Diffstat (limited to 'xtract/xtract_scalar.h')
-rw-r--r--xtract/xtract_scalar.h4
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
*/