# coyote: CGGEOMOSAIC

- coyote/Map Utilities
- [Source code]

Description

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

Categories

      Map Utilities

Returns

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

Params

      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.

Keywords

      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

      FANNING SOFTWARE CONSULTING::
          David W. Fanning
          1645 Sheely Drive
          Fort Collins, CO 80526 USA
          Phone: 970-221-0438
          E-mail: david@idlcoyote.com
          Coyote's Guide to IDL Programming: http://www.idlcoyote.com

History

      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.

Copyright

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