Package org.geotools.coverage.grid.io.footprint

Enum FootprintBehavior

  • All Implemented Interfaces:
    Serializable, Comparable<FootprintBehavior>
    public enum FootprintBehavior
extends Enum<FootprintBehavior>
    Handles the way footprints should be treated.
    Author:
    Andrea Aime, GeoSolutions SAS, Simone Giannecchini, GeoSolutions SAS

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Cut  
      None  
      Transparent  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static FootprintBehavior getDefault()
      Retrieves the default FootprintBehavior.
      boolean handleFootprints()  
      RenderedImage postProcessBlankResponse​(RenderedImage finalImage, RenderingHints hints)
      Post processes a blank image response, eventually making it transparent
      RenderedImage postProcessMosaic​(RenderedImage mosaic, ROI overallROI, RenderingHints hints)
      Applies post processing to the result mosaic, eventually making certain areas transparent
      static FootprintBehavior valueOf​(String name)
      Returns the enum constant of this type with the specified name.
      static FootprintBehavior[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      static String[] valuesAsStrings()
      Retrieves the possible values as Strings.

      • Methods inherited from class Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • values

        public static FootprintBehavior[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (FootprintBehavior c : FootprintBehavior.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FootprintBehavior valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • handleFootprints

        public boolean handleFootprints()

      • valuesAsStrings

        public static String[] valuesAsStrings()
        Retrieves the possible values as Strings.
        Returns:
        an arrays of String that contains the representation of each value.

      • postProcessMosaic

        public RenderedImage postProcessMosaic​(RenderedImage mosaic,
                                       ROI overallROI,
                                       RenderingHints hints)
        Applies post processing to the result mosaic, eventually making certain areas transparent

      • postProcessBlankResponse

        public RenderedImage postProcessBlankResponse​(RenderedImage finalImage,
                                              RenderingHints hints)
        Post processes a blank image response, eventually making it transparent