NAME
        DisplacePyr

   DESCRIPTION
        This module displaces the Z coordinates of the base lattice (1-D
        curvilinear) of a pyramid by values obtained from the data portion of a
        2-D lattice.  The X and Y coordinates of the base lattice are interpolated
        onto the X and Y coordinates of the 2-D lattice and the data values at
        these coordinates become the displacement for the Z coordinates of the
        base lattice.
        
        The main use of this module is to displace the outlines of geographic
        features obtained from the WorldMap module (in pyramid form).  This
        allows them to be smoothly overlaid onto isosurfaces and displaced
        lattices.

   INPUTS

      Input -- Pyramid
         (1..-layer, 1..-baseLat, n-D compression, n-compression type).
         This is the pyramid whose base lattice coordinates will be Z-displaced.

      Displacement -- Lattice
         (2-D, 1-vector).
         This is the lattice containing the data values to use for Z displacement.

   WIDGETS

      Interpolation Method -- Option Menu
         This is the method used to interpolate the pyramid coordinates onto
         the 2-D lattice.  The choices are "Linear" and "Nearest Neighbor", but
         "Linear" is usually recommended for smoother results.

      Scale -- Dial
         This is the scaling factor to be applied to the data values of the
         "Displacement" lattice which are subsequently added to the Z
         coordinates of the pyramid's base lattice.

   OUTPUTS

      Output -- Pyramid
         (1..-layer, 1..-baseLat, n-D compression, n-compression type).
         This is the pyramid with Z-displaced coordinates in its base lattice.

   KNOWN PROBLEMS
      There are no known bugs.

   SEE ALSO
      DisplaceLat, DisplaceLat2, WorldMap
      
      -
      
      Hans Vahlenkamp (Hans.Vahlenkamp@noaa.gov)
      Geophysical Fluid Dynamics Laboratory / NOAA
      Princeton University Forrestal Campus
      http://www.gfdl.noaa.gov