org.gvsig.fmap.dal.coverage.grid.filter

Class BaseRasterFilter

java.lang.Object

org.gvsig.fmap.dal.coverage.grid.filter.BaseRasterFilter

All Implemented Interfaces:

java.lang.Cloneable, RasterFilter

Direct Known Subclasses:

BrightnessFilter, ColorBalanceCMYFilter, ColorBalanceRGBFilter, ColorTableFilter, ContrastFilter, ConvolutionFilter, EqualizationFilter, FirstDerivativeFilter, GrayScaleFilter, GrayScaleFilter, HistogramMatchingFilter, HSLToRGBFilter, LinearEnhancementFilter, LinearStretchEnhancementFilter, MaskFilter, MedianFilter, ModeFilter, PanSharpeningFilter, RegionAlphaFilter, RGBToCMYKFilter, RGBToHSLFilter, TailTrimFilter, ToLumSaFilter

public abstract class BaseRasterFilter
extends java.lang.Object
implements RasterFilter, java.lang.Cloneable

Base class for all filters

Field Summary

Fields

Modifier and Type	Field and Description
protected ColorInterpretation	colorInterpretation
protected java.util.TreeMap<java.lang.String,java.lang.Object>	environment
protected boolean	exec Variable que control la aplicación o no del filtro.
protected Extent	extent
protected int	height
protected java.lang.String	managername
protected int	nBandsToProcess
protected java.util.Hashtable<java.lang.String,java.lang.Object>	params
static java.lang.String	PERSISTENT_DESCRIPTION
static java.lang.String	PERSISTENT_NAME
protected Buffer	raster
protected Buffer	rasterResult
protected TaskEventManager	taskEventManager
protected Transparency	transparency
protected RasterUtils	util
protected int	width

Fields inherited from interface org.gvsig.fmap.dal.coverage.grid.RasterFilter

RESULT_BUFFER, RESULT_TRANSPARENCY

Constructor Summary

Constructors

Constructor and Description
BaseRasterFilter() Constructor

Method Summary

Modifier and Type	Method and Description
void	addParam(java.lang.String name, java.lang.Object param) Añade un parámetro al filtro
java.lang.Object	clone()
protected void	createARGBBufferResult()
protected void	createBufferResult(int dataType, int bandCount)
void	dispose() Releases buffer resources
void	execute() Aplica el filtro sobre el raster pasado pixel a pixel
protected void	finalize()
protected ColorInterpretation	getColorInterpretation()
java.util.TreeMap<java.lang.String,java.lang.Object>	getEnv() Obtiene el TreeMap con los parámetros del entorno
abstract java.lang.String	getGroup() Obtiene el grupo del filtro
protected Buffer	getInputBuffer()
abstract int	getInRasterDataType() Obtiene el tipo de datos del raster de entrada
java.lang.String	getManagerName() Gets the manager name
java.lang.String	getName() Devuelve el nombre interno del filtro
abstract java.lang.String[]	getNames() Gets the list of specific filter names.
protected Buffer	getOutputBuffer()
abstract int	getOutRasterDataType() Obtiene el tipo de datos del raster de salida
java.lang.Object	getParam(java.lang.String name) Obtiene un parámetro a partir de la clave
java.util.Hashtable<java.lang.String,java.lang.Object>	getParams() Gets the param list
int	getPercent() Obtiene el porcentaje recorrido del proceso de filtrado
java.lang.Object	getResult(java.lang.String name) Gets the result of this filter
abstract Params	getUIParams(java.lang.String nameFilter) Obtener que datos puede tratar una interfaz con sus valores
protected boolean	hasInputTransparency()
boolean	isExec() Obtiene true si el filtro va a ser ejecutado o false si no va a serlo
boolean	isToConvertToRGB() Returns true if this filter is to conver the input buffer to RGB.
boolean	isVisible() Devolverá un booleano indicando si es visible o no en el panel de filtros.
protected int	numberOfBandsToProcess()
abstract void	post() Función que contiene el código a ejecutar despues de aplicar el filtro
void	pre() Code to execute before apply a filter
abstract void	process(int x, int y) Ejecución del filtro para un pixel de la imagen
void	removeParam(java.lang.String name) Elimina un parámetro del filtro
void	resetPercent() Pone a cero el contador del porcentaje del proceso de filtrado
void	setEnv(java.util.TreeMap<java.lang.String,java.lang.Object> env) Asigna el TreeMap con los parámetros del entorno
void	setExec(boolean exec) Asigna el valor a la variable exec.
void	setExtent(Extent extent)
void	setName(java.lang.String name)
void	setParams(java.util.Hashtable<java.lang.String,java.lang.Object> params) Gets the param list
protected void	writeAlphaBand(int line, int col) Copies the alpha band from the input raster to the output.

Methods inherited from class java.lang.Object

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

Field Detail

PERSISTENT_NAME

public static final java.lang.String PERSISTENT_NAME

See Also:

Constant Field Values

PERSISTENT_DESCRIPTION

public static final java.lang.String PERSISTENT_DESCRIPTION

See Also:

Constant Field Values

raster

protected Buffer raster

rasterResult

protected Buffer rasterResult

height

protected int height

width

protected int width

params

protected java.util.Hashtable<java.lang.String,java.lang.Object> params

environment

protected java.util.TreeMap<java.lang.String,java.lang.Object> environment

extent

protected Extent extent

exec

protected boolean exec

Variable que control la aplicación o no del filtro. Si está a false aunque esté en la pila el filtro no se ejecutará.

util

protected RasterUtils util

taskEventManager

protected TaskEventManager taskEventManager

managername

protected java.lang.String managername

transparency

protected Transparency transparency

nBandsToProcess

protected int nBandsToProcess

colorInterpretation

protected ColorInterpretation colorInterpretation

Constructor Detail

BaseRasterFilter

public BaseRasterFilter()

Constructor

Method Detail

execute

public void execute()
             throws ProcessInterruptedException,
                    FilterAddException

Aplica el filtro sobre el raster pasado pixel a pixel

Specified by:

execute in interface RasterFilter

Throws:

ProcessInterruptedException

FilterAddException

addParam

public void addParam(java.lang.String name,
                     java.lang.Object param)

Añade un parámetro al filtro

Specified by:

addParam in interface RasterFilter

Parameters:

name - Clave del parámetro

param - Objeto pasado como parámetro

removeParam

public void removeParam(java.lang.String name)

Elimina un parámetro del filtro

Parameters:

name - Clave del parámetro a eliminar

getParam

public java.lang.Object getParam(java.lang.String name)

Obtiene un parámetro a partir de la clave

Specified by:

getParam in interface RasterFilter

Parameters:

name - Parámetro

Returns:

Parámetro

getParams

public java.util.Hashtable<java.lang.String,java.lang.Object> getParams()

Description copied from interface: RasterFilter

Gets the param list

Specified by:

getParams in interface RasterFilter

Returns:

setParams

public void setParams(java.util.Hashtable<java.lang.String,java.lang.Object> params)

Description copied from interface: RasterFilter

Gets the param list

Specified by:

setParams in interface RasterFilter

setExtent

public void setExtent(Extent extent)

isToConvertToRGB

public boolean isToConvertToRGB()

Description copied from interface: RasterFilter

Returns true if this filter is to conver the input buffer to RGB. This kind of filters will be in the top of the stack because all others need as input a RGB data buffer

Specified by:

isToConvertToRGB in interface RasterFilter

Returns:

isExec

public boolean isExec()

Obtiene true si el filtro va a ser ejecutado o false si no va a serlo

Returns:

setExec

public void setExec(boolean exec)

Asigna el valor a la variable exec. Esta estará a true si el filtro se ejecutará la próxima vez que se repinte o false si no se ejecuta.

Parameters:

exec -

resetPercent

public void resetPercent()

Pone a cero el contador del porcentaje del proceso de filtrado

getPercent

public int getPercent()

Obtiene el porcentaje recorrido del proceso de filtrado

Returns:

post

public abstract void post()

Función que contiene el código a ejecutar despues de aplicar el filtro

Specified by:

post in interface RasterFilter

process

public abstract void process(int x,
                             int y)

Ejecución del filtro para un pixel de la imagen

Specified by:

process in interface RasterFilter

Parameters:

x - posición X

y - posición Y

getInRasterDataType

public abstract int getInRasterDataType()

Obtiene el tipo de datos del raster de entrada

Specified by:

getInRasterDataType in interface RasterFilter

Returns:

Tipo de dato

getOutRasterDataType

public abstract int getOutRasterDataType()

Obtiene el tipo de datos del raster de salida

Specified by:

getOutRasterDataType in interface RasterFilter

Returns:

Tipo de dato

getResult

public java.lang.Object getResult(java.lang.String name)

Gets the result of this filter

Specified by:

getResult in interface RasterFilter

Returns:

getGroup

public abstract java.lang.String getGroup()

Description copied from interface: RasterFilter

Obtiene el grupo del filtro

Specified by:

getGroup in interface RasterFilter

Returns:

getUIParams

public abstract Params getUIParams(java.lang.String nameFilter)

Description copied from interface: RasterFilter

Obtener que datos puede tratar una interfaz con sus valores

Specified by:

getUIParams in interface RasterFilter

Returns:

getNames

public abstract java.lang.String[] getNames()

Description copied from interface: RasterFilter

Gets the list of specific filter names. Each kind of filter can have a list of specific types. This function returns the names of this filters

Specified by:

getNames in interface RasterFilter

Returns:

isVisible

public boolean isVisible()

Description copied from interface: RasterFilter

Devolverá un booleano indicando si es visible o no en el panel de filtros.

Specified by:

isVisible in interface RasterFilter

Returns:

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getName

public java.lang.String getName()

Description copied from interface: RasterFilter

Devuelve el nombre interno del filtro

Specified by:

getName in interface RasterFilter

Returns:

the fName

setName

public void setName(java.lang.String name)

Specified by:

setName in interface RasterFilter

Parameters:

name - the fName to set

getEnv

public java.util.TreeMap<java.lang.String,java.lang.Object> getEnv()

Description copied from interface: RasterFilter

Obtiene el TreeMap con los parámetros del entorno

Specified by:

getEnv in interface RasterFilter

Returns:

TreeMap

setEnv

public void setEnv(java.util.TreeMap<java.lang.String,java.lang.Object> env)

Description copied from interface: RasterFilter

Asigna el TreeMap con los parámetros del entorno

Specified by:

setEnv in interface RasterFilter

getManagerName

public java.lang.String getManagerName()

Description copied from interface: RasterFilter

Gets the manager name

Specified by:

getManagerName in interface RasterFilter

Returns:

dispose

public void dispose()

Releases buffer resources

getOutputBuffer

protected Buffer getOutputBuffer()

getInputBuffer

protected Buffer getInputBuffer()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

pre

public void pre()
         throws FilterAddException

Code to execute before apply a filter

Specified by:

pre in interface RasterFilter

Throws:

FilterAddException

createARGBBufferResult

protected void createARGBBufferResult()
                               throws FilterAddException

Throws:

FilterAddException

createBufferResult

protected void createBufferResult(int dataType,
                                  int bandCount)
                           throws FilterAddException

Throws:

FilterAddException

writeAlphaBand

protected void writeAlphaBand(int line,
                              int col)

Copies the alpha band from the input raster to the output. In most filters, this band is not processed and it will copy it directly in the output

hasInputTransparency

protected boolean hasInputTransparency()

numberOfBandsToProcess

protected int numberOfBandsToProcess()

getColorInterpretation

protected ColorInterpretation getColorInterpretation()