Package org.esa.snap.core.datamodel

Class Mask.RangeType

java.lang.Object

org.esa.snap.core.datamodel.Mask.ImageType

org.esa.snap.core.datamodel.Mask.RangeType

Enclosing class:

Mask

public static class Mask.RangeType
extends Mask.ImageType

Field Summary

Fields

Modifier and Type	Field	Description
static final Mask.RangeType	INSTANCE
static final String	PROPERTY_NAME_MAXIMUM
static final String	PROPERTY_NAME_MINIMUM
static final String	PROPERTY_NAME_RASTER
static final String	TYPE_NAME

Fields inherited from class org.esa.snap.core.datamodel.Mask.ImageType

DEFAULT_COLOR, DEFAULT_TRANSPARENCY, PROPERTY_NAME_COLOR, PROPERTY_NAME_TRANSPARENCY

Method Summary

Modifier and Type	Method	Description
boolean	canTransferMask(Mask mask, Product product)
MultiLevelImage	createImage(Mask mask)	Creates the mask's source image.
PropertyContainer	createImageConfig()	Creates a prototype image configuration.
static String	getExpression(Mask mask)
static Double	getMaximum(Mask mask)
static Double	getMinimum(Mask mask)
static String	getRasterName(Mask mask)
void	handleRename(Mask mask, String oldExternalName, String newExternalName)
static void	setMaximum(Mask mask, double maximum)
static void	setMinimum(Mask mask, double minimum)
static void	setRasterName(Mask mask, String rasterName)
Mask	transferMask(Mask mask, Product product)

Methods inherited from class org.esa.snap.core.datamodel.Mask.ImageType

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE_NAME

public static final String TYPE_NAME

See Also:

• Constant Field Values

PROPERTY_NAME_MINIMUM

public static final String PROPERTY_NAME_MINIMUM

See Also:

• Constant Field Values

PROPERTY_NAME_MAXIMUM

public static final String PROPERTY_NAME_MAXIMUM

See Also:

• Constant Field Values

PROPERTY_NAME_RASTER

public static final String PROPERTY_NAME_RASTER

See Also:

• Constant Field Values

INSTANCE

public static final Mask.RangeType INSTANCE

Method Details

createImage

public MultiLevelImage createImage(Mask mask)

Description copied from class: Mask.ImageType

Creates the mask's source image.

Specified by:

createImage in class Mask.ImageType

Parameters:

mask - The mask which requests creation of its source image.

Returns:

The image.

canTransferMask

public boolean canTransferMask(Mask mask,
 Product product)

Overrides:

canTransferMask in class Mask.ImageType

transferMask

public Mask transferMask(Mask mask,
 Product product)

Overrides:

transferMask in class Mask.ImageType

createImageConfig

public PropertyContainer createImageConfig()

Description copied from class: Mask.ImageType

Creates a prototype image configuration.

Overrides:

createImageConfig in class Mask.ImageType

Returns:

The image configuration.

handleRename

public void handleRename(Mask mask,
 String oldExternalName,
 String newExternalName)

Overrides:

handleRename in class Mask.ImageType

setRasterName

public static void setRasterName(Mask mask,
 String rasterName)

getRasterName

public static String getRasterName(Mask mask)

setMinimum

public static void setMinimum(Mask mask,
 double minimum)

getMinimum

public static Double getMinimum(Mask mask)

setMaximum

public static void setMaximum(Mask mask,
 double maximum)

getMaximum

public static Double getMaximum(Mask mask)

getExpression

public static String getExpression(Mask mask)