public class Mask extends Band
Mask is used to mask image pixels of other raster data nodes.
This is a preliminary API under construction for BEAM 4.7. Not intended for public use.
| Modifier and Type | Class and Description |
|---|---|
static class |
Mask.BandMathsType
A mask image type which is based on band math.
|
static class |
Mask.ImageType
Specifies a factory for the
source image used by a Mask. |
static class |
Mask.RangeType |
static class |
Mask.VectorDataType
A mask image type which is based on vector data.
|
RasterDataNode.RasterDataProcessorPROPERTY_NAME_SAMPLE_CODING, PROPERTY_NAME_SOLAR_FLUX, PROPERTY_NAME_SPECTRAL_BAND_INDEX, PROPERTY_NAME_SPECTRAL_BANDWIDTH, PROPERTY_NAME_SPECTRAL_WAVELENGTHINVALID_POS_TEXT, IO_ERROR_TEXT, NO_DATA_TEXT, PROPERTY_NAME_ANCILLARY_RELATIONS, PROPERTY_NAME_ANCILLARY_VARIABLES, PROPERTY_NAME_GEO_CODING, PROPERTY_NAME_IMAGE_INFO, PROPERTY_NAME_IMAGE_TO_MODEL_TRANSFORM, PROPERTY_NAME_LOG_10_SCALED, PROPERTY_NAME_MODEL_TO_SCENE_TRANSFORM, PROPERTY_NAME_NO_DATA_VALUE, PROPERTY_NAME_NO_DATA_VALUE_USED, PROPERTY_NAME_SCALING_FACTOR, PROPERTY_NAME_SCALING_OFFSET, PROPERTY_NAME_SCENE_TO_MODEL_TRANSFORM, PROPERTY_NAME_STX, PROPERTY_NAME_TIME_CODING, PROPERTY_NAME_VALID_PIXEL_EXPRESSIONPROPERTY_NAME_DATA, PROPERTY_NAME_READ_ONLY, PROPERTY_NAME_SYNTHETIC, PROPERTY_NAME_UNITPROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_NAME| Constructor and Description |
|---|
Mask(String name,
int width,
int height,
Mask.ImageType imageType)
Constructs a new mask.
|
| Modifier and Type | Method and Description |
|---|---|
void |
acceptVisitor(ProductVisitor visitor)
Accepts the given visitor.
|
protected RenderedImage |
createSourceImage()
Calls
createImage(this) in this mask's image type. |
void |
dispose()
Releases all of the resources used by this object instance and all of its owned children.
|
Color |
getImageColor() |
PropertyContainer |
getImageConfig() |
double |
getImageTransparency() |
Mask.ImageType |
getImageType() |
Shape |
getValidShape()
Gets the shape of the area where this raster data contains valid samples.
|
void |
setImageColor(Color color) |
void |
setImageTransparency(double transparency) |
void |
updateExpression(String oldExternalName,
String newExternalName)
Asks a product node to replace all occurences of and references to the node name
given by
oldExternalName with oldExternalName. |
computeStxImpl, createDefaultImageInfo, getFlagCoding, getIndexCoding, getRawStorageSize, getSampleCoding, getSolarFlux, getSpectralBandIndex, getSpectralBandwidth, getSpectralWavelength, isFlagBand, isIndexBand, readRasterData, readRasterDataFully, removeFromFile, setSampleCoding, setSolarFlux, setSpectralBandIndex, setSpectralBandwidth, setSpectralWavelength, toString, writeRasterData, writeRasterDataFullyensureMinLengthArray, ensureMinLengthArray, ensureMinLengthArray, ensureRasterData, getPixelDouble, getPixelFloat, getPixelInt, getPixels, getPixels, getPixels, getRasterHeight, getRasterWidth, loadRasterData, readPixels, readPixels, readPixels, setPixelDouble, setPixelFloat, setPixelInt, setPixels, setPixels, setPixels, unloadRasterData, writePixels, writePixels, writePixelsaddAncillaryVariable, canBeOrthorectified, checkCompatibleRasterData, clearNoDataValue, createColorIndexedImage, createCompatibleRasterData, createCompatibleRasterData, createCompatibleSceneRasterData, createDefaultImageInfo, createMultiLevelModel, createPointing, createRgbImage, createTransectProfileData, fireImageInfoChanged, getAncillaryRelations, getAncillaryVariable, getAncillaryVariables, getGeoCoding, getGeophysicalDataType, getGeophysicalImage, getGeophysicalNoDataValue, getImageInfo, getImageInfo, getImageInfo, getImageToModelTransform, getModelToSceneTransform, getMultiLevelModel, getNoDataValue, getOverlayMaskGroup, getPixels, getPixels, getPixels, getPixelString, getPointing, getRasterData, getRasterSize, getSampleFloat, getSampleInt, getScalingFactor, getScalingOffset, getSceneToModelTransform, getSourceImage, getStx, getStx, getTimeCoding, getValidMaskExpression, getValidMaskImage, getValidPixelExpression, hasIntPixels, hasRasterData, isCompatibleRasterData, isFloatingPointType, isGeophysicalImageSet, isLog10Scaled, isNoDataValueSet, isNoDataValueUsed, isPixelValid, isPixelValid, isPixelValid, isScalingApplied, isSourceImageSet, isStxSet, isValidMaskImageSet, isValidMaskProperty, isValidMaskUsed, loadRasterData, processRasterData, quantizeRasterData, quantizeRasterData, readPixels, readPixels, readPixels, readRasterData, readRasterDataFully, readValidMask, removeAncillaryVariable, resetValidMask, scale, scaleInverse, setAncillaryRelations, setGeoCoding, setGeophysicalNoDataValue, setImageInfo, setImageInfo, setImageToModelTransform, setLog10Scaled, setModelToSceneTransform, setModified, setNoDataValue, setNoDataValueUsed, setRasterData, setScalingFactor, setScalingOffset, setSceneToModelTransform, setSourceImage, setSourceImage, setStx, setTimeCoding, setValidPixelExpression, writePixels, writePixels, writePixels, writeRasterData, writeRasterDataFullycheckDataCompatibility, createCompatibleProductData, fireProductNodeDataChanged, getData, getDataElems, getDataElemSize, getDataType, getNumDataElems, getUnit, isReadOnly, isSynthetic, setData, setDataElems, setReadOnly, setSynthetic, setUnitfireProductNodeChanged, fireProductNodeChanged, getDescription, getDisplayName, getName, getOwner, getProduct, getProductReader, getProductReaderSafe, getProductRefString, getProductSafe, getProductWriter, getProductWriterSafe, getRawStorageSize, isModified, isPartOfSubset, isValidNodeName, setDescription, setName, setOwnergetExtensionpublic Mask(String name, int width, int height, Mask.ImageType imageType)
name - The new mask's name.width - The new mask's raster width.height - The new mask's raster height.imageType - The new mask's image type.public Mask.ImageType getImageType()
public PropertyContainer getImageConfig()
public Color getImageColor()
public void setImageColor(Color color)
public double getImageTransparency()
public void setImageTransparency(double transparency)
protected RenderedImage createSourceImage()
createImage(this) in this mask's image type.createSourceImage in class BandgetImageType()public void acceptVisitor(ProductVisitor visitor)
BandThe method simply calls visitor.visit(this).
acceptVisitor in class Bandvisitor - the visitor, must not be nullpublic void dispose()
BandThis 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.
public void updateExpression(String oldExternalName, String newExternalName)
oldExternalName with oldExternalName. Such references most often occur
in band arithmetic expressions.updateExpression in class RasterDataNodeoldExternalName - The old node name.newExternalName - The new node name.public Shape getValidShape()
RasterDataNodenull, if the entire raster contains valid samples.getValidShape in class RasterDataNodenull.Copyright © 2014–2017 European Space Agency (ESA). All rights reserved.