changeset 240:a1c83801f973

Update documentation for xtract_lnorm()
author Jamie Bullock <jamie@jamiebullock.com>
date Thu, 05 Jun 2014 20:29:46 +0100
parents b015187746fa
children 66ebf1399a29
files xtract/xtract_delta.h
diffstat 1 files changed, 1 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/xtract/xtract_delta.h	Thu Jun 05 20:26:06 2014 +0100
+++ b/xtract/xtract_delta.h	Thu Jun 05 20:29:46 2014 +0100
@@ -51,7 +51,7 @@
  *
  * \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
  *
  */