Application: gvSIG desktop

/*

 * Cresques Mapping Suite. Graphic Library for constructing mapping applications.

 * 

 * Copyright (C) 2004-5. 

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 * 

 * cresques@gmail.com

 */

package org.cresques.io.raster;

import java.awt.Image;

import java.util.Hashtable;

/**

 * Filtro para raster. Ancestro de todos los filtros.

 * @author Luis W. Sevilla (sevilla_lui@gva.es)

 */

public abstract class RasterFilter implements IRasterFilter{

        protected RasterBuf         raster = null;

        protected RasterStats         stats = null;

        protected Image                 image = null;

        protected int []                 px = new int[4];

        protected int                         height = 0;

        protected int                         width = 0;

        protected Hashtable         params = new Hashtable();

        protected int                        incX = 1;

        protected int                        incY = 1;

        protected boolean                exec = true;        //Si est? a false no se ejecuta el  filtro

        /**

         * Constructor

         */

        public RasterFilter(){}

        /**

         * Aplica el filtro sobre el raster pasado pixel a pixel

         */

        public void execute() {

                pre();

                if(exec){

                        for (int y=0; y<height; y=y+incY)

                                for (int x=0; x<width; x=x+incX) {

                                        process(x, y);

                                }

                }

                post();

        }

        /**

         * Aplica el filtro sobre el raster pasado por lineas

         */

        public void executeLines() {

                if(exec){

                        for (int y=0; y<height; y++)

                                processLine(y);

                }

        }

        /**

         * A?ade un par?metro al filtro

         */

        public void addParam(String name, Object param){

                params.put(name, param);

        } 

        /**

         * Funci?n que contiene el c?digo a ejecutar antes de aplicar el filtro

         */

        abstract public void pre();

        /**

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

         */

        abstract public void post();

        /**

         * Ejecuci?n del filtro para un pixel de la imagen

         */

        abstract public void process(int x, int y);

        /**

         * Ejecuci?n del filtro para una l?nea de la imagen

         */

        abstract public void processLine(int y);

        /**

         * Obtiene el tipo de datos del raster de entrada

         */

        abstract public int getInRasterDataType();

        /**

         * Obtiene el tipo de datos del raster de salida

         */

        abstract public int getOutRasterDataType();

        /**

         * Obtiene el resultado del filtro despues de su ejecuci?n a trav?s de una clave

         * @param name        clave para obtener un objeto resultado del filtro.

         */

        abstract public Object getResult(String name);

}