GrayScaleMorphologicalOperation - Grayscale Morphological Operation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Performs morphological operations on a grayscale input image

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

This application performs grayscale morphological operations on a mono band image

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 *GrayScaleMorphologicalOperation* .

.. [#] Table: Parameters table for Grayscale Morphological Operation.

+----------------------+----------------------------------+--------------------------+
|Parameter Key         |Parameter Name                    |Parameter Type            |
+======================+==================================+==========================+
|in                    |Input Image                       |Input image               |
+----------------------+----------------------------------+--------------------------+
|out                   |Feature Output Image              |Output image              |
+----------------------+----------------------------------+--------------------------+
|channel               |Selected Channel                  |Int                       |
+----------------------+----------------------------------+--------------------------+
|ram                   |Available RAM (Mb)                |Int                       |
+----------------------+----------------------------------+--------------------------+
|structype             |Structuring Element Type          |Choices                   |
+----------------------+----------------------------------+--------------------------+
|structype ball        |Ball                              | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|structype cross       |Cross                             | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|structype.ball.xradius|The Structuring Element X Radius  |Int                       |
+----------------------+----------------------------------+--------------------------+
|structype.ball.yradius|The Structuring Element Y Radius  |Int                       |
+----------------------+----------------------------------+--------------------------+
|filter                |Morphological Operation           |Choices                   |
+----------------------+----------------------------------+--------------------------+
|filter dilate         |Dilate                            | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|filter erode          |Erode                             | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|filter opening        |Opening                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|filter closing        |Closing                           | *Choice*                 |
+----------------------+----------------------------------+--------------------------+
|inxml                 |Load otb application from xml file|XML input parameters file |
+----------------------+----------------------------------+--------------------------+
|outxml                |Save otb application to xml file  |XML output parameters file|
+----------------------+----------------------------------+--------------------------+

**Input Image**: The input image to be filtered.

**Feature Output Image**: Output image containing the filtered output image.

**Selected Channel**: The selected channel index.

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

**Structuring Element Type**: Choice of the structuring element type. Available choices are: 

- **Ball**

 * **The Structuring Element X Radius**: The Structuring Element X Radius.
 * **The Structuring Element Y Radius**: The Structuring Element Y Radius.

- **Cross**

**Morphological Operation**: Choice of the morphological operation. Available choices are: 

- **Dilate**
- **Erode**
- **Opening**
- **Closing**

**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_GrayScaleMorphologicalOperation -in qb_RoadExtract.tif -out opened.tif -channel 1 -structype.ball.xradius 5 -structype.ball.yradius 5 -filter erode

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 GrayScaleMorphologicalOperation application 
	GrayScaleMorphologicalOperation = otbApplication.Registry.CreateApplication("GrayScaleMorphologicalOperation")

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

	GrayScaleMorphologicalOperation.SetParameterString("out", "opened.tif")

	GrayScaleMorphologicalOperation.SetParameterInt("channel", 1)

	GrayScaleMorphologicalOperation.SetParameterInt("structype.ball.xradius", 5)

	GrayScaleMorphologicalOperation.SetParameterInt("structype.ball.yradius", 5)

	GrayScaleMorphologicalOperation.SetParameterString("filter","erode")

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

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

None

Authors
~~~~~~~

This application has been written by OTB-Team.

See Also
~~~~~~~~

These additional resources can be useful for further information: 
  | itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes