1
0
mirror of https://github.com/node-red/node-red-nodes.git synced 2023-10-10 13:36:58 +02:00
node-red-nodes/function/smooth/README.md
2016-05-02 21:55:18 +01:00

38 lines
1.1 KiB
Markdown

node-red-node-smooth
====================
A <a href="http://nodered.org" target="_new">Node-RED</a> node that provides
several simple smoothing algorithms for incoming data values. These include
- Minimum
- Maximum
- Mean
- Standard Deviation
- High Pass Smoothing
- Low Pass Smoothing
Install
-------
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-smooth
Usage
-----
A simple node to provide various functions across several previous values,
including max, min, mean, standard deviation, high and low pass filters.
Max, Min, Mean and Standard Deviation work over a rolling window, based on a
specified number of previous values.
The High and Low pass filters use a smoothing factor. The higher the number
the more the smoothing. E.g. a value of 10 is similar to an &alpha; of 0.1.
It is analogous to an RC time constant - but there is no time component to
this as the code is based on events arriving.
**Note:** This node only operates on **numbers**. Anything else will try to be
made into a number and rejected if that fails.