Coyote Graphics Routines

Date: Fri Mar 27 12:14:20 2015

single page | use frames     summary     class     fields     routine details     file attributes


top cgGeoMosaic

Map Utilities

result = cgGeoMosaic(geofile_1, geofile_2 [, FILENAME=string] [, IMAGEOUT=varies] [, MAPOUT=object] [, MISSING=varies] [, MISS_OUT=varies] [, PALETTE=PALETTE] [, /SUCCESS])

Creates a mosaic or combination image, given the names of two GeoTiff image files. The images must be 2D images.

Return value

The name of a GeoTiff image file containing the combined image mosaic.


geofile_1 in required type=string

The name of the first GeoTiff file to be combined into a mosaic. Currently the code only works with 2D images.

geofile_2 in required type=string

The name of the second GeoTiff file to be combined into a mosaic. Currently the code only works with 2D images.


FILENAME in optional type=string

The name of the output GeoTiff file. If not provided, the user will be asked to create a name. If provided, the user will not be prompted and this name will be used.

IMAGEOUT out optional type=varies

The final image mosaic.

MAPOUT out optional type=object

A map coordinate object (cgMap) that geolocates the new image mosaic.

MISSING in optional type=varies

The missing value in the input images. If scalar value, the same value is used for both images, but may be a two-element array.

MISS_OUT in optional type=varies

The missing value of the output image. If undefined, missing[0] is used. If missing[0] is undefined, the value 0B is used.

PALETTE in optional

A 256x3 array containing the R, G, and B color vectors with which the image should be displayed. The palette will be stored with the mosaiced image. If this is not supplied, and either of the other images have a palette, it will be used instead. Images are checked for palettes in the order they are supplied to the function.

SUCCESS out optional type=boolean

This keyword is set to 1 if the function completed successfully. And to 0 otherwise.

Author information



David W. Fanning 1645 Sheely Drive Fort Collins, CO 80526 USA Phone: 970-221-0438 E-mail: Coyote's Guide to IDL Programming:


Copyright (c) 2012-2013, Fanning Software Consulting, Inc.


Change History:

Written, 18 August 2012. DWF. Added SUCCESS keyword 4 September 2012. DWF. Now blending overlap regions using 50% of pixel values from the two images. 14 Sept 2012. DWF. Revamp of algorithm's handing of missing values. Added MISS_OUT keyword and removed HISTOMATCH keyword because it only works for BYTE data. Restricted mosaicking to 2D images. 29 Jan 2013. DWF. Added PALETTE keyword and changed algoritm to use color palettes if available. 21 Nov 2013. DWF.

File attributes

Modification date: Fri Mar 27 11:07:36 2015
Lines: 293
Docformat: rst rst