Application: gvSIG desktop » gvSIG raster

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.raster.tools.app.basic.tool.filter.mask;

import java.util.ArrayList;

import org.gvsig.fmap.dal.coverage.RasterLocator;

import org.gvsig.fmap.dal.coverage.datastruct.Extent;

import org.gvsig.fmap.dal.coverage.datastruct.NoData;

import org.gvsig.fmap.dal.coverage.datastruct.Params;

import org.gvsig.fmap.dal.coverage.exception.FilterAddException;

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

import org.gvsig.raster.fmap.layers.FLyrRaster;

import org.gvsig.raster.roi.ROI;

/**

 * Filtro que aplica una m?scara con la lista de ROIS. Los p?xeles dentro

 * de la ROI se ponen al valor de la imagen de origen. Los p?xeles fuera

 * de la ROI se ponen a NoData.

 * 

 * @author Nacho Brodin nachobrodin@gmail.com

 * @deprecated Exists a plugin with a process which include this functionality

 */

public class MaskFilter extends BaseRasterFilter {

        public static String[]         names            = new String[] { "mask" };

        protected MaskUI               maskUI           = null;

        protected ArrayList<ROI>       rois             = null;

        protected boolean              inverse          = false;

        //Extent de la ventana de datos y de la imagen completa.

        protected Extent               bufferExtent     = null;

        protected NoData               noData           = null;

        protected double               cellsize         = 0D;

        /**

         * Constructor

         */

        public MaskFilter() {

                super();

                setName(names[0]);

        }

        public String getGroup() {

                return "mascaras";

        }

        public String[] getNames() {

                return names;

        }

        public Params getUIParams(String nameFilter) {

                Params params = RasterLocator.getManager().createParams(

                                "Panel", 

                                getMaskUI(), 

                                -1, 

                                null);

                params.setParam(

                                "FilterName", 

                                nameFilter, 

                                -1, 

                                null);

                return params;

        }

        /**

         * Obtiene el interfaz gr?fico para el filtro de m?scara.

         * @return MaskUI

         */

        private MaskUI getMaskUI() {

                if (maskUI == null) {

                        maskUI = new MaskUI();

                        FLyrRaster raster = (FLyrRaster) getEnv().get("initRaster");

                        maskUI.setRois(rois);

                        maskUI.setLayer(raster);

                }

                return maskUI;

        }

        @SuppressWarnings("unchecked")

        public void pre() throws FilterAddException {

                super.pre();

                Boolean inverseBoolean = (Boolean)params.get("inverse");

                if(inverseBoolean != null)

                        inverse = inverseBoolean.booleanValue();

                rois = (ArrayList<ROI>) params.get("rois");

                if(raster.getDataExtent() == null)

                        throw new FilterAddException("Buffer extension cannot be null");

                bufferExtent = RasterLocator.getManager().getDataStructFactory().createExtent(raster.getDataExtent());

                cellsize = raster.getDataExtent().getWidth() / raster.getWidth();

                createBufferResult(raster.getDataType(), raster.getBandCount());

        }

        public void process(int x, int y) {

        }

        public void post() {

                rasterResult.setNoDataValue(noData);

        }

        public int getInRasterDataType() {return 0;}

        public int getOutRasterDataType() {return 0;}

}