aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJamie Bullock <jamie@jamiebullock.com>2014-06-05 20:29:46 +0100
committerJamie Bullock <jamie@jamiebullock.com>2014-06-05 20:29:46 +0100
commit4ccf4a2a0c6bd386d1d35fc080138f5d1b39a749 (patch)
treec548e0083e61ca0226d0cd242f672f4c05e8534e
parent427a78a6638cba8dfcf57fa1bf95aa655ffc9320 (diff)
downloadLibXtract-4ccf4a2a0c6bd386d1d35fc080138f5d1b39a749.tar.gz
LibXtract-4ccf4a2a0c6bd386d1d35fc080138f5d1b39a749.tar.bz2
LibXtract-4ccf4a2a0c6bd386d1d35fc080138f5d1b39a749.zip
Update documentation for xtract_lnorm()
-rw-r--r--xtract/xtract_delta.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/xtract/xtract_delta.h b/xtract/xtract_delta.h
index 9c0882c..c7b3ee7 100644
--- a/xtract/xtract_delta.h
+++ b/xtract/xtract_delta.h
@@ -51,7 +51,7 @@ int xtract_flux(const double *data, const int N, const void *argv , double *resu
*
* \param *data: a pointer to the first element in an array of doubles representing the difference between two subsequent frames of output from a vector-based feature e.g. the *result from xtract_difference_vector()
* \param N: the length of the array pointed to by *data
- * \param *argv: a pointer to an array of doubles, the first representing the "norm order". The second argument represents the filter type determining what values we consider from the difference vector as given in the enumeration xtract_lnorm_filter_types_ (libxtract.h)
+ * \param *argv: a pointer to an array of doubles, the first representing the "norm order". The second argument represents the filter type determining what values we consider from the difference vector as given in the enumeration xtract_lnorm_filter_types_ (libxtract.h), the third sets whether we want the result to be normalised in the range 0-1 (0 = no normalise, 1 = normalise)
* \param *result: a pointer to a double representing the flux
*
*/