diff options
| author | Brijeshcr | 2017-11-30 20:21:36 +0530 |
|---|---|---|
| committer | Brijeshcr | 2017-11-30 20:21:36 +0530 |
| commit | 9d18f39d1775acd7f96e2388b186bb15068ff910 (patch) | |
| tree | 7dc4d248208dd3ea7dac6e4ffb056f9b16a601eb /help/en_US/fwht.xml | |
| parent | c257cd7a7e766fb89332cca4fb367904767362ed (diff) | |
| parent | 14d0ad8d846d12b3c82b0b5bc4ffd4d1360ec288 (diff) | |
| download | FOSSEE-Signal-Processing-Toolbox-9d18f39d1775acd7f96e2388b186bb15068ff910.tar.gz FOSSEE-Signal-Processing-Toolbox-9d18f39d1775acd7f96e2388b186bb15068ff910.tar.bz2 FOSSEE-Signal-Processing-Toolbox-9d18f39d1775acd7f96e2388b186bb15068ff910.zip | |
Merge and solve ifft2 conflict
Diffstat (limited to 'help/en_US/fwht.xml')
| -rw-r--r-- | help/en_US/fwht.xml | 48 |
1 files changed, 47 insertions, 1 deletions
diff --git a/help/en_US/fwht.xml b/help/en_US/fwht.xml index 7b62250..4140453 100644 --- a/help/en_US/fwht.xml +++ b/help/en_US/fwht.xml @@ -17,7 +17,53 @@ <refnamediv> <refname>fwht</refname> - <refpurpose></refpurpose> + <refpurpose>Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm</refpurpose> </refnamediv> + +<refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis> + fwht (x) + fwht (x, n) + fwht (x, n, order) + </synopsis> +</refsynopsisdiv> + +<refsection> + <title>Parameters</title> + <variablelist> + <varlistentry><term>x:</term> + <listitem><para> real or complex valued scalar or vector</para></listitem></varlistentry> + <varlistentry><term>n:</term> + <listitem><para> x is truncated or extended to have length n</para></listitem></varlistentry> + <varlistentry><term>order:</term> + <listitem><para> Specification of order in which coefficients should be arranged</para></listitem></varlistentry> + </variablelist> +</refsection> + +<refsection> + <title>Description</title> + <para> +Compute the Walsh-Hadamard transform of x using the Fast Walsh-Hadamard Transform (FWHT) algorithm. If the input is a matrix, the FWHT is calculated along the columns of x. + </para> + <para> +The number of elements of x must be a power of 2; if not, the input will be extended and filled with zeros. If a second argument is given, the input is truncated or extended to have length n. + </para> + <para> +The third argument specifies the order in which the returned Walsh-Hadamard transform coefficients should be arranged. The order may be any of the following strings: + </para> + <para> +"sequency" +The coefficients are returned in sequency order. This is the default if order is not given. + </para> + <para> +"hadamard" +The coefficients are returned in Hadamard order. + </para> + <para> +"dyadic" +The coefficients are returned in Gray code order. +</para> +</refsection> </refentry> |