WatershedTool.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS 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 3 of the License, or (at your option) any later
 * version.
 *
 * OrbisGIS 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
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.view.map.tools.raster;

import com.vividsolutions.jts.geom.Coordinate;
import com.vividsolutions.jts.geom.Point;
import ij.ImagePlus;
import java.awt.geom.Point2D;
import java.io.File;
import java.io.IOException;
import java.util.Observable;
import javax.swing.ImageIcon;
import org.apache.log4j.Logger;
import org.gdms.data.DataSource;
import org.gdms.data.DataSourceFactory;
import org.gdms.driver.DriverException;
import org.gdms.driver.driverManager.DriverLoadException;
import org.grap.model.GeoRaster;
import org.grap.processing.Operation;
import org.grap.processing.OperationException;
import org.grap.processing.operation.hydrology.D8OpDirection;
import org.grap.processing.operation.hydrology.D8OpWatershedFromOutletIndex;
import org.orbisgis.core.DataManager;
import org.orbisgis.core.Services;
import org.orbisgis.coremap.layerModel.ILayer;
import org.orbisgis.coremap.layerModel.LayerException;
import org.orbisgis.coremap.layerModel.MapContext;
import org.orbisgis.view.icons.OrbisGISIcon;
import org.orbisgis.view.map.tool.ToolManager;
import org.orbisgis.view.map.tool.TransitionException;
import org.orbisgis.view.map.tools.AbstractPointTool;

public class WatershedTool extends AbstractPointTool {
        private static Logger UILOGGER = Logger.getLogger("gui."+WatershedTool.class);
	
        
        
        public boolean isEnabled(MapContext vc, ToolManager tm) {
		try {
            if ((vc.getSelectedLayers().length == 1)
                            && vc.getSelectedLayers()[0].isRaster()
                            && vc.getSelectedLayers()[0].isVisible()) {
                    final int type = vc.getSelectedLayers()[0].getRaster()
                                    .getType();
                    return (type == ImagePlus.GRAY16) || (type == ImagePlus.GRAY32);
            }
		} catch (DriverException e) {
            UILOGGER.error(e.getLocalizedMessage(),e);
		} catch (IOException e) {
            UILOGGER.error(e.getLocalizedMessage(),e);
		}
            return false;
	}

	public boolean isVisible(MapContext vc, ToolManager tm) {
		return true;
	}

	private int fromRealWorldCoordinateToOutletIndex(final GeoRaster geoRaster,
			final Coordinate realWorldCoordinate) throws IOException {
		final Point2D pixelGridCoord = geoRaster.fromRealWorldToPixel(
				realWorldCoordinate.x, realWorldCoordinate.y);
		final int pixelX = (int) pixelGridCoord.getX();
		final int pixelY = (int) pixelGridCoord.getY();
		return pixelY * geoRaster.getWidth() + pixelX;
	}

	@Override
	protected void pointDone(Point point, MapContext vc, ToolManager tm)
			throws TransitionException {
		try {
			final GeoRaster geoRaster = vc.getSelectedLayers()[0].getRaster();
			final Coordinate realWorldCoordinate = point.getCoordinate();

			final int outletIndex = fromRealWorldCoordinateToOutletIndex(
					geoRaster, realWorldCoordinate);

			if ((outletIndex >= 0)
					&& (outletIndex < geoRaster.getMetadata().getNRows()
							* geoRaster.getMetadata().getNCols())) {
				// compute the slopes directions
				final Operation slopesDirections = new D8OpDirection();
				final GeoRaster grSlopesDirections = geoRaster
						.doOperation(slopesDirections);

				// find the good watershed starting from the outletIndex
				final Operation watershedFromOutletIndex = new D8OpWatershedFromOutletIndex(
						outletIndex);
				final GeoRaster grWatershedFromOutletIndex = grSlopesDirections
						.doOperation(watershedFromOutletIndex);

				DataManager dataManager = Services.getService(DataManager.class);
				// save the computed GeoRaster in a tempFile
				final DataSourceFactory dsf = dataManager.getDataSourceFactory();
				final String tempFile = dsf.getTempFile() + ".tif"; 
				grWatershedFromOutletIndex.save(tempFile);

				// populate the GeoView TOC with a new RasterLayer
                DataSource newSource = dataManager.getDataSource(dataManager.getSourceManager().nameAndRegister(new File(tempFile)));
				vc.getLayerModel().insertLayer(vc.createLayer(newSource), 0);
			}
		} catch (IOException e) {
			UILOGGER.error(i18n.tr("Problem to access the GeoRaster"), //$NON-NLS-1$
					e);
		} catch (LayerException e) {
			UILOGGER.error(i18n.tr("Problem adding the new layer"), e); //$NON-NLS-1$
		} catch (OperationException e) {
			UILOGGER.error(
					i18n.tr("Operation error with the GeoRaster"), e); //$NON-NLS-1$
		} catch (DriverLoadException e) {
			UILOGGER.error(
					i18n.tr("Cannot create the resulting layer of raster type"), e); //$NON-NLS-1$
		} catch (Exception e) {
			UILOGGER.error(i18n.tr("Problem to access the GeoRaster"), //$NON-NLS-1$
					e);
		}
	}
	@Override
	public void update(Observable o, Object arg) {
		//PlugInContext.checkTool(this);
	}

        @Override
	public String getName() {
		return i18n.tr("Compute a watershed");
	}

    @Override
    public String getTooltip() {
        return i18n.tr("Compute a watershed");
    }

    @Override
        public ImageIcon getImageIcon() {
            return OrbisGISIcon.getIcon("wizard");
        }
}