org.geotools.coverage.grid.io.footprint

Enum FootprintBehavior

Object

Enum<FootprintBehavior>

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 and Description
Cut
None
Transparent

Method Summary

Modifier and Type	Method and 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

Enum Constant Detail

None

public static final FootprintBehavior None

Cut

public static final FootprintBehavior Cut

Transparent

public static final FootprintBehavior Transparent

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()

getDefault

public static FootprintBehavior getDefault()

Retrieves the default FootprintBehavior.

Returns:

the default FootprintBehavior.

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

Parameters:

mosaic -

overallROI -

Returns:

postProcessBlankResponse

public RenderedImage postProcessBlankResponse(RenderedImage finalImage,
                                              RenderingHints hints)

Post processes a blank image response, eventually making it transparent

Parameters:

finalImage -

Returns: