org.esa.beam.framework.datamodel
Class GeneralFilterBand

java.lang.Object
  com.bc.ceres.core.ExtensibleObject
      org.esa.beam.framework.datamodel.ProductNode
          org.esa.beam.framework.datamodel.DataNode
              org.esa.beam.framework.datamodel.RasterDataNode
                  org.esa.beam.framework.datamodel.AbstractBand
                      org.esa.beam.framework.datamodel.Band
                          org.esa.beam.framework.datamodel.FilterBand
                              org.esa.beam.framework.datamodel.GeneralFilterBand

All Implemented Interfaces:

com.bc.ceres.core.Extensible, Scaling

public class GeneralFilterBand
extends FilterBand

A band that obtains its input data from an underlying source raster and filters its data using an arbitrary algorithm.

Note that this class is not yet public API and may change in future releases.

Version:

$Revision$ $Date$

Author:

Norman Fomferra

Nested Class Summary

static class	GeneralFilterBand.Max
static class	GeneralFilterBand.Mean
static class	GeneralFilterBand.Median
static class	GeneralFilterBand.Min
static interface	GeneralFilterBand.Operator An operator which performs an operation on an array of pixel values extracted from a raster sub-window.
static class	GeneralFilterBand.RootMeanSquare
static class	GeneralFilterBand.StandardDeviation

Nested classes/interfaces inherited from class org.esa.beam.framework.datamodel.RasterDataNode

RasterDataNode.RasterDataDoubleList, RasterDataNode.RasterDataProcessor

Field Summary

static GeneralFilterBand.Operator	MAX
static GeneralFilterBand.Operator	MEAN
static GeneralFilterBand.Operator	MEDIAN
static GeneralFilterBand.Operator	MIN
static GeneralFilterBand.Operator	RMS
static GeneralFilterBand.Operator	STDDEV

Fields inherited from class org.esa.beam.framework.datamodel.Band

PROPERTY_NAME_SAMPLE_CODING, PROPERTY_NAME_SOLAR_FLUX, PROPERTY_NAME_SPECTRAL_BAND_INDEX, PROPERTY_NAME_SPECTRAL_BANDWIDTH, PROPERTY_NAME_SPECTRAL_WAVELENGTH

Fields inherited from class org.esa.beam.framework.datamodel.AbstractBand

VIEW_MODE_FORWARD, VIEW_MODE_NADIR, VIEW_MODE_ORTHO

Fields inherited from class org.esa.beam.framework.datamodel.RasterDataNode

INVALID_POS_TEXT, IO_ERROR_TEXT, NO_DATA_TEXT, NOT_LOADED_TEXT, PROPERTY_NAME_GEOCODING, PROPERTY_NAME_IMAGE_INFO, PROPERTY_NAME_LOG_10_SCALED, PROPERTY_NAME_NO_DATA_VALUE, PROPERTY_NAME_NO_DATA_VALUE_USED, PROPERTY_NAME_ROI_DEFINITION, PROPERTY_NAME_SCALING_FACTOR, PROPERTY_NAME_SCALING_OFFSET, PROPERTY_NAME_STX, PROPERTY_NAME_VALID_PIXEL_EXPRESSION

Fields inherited from class org.esa.beam.framework.datamodel.DataNode

PROPERTY_NAME_DATA, PROPERTY_NAME_READ_ONLY, PROPERTY_NAME_SYNTHETIC, PROPERTY_NAME_UNIT

Fields inherited from class org.esa.beam.framework.datamodel.ProductNode

PROPERTY_NAME_DESCRIPTION, PROPERTY_NAME_NAME

Fields inherited from interface org.esa.beam.framework.datamodel.Scaling

IDENTITY

Constructor Summary

GeneralFilterBand(String name, RasterDataNode source, int subWindowSize, GeneralFilterBand.Operator operator)
Creates a GeneralFilterBand.

GeneralFilterBand(String name, RasterDataNode source, int subWindowWidth, int subWindowHeight, GeneralFilterBand.Operator operator)
Deprecated. since BEAM 4.5; non square windows are not supported, use GeneralFilterBand(String, RasterDataNode, int, Operator). It is currently implemented by delegating to the other constructor using subWindowWidth as subWindowSize.

Method Summary

static GeneralFilterBand.Operator	createOperator(String operatorClassName) Creates an instance GeneralFilterBand.Operator by the given class name
protected RenderedImage	createSourceImage() Creates the source image associated with this RasterDataNode.
GeneralFilterBand.Operator	getOperator()
int	getSubWindowHeight() Deprecated. since BEAM 4.5, use getSubWindowSize()
int	getSubWindowSize()
int	getSubWindowWidth() Deprecated. since BEAM 4.5, use getSubWindowSize()

Methods inherited from class org.esa.beam.framework.datamodel.FilterBand

dispose, getSource, writeRasterData

Methods inherited from class org.esa.beam.framework.datamodel.Band

acceptVisitor, computeStxImpl, createDefaultImageInfo, getFlagCoding, getIndexCoding, getRawStorageSize, getSampleCoding, getSolarFlux, getSpectralBandIndex, getSpectralBandwidth, getSpectralWavelength, isFlagBand, isIndexBand, readRasterData, readRasterDataFully, removeFromFile, setSampleCoding, setSolarFlux, setSpectralBandIndex, setSpectralBandwidth, setSpectralWavelength, toString, writeRasterDataFully

Methods inherited from class org.esa.beam.framework.datamodel.AbstractBand

computeBand, ensureMinLengthArray, ensureMinLengthArray, ensureMinLengthArray, ensureRasterData, getPixelDouble, getPixelFloat, getPixelInt, getPixels, getPixels, getPixels, getSceneRasterData, getViewModeId, loadRasterData, readPixels, readPixels, readPixels, setPixelDouble, setPixelFloat, setPixelInt, setPixels, setPixels, setPixels, unloadRasterData, writePixels, writePixels, writePixels

Methods inherited from class org.esa.beam.framework.datamodel.RasterDataNode

canBeOrthorectified, checkCompatibleRasterData, clearNoDataValue, createColorIndexedImage, createCompatibleRasterData, createCompatibleRasterData, createCompatibleSceneRasterData, createDefaultImageInfo, createPixelValidator, createPointing, createRgbImage, createTransectProfileData, fireImageInfoChanged, getBitmaskDefs, getGeoCoding, getGeophysicalDataType, getGeophysicalImage, getGeophysicalNoDataValue, getImageInfo, getImageInfo, getImageInfo, getNoDataValue, getOverlayMaskGroup, getPixels, getPixels, getPixels, getPixelString, getPointing, getRasterData, getRasterHeight, getRasterWidth, getRoiMaskGroup, getSampleFloat, getSampleInt, getScalingFactor, getScalingOffset, getSceneRasterHeight, getSceneRasterWidth, getSourceImage, getStx, getStx, getValidMaskExpression, getValidMaskImage, getValidPixelExpression, getValidShape, 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, resetValidMask, scale, scaleInverse, setGeoCoding, setGeophysicalNoDataValue, setImageInfo, setImageInfo, setLog10Scaled, setModified, setNoDataValue, setNoDataValueUsed, setRasterData, setScalingFactor, setScalingOffset, setSourceImage, setSourceImage, setStx, setValidPixelExpression, updateExpression, writePixels, writePixels, writePixels, writeRasterData, writeRasterDataFully

Methods inherited from class org.esa.beam.framework.datamodel.DataNode

checkDataCompatibility, createCompatibleProductData, fireProductNodeDataChanged, getData, getDataElems, getDataElemSize, getDataType, getNumDataElems, getUnit, isReadOnly, isSynthetic, setData, setDataElems, setReadOnly, setSynthetic, setUnit

Methods inherited from class org.esa.beam.framework.datamodel.ProductNode

fireProductNodeChanged, fireProductNodeChanged, getDescription, getDisplayName, getName, getOwner, getProduct, getProductReader, getProductReaderSafe, getProductRefString, getProductSafe, getProductWriter, getProductWriterSafe, getRawStorageSize, isModified, isPartOfSubset, isValidNodeName, setDescription, setName, setOwner

Methods inherited from class com.bc.ceres.core.ExtensibleObject

getExtension

Methods inherited from class java.lang.Object

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

Field Detail

MIN

public static final GeneralFilterBand.Operator MIN

MAX

public static final GeneralFilterBand.Operator MAX

MEDIAN

public static final GeneralFilterBand.Operator MEDIAN

MEAN

public static final GeneralFilterBand.Operator MEAN

STDDEV

public static final GeneralFilterBand.Operator STDDEV

RMS

public static final GeneralFilterBand.Operator RMS

Constructor Detail

GeneralFilterBand

@Deprecated
public GeneralFilterBand(String name,
                                    RasterDataNode source,
                                    int subWindowWidth,
                                    int subWindowHeight,
                                    GeneralFilterBand.Operator operator)

Deprecated. since BEAM 4.5; non square windows are not supported, use GeneralFilterBand(String, RasterDataNode, int, Operator). It is currently implemented by delegating to the other constructor using subWindowWidth as subWindowSize.

Creates a GeneralFilterBand.

Parameters:

name - the name of the band.

source - the source which shall be filtered.

subWindowWidth - the window width used by the filter

subWindowHeight - the window height used by the filter

operator - the operator which performs the filter operation

GeneralFilterBand

public GeneralFilterBand(String name,
                         RasterDataNode source,
                         int subWindowSize,
                         GeneralFilterBand.Operator operator)

Creates a GeneralFilterBand.

Parameters:

name - the name of the band.

source - the source which shall be filtered.

subWindowSize - the window size (width/height) used by the filter

operator - the operator which performs the filter operation

Method Detail

createSourceImage

protected RenderedImage createSourceImage()

Description copied from class: RasterDataNode

Creates the source image associated with this RasterDataNode. This shall preferably be a MultiLevelImage instance.

Overrides:

createSourceImage in class Band

Returns:

A new source image instance.

createOperator

public static GeneralFilterBand.Operator createOperator(String operatorClassName)

Creates an instance GeneralFilterBand.Operator by the given class name

Parameters:

operatorClassName - the class name

Returns:

instance of GeneralFilterBand.Operator

getSubWindowSize

public int getSubWindowSize()

getSubWindowWidth

@Deprecated
public int getSubWindowWidth()

Deprecated. since BEAM 4.5, use getSubWindowSize()

Returns:

return the width of the sub window.

getSubWindowHeight

@Deprecated
public int getSubWindowHeight()

Deprecated. since BEAM 4.5, use getSubWindowSize()

Returns:

return the height of the sub window.

getOperator

public GeneralFilterBand.Operator getOperator()