Package com.luciad.util.height

Class TLcdImageHeightProvider.Builder

java.lang.Object
com.luciad.util.height.TLcdImageHeightProvider.Builder
Enclosing class:
TLcdImageHeightProvider
public static class TLcdImageHeightProvider.Builder extends Object
Builder to create a TLcdImageHeightProvider.
Since:
2026.1

  • Method Details

    • image

      public TLcdImageHeightProvider.Builder image(ALcdBasicImage aImage)
      Sets the image to read the height values from.
      Parameters:
      aImage - image to read elevation values from
      Returns:
      this

    • image

      public TLcdImageHeightProvider.Builder image(ALcdImageMosaic aImage)
      Sets the image to read the height values from.
      Parameters:
      aImage - image to read elevation values from
      Returns:
      this

    • imagingEngine

      public TLcdImageHeightProvider.Builder imagingEngine(ALcdImagingEngine aImagingEngine)
      TLcdImageHeightProvider needs an ALcdImagingEngine to read values from an image. It can be supplied with this method or the provider can create its own. If the given imaging engine is null, a default imaging engine will be used.
      Parameters:
      aImagingEngine - the imaging engine to use
      Returns:
      this

    • interpolate

      public TLcdImageHeightProvider.Builder interpolate(boolean aInterpolate)
      Set whether height values should be interpolated. By default, values are retrieved by nearest neighbor.
      Parameters:
      aInterpolate - true if height values should be interpolated.
      Returns:
      this

    • validHeightInterval

      public TLcdImageHeightProvider.Builder validHeightInterval(int aMinValidHeight, int aMaxValidHeight)
      Sets the value range wherein values are considered to be valid heights. By default, heights outside the range of -12000 to 10000 are returned as invalid (Double.NaN).
      Parameters:
      aMinValidHeight - the minimum valid height
      aMaxValidHeight - the maximum valid height
      Returns:
      this

    • maxCacheEntries

      public TLcdImageHeightProvider.Builder maxCacheEntries(int aMaxCacheEntries)
      Sets the maximal number of entries that can be stored in the provider's tile cache.
      Parameters:
      aMaxCacheEntries - the maximum number of entries in the cache
      Returns:
      this

    • maxCacheSize

      public TLcdImageHeightProvider.Builder maxCacheSize(int aMaxCacheSize)
      Sets the maximum size (in megabytes) that can be stored in the provider's tile cache.
      The default value is 16 MB, which is suited for most uses. If you are reading a lot of data, you may want to increase the default size.
      Parameters:
      aMaxCacheSize - the maximum size in megabytes
      Returns:
      this

    • build

      public TLcdImageHeightProvider build() throws IllegalStateException
      Create a new TLcdImageHeightProvider with the currently defined properties. To create the provider, a single image must be set.
      Returns:
      a height provider that can read data from an image.
      Throws:
      IllegalStateException - when not exactly one image has been set