org.esa.beam.framework.datamodel
Class ROIDefinition

java.lang.Object
  org.esa.beam.framework.datamodel.ROIDefinition

All Implemented Interfaces:

Cloneable

Deprecated. since BEAM 4.7, use Mask instead

@Deprecated
public class ROIDefinition
extends Object
implements Cloneable

This class contains information about the ROI associated with the a raster dataset.

Constructor Summary

ROIDefinition()
Deprecated.

Method Summary

ROIDefinition	createCopy() Deprecated. Creates and returns a copy of this object.
void	dispose() Deprecated. Releases all of the resources used by this object instance and all of its owned children.
String	getBitmaskExpr() Deprecated. Gets the bitmask expression.
Figure	getShapeFigure() Deprecated.
float	getValueRangeMax() Deprecated.
float	getValueRangeMin() Deprecated.
void	initFromJDOMElem(org.jdom.Element roiDefElem) Deprecated.
boolean	isBitmaskEnabled() Deprecated.
boolean	isInverted() Deprecated.
boolean	isOrCombined() Deprecated.
boolean	isPinUseEnabled() Deprecated.
boolean	isShapeEnabled() Deprecated.
boolean	isUsable() Deprecated.
boolean	isValueRangeEnabled() Deprecated.
void	setBitmaskEnabled(boolean bitmaskEnabled) Deprecated.
void	setBitmaskExpr(String bitmaskExpr) Deprecated. Sets the bitmask expression.
void	setInverted(boolean inverted) Deprecated.
void	setOrCombined(boolean orCombined) Deprecated.
void	setPinUseEnabled(boolean pinUseEnabled) Deprecated.
void	setShapeEnabled(boolean shapeEnabled) Deprecated.
void	setShapeFigure(Figure figure) Deprecated.
void	setValueRangeEnabled(boolean valueRangeEnabled) Deprecated.
void	setValueRangeMax(float valueRangeMax) Deprecated.
void	setValueRangeMin(float valueRangeMin) Deprecated.
void	writeXML(XmlWriter writer, int indent) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ROIDefinition

public ROIDefinition()

Deprecated.

Method Detail

isUsable

public boolean isUsable()

Deprecated.

isBitmaskEnabled

public boolean isBitmaskEnabled()

Deprecated.

setBitmaskEnabled

public void setBitmaskEnabled(boolean bitmaskEnabled)

Deprecated.

getBitmaskExpr

public String getBitmaskExpr()

Deprecated.

Gets the bitmask expression.

Returns:

the expression, can be an empty string, never null

setBitmaskExpr

public void setBitmaskExpr(String bitmaskExpr)

Deprecated.

Sets the bitmask expression.

Parameters:

bitmaskExpr - the expression, can be an empty string, must not be null

isShapeEnabled

public boolean isShapeEnabled()

Deprecated.

setShapeEnabled

public void setShapeEnabled(boolean shapeEnabled)

Deprecated.

getShapeFigure

public Figure getShapeFigure()

Deprecated.

setShapeFigure

public void setShapeFigure(Figure figure)

Deprecated.

isValueRangeEnabled

public boolean isValueRangeEnabled()

Deprecated.

setValueRangeEnabled

public void setValueRangeEnabled(boolean valueRangeEnabled)

Deprecated.

getValueRangeMax

public float getValueRangeMax()

Deprecated.

setValueRangeMax

public void setValueRangeMax(float valueRangeMax)

Deprecated.

getValueRangeMin

public float getValueRangeMin()

Deprecated.

setValueRangeMin

public void setValueRangeMin(float valueRangeMin)

Deprecated.

isPinUseEnabled

public boolean isPinUseEnabled()

Deprecated.

setPinUseEnabled

public void setPinUseEnabled(boolean pinUseEnabled)

Deprecated.

isOrCombined

public boolean isOrCombined()

Deprecated.

setOrCombined

public void setOrCombined(boolean orCombined)

Deprecated.

isInverted

public boolean isInverted()

Deprecated.

setInverted

public void setInverted(boolean inverted)

Deprecated.

createCopy

public ROIDefinition createCopy()

Deprecated.

Creates and returns a copy of this object.

Returns:

a copy of this object

writeXML

public void writeXML(XmlWriter writer,
                     int indent)

Deprecated.

initFromJDOMElem

public void initFromJDOMElem(org.jdom.Element roiDefElem)

Deprecated.

dispose

public void dispose()

Deprecated.

Releases all of the resources used by this object instance and all of its owned children. Its primary use is to allow the garbage collector to perform a vanilla job.

This method should be called only if it is for sure that this object instance will never be used again. The results of referencing an instance of this class after a call to dispose() are undefined.

Overrides of this method should always call super.dispose(); after disposing this instance.