Package org.esa.snap.core.datamodel

Class Mask.ImageType

java.lang.Object

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

Direct Known Subclasses:

Mask.BandMathsType, Mask.RangeType, Mask.VectorDataType

Enclosing class:

Mask

public abstract static class Mask.ImageType
extends Object

Specifies a factory for the source image used by a Mask.

Field Summary

Fields

Modifier and Type	Field	Description
static Color	DEFAULT_COLOR
static double	DEFAULT_TRANSPARENCY
static String	PROPERTY_NAME_COLOR
static String	PROPERTY_NAME_TRANSPARENCY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImageType(String name)

Method Summary

Modifier and Type	Method	Description
boolean	canTransferMask(Mask mask, Product product)
abstract MultiLevelImage	createImage(Mask mask)	Creates the mask's source image.
PropertyContainer	createImageConfig()	Creates a prototype image configuration.
String	getName()
void	handleRename(Mask mask, String oldExternalName, String newExternalName)
Mask	transferMask(Mask mask, Product product)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_COLOR

public static final String PROPERTY_NAME_COLOR

See Also:

Constant Field Values

PROPERTY_NAME_TRANSPARENCY

public static final String PROPERTY_NAME_TRANSPARENCY

See Also:

Constant Field Values

DEFAULT_COLOR

public static final Color DEFAULT_COLOR

DEFAULT_TRANSPARENCY

public static final double DEFAULT_TRANSPARENCY

See Also:

Constant Field Values

Constructor Detail

ImageType

protected ImageType(String name)

Method Detail

createImage

public abstract MultiLevelImage createImage(Mask mask)

Creates the mask's source image.

Parameters:

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

Returns:

The image.

canTransferMask

public boolean canTransferMask(Mask mask,
                               Product product)

transferMask

public Mask transferMask(Mask mask,
                         Product product)

createImageConfig

public PropertyContainer createImageConfig()

Creates a prototype image configuration.

Returns:

The image configuration.

handleRename

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

getName

public String getName()