/* * Copyright (C) 2011-2012 Dr. John Lindsay <jlindsay@uoguelph.ca> * * 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 3 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, see <http://www.gnu.org/licenses/>. */ package plugins; import java.io.File; import whitebox.geospatialfiles.ShapeFile; import whitebox.geospatialfiles.WhiteboxRaster; import whitebox.geospatialfiles.shapefile.attributes.DBFField; import whitebox.geospatialfiles.shapefile.attributes.DBFWriter; import whitebox.geospatialfiles.shapefile.ShapeType; import whitebox.interfaces.WhiteboxPlugin; import whitebox.interfaces.WhiteboxPluginHost; /** * Converts a raster dataset to a shapefile of the Point shapetype. * * @author Dr. John Lindsay email: jlindsay@uoguelph.ca */ public class RasterToVectorPoints implements WhiteboxPlugin { private WhiteboxPluginHost myHost = null; private String[] args; /** * Used to retrieve the plugin tool's name. This is a short, unique name * containing no spaces. * * @return String containing plugin name. */ @Override public String getName() { return "RasterToVectorPoints"; } /** * Used to retrieve the plugin tool's descriptive name. This can be a longer * name (containing spaces) and is used in the interface to list the tool. * * @return String containing the plugin descriptive name. */ @Override public String getDescriptiveName() { return "Raster To Vector Points"; } /** * Used to retrieve a short description of what the plugin tool does. * * @return String containing the plugin's description. */ @Override public String getToolDescription() { return "Converts a raster containing points into a vector."; } /** * Used to identify which toolboxes this plugin tool should be listed in. * * @return Array of Strings. */ @Override public String[] getToolbox() { String[] ret = { "RasterVectorConversions" }; return ret; } /** * Sets the WhiteboxPluginHost to which the plugin tool is tied. This is the * class that the plugin will send all feedback messages, progress updates, * and return objects. * * @param host The WhiteboxPluginHost that called the plugin tool. */ @Override public void setPluginHost(WhiteboxPluginHost host) { myHost = host; } /** * Used to communicate feedback pop-up messages between a plugin tool and * the main Whitebox user-interface. * * @param feedback String containing the text to display. */ private void showFeedback(String message) { if (myHost != null) { myHost.showFeedback(message); } else { System.out.println(message); } } /** * Used to communicate a return object from a plugin tool to the main * Whitebox user-interface. * * @return Object, such as an output WhiteboxRaster. */ private void returnData(Object ret) { if (myHost != null) { myHost.returnData(ret); } } private int previousProgress = 0; private String previousProgressLabel = ""; /** * Used to communicate a progress update between a plugin tool and the main * Whitebox user interface. * * @param progressLabel A String to use for the progress label. * @param progress Float containing the progress value (between 0 and 100). */ private void updateProgress(String progressLabel, int progress) { if (myHost != null && ((progress != previousProgress) || (!progressLabel.equals(previousProgressLabel)))) { myHost.updateProgress(progressLabel, progress); } previousProgress = progress; previousProgressLabel = progressLabel; } /** * Used to communicate a progress update between a plugin tool and the main * Whitebox user interface. * * @param progress Float containing the progress value (between 0 and 100). */ private void updateProgress(int progress) { if (myHost != null && progress != previousProgress) { myHost.updateProgress(progress); } previousProgress = progress; } /** * Sets the arguments (parameters) used by the plugin. * * @param args An array of string arguments. */ @Override public void setArgs(String[] args) { this.args = args.clone(); } private boolean cancelOp = false; /** * Used to communicate a cancel operation from the Whitebox GUI. * * @param cancel Set to true if the plugin should be canceled. */ @Override public void setCancelOp(boolean cancel) { cancelOp = cancel; } private void cancelOperation() { showFeedback("Operation cancelled."); updateProgress("Progress: ", 0); } private boolean amIActive = false; /** * Used by the Whitebox GUI to tell if this plugin is still running. * * @return a boolean describing whether or not the plugin is actively being * used. */ @Override public boolean isActive() { return amIActive; } /** * Used to execute this plugin tool. */ @Override public void run() { amIActive = true; String inputHeader; String outputFileName; int row, col, x, y; double xCoord, yCoord, value; int progress; if (args.length <= 0) { showFeedback("Plugin parameters have not been set."); return; } inputHeader = args[0]; outputFileName = args[1]; // check to see that the inputHeader and outputHeader are not null. if ((inputHeader == null) || (outputFileName == null)) { showFeedback("One or more of the input parameters have not been set properly."); return; } try { WhiteboxRaster inputRaster = new WhiteboxRaster(inputHeader, "r"); int rows = inputRaster.getNumberRows(); int cols = inputRaster.getNumberColumns(); // set up the output files of the shapefile and the dbf ShapeFile output = new ShapeFile(outputFileName, ShapeType.POINT); DBFField fields[] = new DBFField[2]; fields[0] = new DBFField(); fields[0].setName("FID"); fields[0].setDataType(DBFField.DBFDataType.NUMERIC); fields[0].setFieldLength(10); fields[0].setDecimalCount(0); fields[1] = new DBFField(); fields[1].setName("VALUE"); fields[1].setDataType(DBFField.DBFDataType.NUMERIC); fields[1].setFieldLength(10); fields[1].setDecimalCount(3); String DBFName = output.getDatabaseFile(); DBFWriter writer = new DBFWriter(new File(DBFName)); /* this DBFWriter object is now in Syc Mode */ writer.setFields(fields); int FID = 0; for (row = 0; row < rows; row++) { for (col = 0; col < cols; col++) { value = inputRaster.getValue(row, col); if (value > 0) { FID++; xCoord = inputRaster.getXCoordinateFromColumn(col); yCoord = inputRaster.getYCoordinateFromRow(row); whitebox.geospatialfiles.shapefile.Point pnt = new whitebox.geospatialfiles.shapefile.Point(xCoord, yCoord); output.addRecord(pnt); Object[] rowData = new Object[2]; rowData[0] = new Double(FID); rowData[1] = new Double(value); writer.addRecord(rowData); } } if (cancelOp) { cancelOperation(); return; } progress = (int)(100f * row / (rows - 1)); updateProgress(progress); } output.write(); writer.write(); inputRaster.close(); // returning a header file string displays the image. returnData(outputFileName); } catch (OutOfMemoryError oe) { myHost.showFeedback("An out-of-memory error has occurred during operation."); } catch (Exception e) { myHost.showFeedback("An error has occurred during operation. See log file for details."); myHost.logException("Error in " + getDescriptiveName(), e); } finally { updateProgress("Progress: ", 0); // tells the main application that this process is completed. amIActive = false; myHost.pluginComplete(); } } // // This method is only used during testing. // public static void main(String[] args) { // args = new String[3]; // args[0] = "/Users/johnlindsay/Documents/Data/tmp4.dep"; // args[1] = "/Users/johnlindsay/Documents/Data/tmp4.shp"; // // RasterToVectorPoints rtvp = new RasterToVectorPoints(); // rtvp.setArgs(args); // rtvp.run(); // } }