org.esa.snap.core.datamodel

Class Mask.BandMathsType

java.lang.Object

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

org.esa.snap.core.datamodel.Mask.BandMathsType

Enclosing class:

Mask

public static class Mask.BandMathsType
extends Mask.ImageType

A mask image type which is based on band math.

Field Summary

Fields

Modifier and Type	Field and Description
static Mask.BandMathsType	INSTANCE
static String	PROPERTY_NAME_EXPRESSION
static 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 and Description
boolean	canTransferMask(Mask mask, Product product)
static Mask	create(String name, String description, int width, int height, String expression, Color color, double transparency)
static Mask	createFromBitmaskDef(org.jdom.Element element, int width, int height) Used to read in Mask from legacy "BitmaskDef" format
MultiLevelImage	createImage(Mask mask) Creates the mask's source image.
PropertyContainer	createImageConfig() Creates a prototype image configuration.
static String	getExpression(Mask mask)
void	handleRename(Mask mask, String oldExternalName, String newExternalName)
static void	setExpression(Mask mask, String expression)
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 Detail

TYPE_NAME

public static final String TYPE_NAME

See Also:

Constant Field Values

PROPERTY_NAME_EXPRESSION

public static final String PROPERTY_NAME_EXPRESSION

See Also:

Constant Field Values

INSTANCE

public static final Mask.BandMathsType INSTANCE

Method Detail

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

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

setExpression

public static void setExpression(Mask mask,
                                 String expression)

getExpression

public static String getExpression(Mask mask)

create

public static Mask create(String name,
                          String description,
                          int width,
                          int height,
                          String expression,
                          Color color,
                          double transparency)

createFromBitmaskDef

public static Mask createFromBitmaskDef(org.jdom.Element element,
                                        int width,
                                        int height)

Used to read in Mask from legacy "BitmaskDef" format

Parameters:

element - A DOM element

width - The width of the mask

height - The height of the mask

Returns:

a mask