diff --git a/documentation/NDPluginProcess.html b/documentation/NDPluginProcess.html index e1e41b1..cbeda24 100755 --- a/documentation/NDPluginProcess.html +++ b/documentation/NDPluginProcess.html @@ -10,7 +10,7 @@
- The recursive average filter does input array summing. It is defined as:
+ The average filter does input array averaging. It is defined as:O[n] = F[n] = F[n-1] + 1/N*I[n]
- N is the characteristic number of arrays in the sum. For example, if N=100, then - each new array is weighted by 0.01. When this filter is reset the filter array is - initialized to 0. This filter typically cannot be run forever, because the output - grows monotonically and will lead to overflow. + N is the number of arrays in the average. For example, if N=100, then each new array + is weighted by 0.01. When this filter is reset the filter array is initialized to + 0. This filter typically cannot be run forever, because the output grows monotonically + and will lead to overflow. However, if AutoResetFilter is enabled then the filter + will be reset when NumFiltered=NumFilter. If ArrayCallbacks is "Array N only" then + callbacks will be done only with the final averaged value. +
++ The sum filter does input array summing. It is defined as:
++O[n] = F[n] = F[n-1] + I[n] ++
+ This filter simply computes the sum of input arrays. When this filter is reset the + filter array is initialized to 0. It is often necessary to set the output data type + to one with a larger maximum value than the input array to prevent overflow. If + AutoResetFilter is enabled then the filter will be reset when NumFiltered=NumFilter. + If ArrayCallbacks is "Array N only" then callbacks will be done only with the final + summed value.