ReadImageInfo - Read image information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Get information about the image

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

Display information about the input image like: image size, origin, spacing, metadata, projections...

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

.. [#] Table: Parameters table for Read image information.

+-----------------------+------------------------------------------+--------------------------+
|Parameter Key          |Parameter Name                            |Parameter Type            |
+=======================+==========================================+==========================+
|in                     |Input Image                               |Input image               |
+-----------------------+------------------------------------------+--------------------------+
|keywordlist            |Display the OSSIM keywordlist             |Boolean                   |
+-----------------------+------------------------------------------+--------------------------+
|outkwl                 |Write the OSSIM keywordlist to a geom file|Output File name          |
+-----------------------+------------------------------------------+--------------------------+
|indexx                 |Start index X                             |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|indexy                 |Start index Y                             |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|sizex                  |Size X                                    |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|sizey                  |Size Y                                    |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|spacingx               |Pixel Size X                              |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|spacingy               |Pixel Size Y                              |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|originx                |Image Origin X                            |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|originy                |Image Origin Y                            |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|estimatedgroundspacingx|Estimated ground spacing X                |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|estimatedgroundspacingy|Estimated ground spacing Y                |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|numberbands            |Number Of Bands                           |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|sensor                 |Sensor id                                 |String                    |
+-----------------------+------------------------------------------+--------------------------+
|id                     |Image id                                  |String                    |
+-----------------------+------------------------------------------+--------------------------+
|time                   |Acquisition time                          |String                    |
+-----------------------+------------------------------------------+--------------------------+
|ullat                  |Upper left latitude                       |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|ullon                  |Upper left longitude                      |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|urlat                  |Upper right latitude                      |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|urlon                  |Upper right longitude                     |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|lrlat                  |Lower right latitude                      |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|lrlon                  |Lower right longitude                     |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|lllat                  |Lower left latitude                       |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|lllon                  |Lower left longitude                      |Float                     |
+-----------------------+------------------------------------------+--------------------------+
|town                   |Nearest town                              |String                    |
+-----------------------+------------------------------------------+--------------------------+
|country                |Country                                   |String                    |
+-----------------------+------------------------------------------+--------------------------+
|rgb                    |Default RGB Display                       |Group                     |
+-----------------------+------------------------------------------+--------------------------+
|rgb.r                  |Red Band                                  |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|rgb.g                  |Green Band                                |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|rgb.b                  |Blue Band                                 |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|projectionref          |Projection                                |String                    |
+-----------------------+------------------------------------------+--------------------------+
|keyword                |Keywordlist                               |String                    |
+-----------------------+------------------------------------------+--------------------------+
|gcp                    |Ground Control Points information         |Group                     |
+-----------------------+------------------------------------------+--------------------------+
|gcp.count              |GCPs Number                               |Int                       |
+-----------------------+------------------------------------------+--------------------------+
|gcp.proj               |GCP Projection                            |String                    |
+-----------------------+------------------------------------------+--------------------------+
|gcp.ids                |GCPs Id                                   |String list               |
+-----------------------+------------------------------------------+--------------------------+
|gcp.info               |GCPs Info                                 |String list               |
+-----------------------+------------------------------------------+--------------------------+
|gcp.imcoord            |GCPs Image Coordinates                    |String list               |
+-----------------------+------------------------------------------+--------------------------+
|gcp.geocoord           |GCPs Geographic Coordinates               |String list               |
+-----------------------+------------------------------------------+--------------------------+
|inxml                  |Load otb application from xml file        |XML input parameters file |
+-----------------------+------------------------------------------+--------------------------+
|outxml                 |Save otb application to xml file          |XML output parameters file|
+-----------------------+------------------------------------------+--------------------------+

**Input Image**: Input image to analyse.

**Display the OSSIM keywordlist**: Output the OSSIM keyword list. It contains metadata information (sensor model, geometry ). Information is stored in keyword list (pairs of key/value).

**Write the OSSIM keywordlist to a geom file**: This option allows extracting the OSSIM keywordlist of the image into a geom file.

**Start index X**: X start index.

**Start index Y**: Y start index.

**Size X**: X size (in pixels).

**Size Y**: Y size (in pixels).

**Pixel Size X**: Pixel size along X (in physical units).

**Pixel Size Y**: Pixel size along Y (in physical units).

**Image Origin X**: Origin along X.

**Image Origin Y**: Origin along Y.

**Estimated ground spacing X**: Estimated ground spacing along X (in meters).

**Estimated ground spacing Y**: Estimated ground spacing along Y (in meters).

**Number Of Bands**: Number of bands.

**Sensor id**: Sensor identifier.

**Image id**: Image identifier.

**Acquisition time**: Acquisition time.

**Upper left latitude**: Latitude of the upper left corner.

**Upper left longitude**: Longitude of the upper left corner.

**Upper right latitude**: Latitude of the upper right corner.

**Upper right longitude**: Longitude of the upper right corner.

**Lower right latitude**: Latitude of the lower right corner.

**Lower right longitude**: Longitude of the lower right corner.

**Lower left latitude**: Latitude of the lower left corner.

**Lower left longitude**: Longitude of the lower left corner.

**Nearest town**: Main town near center of image.

**Country**: Country of the image.

**[Default RGB Display]**: This group of parameters provide information about the default rgb composition.

- **Red Band**: Red band Number.
- **Green Band**: Green band Number.
- **Blue Band**: Blue band Number.

**Projection**: Projection Coordinate System.

**Keywordlist**: Image keyword list.

**[Ground Control Points information]**: This group of parameters provide information about all GCPs.

- **GCPs Number**: Number of GCPs.
- **GCP Projection**: Projection Coordinate System for GCPs.
- **GCPs Id**: GCPs identifier.
- **GCPs Info**: GCPs Information.
- **GCPs Image Coordinates**: GCPs Image coordinates.
- **GCPs Geographic Coordinates**: GCPs Geographic Coordinates.

**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_ReadImageInfo -in QB_Toulouse_Ortho_XS.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 ReadImageInfo application 
	ReadImageInfo = otbApplication.Registry.CreateApplication("ReadImageInfo")

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

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

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

None

Authors
~~~~~~~

This application has been written by OTB-Team.