DomainTransform - DomainTransform
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Domain Transform application for wavelet and fourier

Detailed description
--------------------

Domain Transform application for wavelet and fourier

Parameters
----------

This section describes in details the parameters available for this application. Table [#]_ presents a summary of these parameters and the parameters keys to be used in command-line and programming languages. Application key is *DomainTransform* .

.. [#] Table: Parameters table for DomainTransform.

+----------------------+----------------------------------+--------------------------+
|Parameter Key         |Parameter Name                    |Parameter Type            |
+======================+==================================+==========================+
|in                    |Input Image                       |Input image               |
+----------------------+----------------------------------+--------------------------+
|out                   |Output Image                      |Output image              |
+----------------------+----------------------------------+--------------------------+
|mode                  |Mode                              |Choices                   |
+----------------------+----------------------------------+--------------------------+
|mode fft              |FFT transform                     | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode wavelet          |Wavelet                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.fft.shift        |Shift fft transform               |Boolean                   |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form     |Select wavelet form               |Choices                   |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form haar|HAAR                              | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form db4 |DAUBECHIES4                       | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form db6 |DAUBECHIES6                       | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form db8 |DAUBECHIES8                       | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form db12|DAUBECHIES12                      | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form db20|DAUBECHIES20                      | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form sb24|SPLINE_BIORTHOGONAL_2_4           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form sb44|SPLINE_BIORTHOGONAL_4_4           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.form sym8|SYMLET8                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|mode.wavelet.nlevels  |Number of decomposition levels    |Int                       |
+----------------------+----------------------------------+--------------------------+
|direction             |Direction                         |Choices                   |
+----------------------+----------------------------------+--------------------------+
|direction forward     |Forward                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|direction inverse     |Inverse                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|ram                   |Available RAM (Mb)                |Int                       |
+----------------------+----------------------------------+--------------------------+
|inxml                 |Load otb application from xml file|XML input parameters file |
+----------------------+----------------------------------+--------------------------+
|outxml                |Save otb application to xml file  |XML output parameters file|
+----------------------+----------------------------------+--------------------------+

**Input Image**: This will take an input image to be transformed image. For FFT inverse transform, it expects a complex image as two-band image in which first band represent real part and second band represent imaginary part.

**Output Image**: This parameter holds the output file name to which transformed image will be written. This has a slightly different behaviour depending on transform type.   For Wavelet, output is a single band image for both forward and inverse transform.   For FFT forward transform, output is two band image where first band represents real part and second band represents imaginary part of a complex image.

**Mode**: This parameter allows one to select between fft(fourier) and wavelet. Available choices are: 

- **FFT transform**: FFT transform.

 * **Shift fft transform**: Shift transform of fft filter.

- **Wavelet**: Wavelet transform.

 * **Select wavelet form** Available choices are: 

  + **HAAR**
  + **DAUBECHIES4**
  + **DAUBECHIES6**
  + **DAUBECHIES8**
  + **DAUBECHIES12**
  + **DAUBECHIES20**
  + **SPLINE_BIORTHOGONAL_2_4**
  + **SPLINE_BIORTHOGONAL_4_4**
  + **SYMLET8**

 * **Number of decomposition levels**: Number of decomposition levels.


**Direction** Available choices are: 

- **Forward**
- **Inverse**

**Available RAM (Mb)**: Available memory for processing (in MB).

**Load otb application from xml file**: Load otb application from xml file.

**Save otb application to xml file**: Save otb application to xml file.



Example
-------

To run this example in command-line, use the following: 
::

	otbcli_DomainTransform -in input.tif -mode.wavelet.form haar -out output_wavelet_haar.tif

To run this example from Python, use the following code snippet: 

::

	#!/usr/bin/python

	# Import the otb applications package
	import otbApplication

	# The following line creates an instance of the DomainTransform application 
	DomainTransform = otbApplication.Registry.CreateApplication("DomainTransform")

	# The following lines set all the application parameters:
	DomainTransform.SetParameterString("in", "input.tif")

	DomainTransform.SetParameterString("mode.wavelet.form","haar")

	DomainTransform.SetParameterString("out", "output_wavelet_haar.tif")

	# The following line execute the application
	DomainTransform.ExecuteAndWriteOutput()

Limitations
~~~~~~~~~~~

This application is not streamed, check your system resources when processing large images

Authors
~~~~~~~

This application has been written by OTB-Team.

See Also
~~~~~~~~

These additional resources can be useful for further information: 
  | otbWaveletImageFilter, otbWaveletInverseImageFilter, otbWaveletTransform