File: thresholding-functions.rst

package info (click to toggle)
pywavelets 0.2.0-5
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,584 kB
  • sloc: ansic: 3,357; python: 1,843; makefile: 143
file content (70 lines) | stat: -rw-r--r-- 1,552 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _ref-thresholding:

.. module:: pywt.thresholding
.. include:: ../substitutions.rst


Thresholding functions
======================

The :mod:`~pywt.thresholding` helper module implements the most popular signal
thresholding functions.


Hard thresholding
-----------------

.. function:: hard(data, value[, substitute=0])

   Hard thresholding. Replace all *data* values with *substitute* where their
   absolute value is less than the *value* param.

   *Data* values with absolute value greater or equal to the thresholding
   *value* stay untouched.

   :param data: numeric data
   :param value: thresholding value
   :param substitute: substitute value
   :returns: array


Soft thresholding
-----------------
.. function:: soft(data, value[, substitute=0])

   Soft thresholding.

   :param data: numeric data
   :param value: thresholding value
   :param substitute: substitute value
   :returns: array

Greater
-------

.. function:: greater(data, value[, substitute=0])

   Replace *data* with *substitute* where *data* is below the thresholding
   *value*.

   `Greater` *data* values pass untouched.

   :param data: numeric data
   :param value: thresholding value
   :param substitute: substitute value
   :returns: array

Less
----

.. function:: less(data, value[, substitute=0])

   Replace *data* with *substitute* where *data* is above the thresholding
   *value*.

   `Less` *data* values pass untouched.

   :param data: numeric data
   :param value: thresholding value
   :param substitute: substitute value
   :returns: array