/* * 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.text.DecimalFormat; import whitebox.geospatialfiles.WhiteboxRaster; import whitebox.interfaces.WhiteboxPlugin; import whitebox.interfaces.WhiteboxPluginHost; /** * The Crispness Index (C) provides a means of quantifying the crispness, or fuzziness, of a membership probability (MP) image. * * @author Dr. John Lindsay email: jlindsay@uoguelph.ca */ public class CrispnessIndex implements WhiteboxPlugin { private WhiteboxPluginHost myHost; 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 "CrispnessIndex"; } /** * 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 "Crispness Index"; } /** * Used to retrieve a short description of what the plugin tool does. * * @return String containing the plugin's description. */ @Override public String getToolDescription() { return "Calculates the Crispness Index and is used to quantify how crisp " + "(or fuzzy) a probability image is."; } /** * Used to identify which toolboxes this plugin tool should be listed in. * * @return Array of Strings. */ @Override public String[] getToolbox() { String[] ret = { "FuzzyTools" }; 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 feedback) { if (myHost != null) { myHost.showFeedback(feedback); } else { System.out.println(feedback); } } /** * 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); } } /** * 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) { myHost.updateProgress(progressLabel, progress); } else { System.out.println(progressLabel + " " + progress + "%"); } } /** * 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) { myHost.updateProgress(progress); } else { System.out.println("Progress: " + 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 = null; int i = 0; int rows, cols; double imageTotal = 0; long imageN = 0; double imageAverage = 0; double imageTotalDeviation = 0; double crispness = 0; double z = 0; float progress = 0; int col, row; int a; if (args.length <= 0) { showFeedback("Plugin parameters have not been set."); return; } for (i = 0; i < args.length; i++) { if (i == 0) { inputHeader = args[i]; } } // check to see that the inputHeader and outputHeader are not null. if (inputHeader == null) { showFeedback("One or more of the input parameters have not been set properly."); return; } try { WhiteboxRaster image = new WhiteboxRaster(inputHeader, "r"); rows = image.getNumberRows(); cols = image.getNumberColumns(); double noData = image.getNoDataValue(); for (row = 0; row < rows; row++) { for (col = 0; col < cols; col++) { z = image.getValue(row, col); if (z != noData) { if (z < 0 || z > 1) { showFeedback("This tool should only be used with " + "membership probability images containing " + "values that range from 0 to 1."); break; } imageTotal += z; imageN++; } } if (cancelOp) { cancelOperation(); return; } progress = (float) (100f * row / (rows - 1)); updateProgress("Calculating image average:", (int) progress); } for (row = 0; row < rows; row++) { for (col = 0; col < cols; col++) { z = image.getValue(row, col); if (z != noData) { imageTotalDeviation += (z - imageAverage) * (z - imageAverage); } } if (cancelOp) { cancelOperation(); return; } progress = (float) (100f * row / (rows - 1)); updateProgress("Calculating the image total squared deviation:", (int) progress); } image.close(); double denominator; denominator = Math.pow(imageTotal * (1 - imageAverage), 2) + Math.pow(imageAverage, 2) * (imageN - imageTotal); crispness = imageTotalDeviation / denominator; DecimalFormat df; df = new DecimalFormat("0.000"); String retstr = "CRISPNESS INDEX"; retstr = retstr + "\nInput image:\t" + inputHeader; retstr = retstr + "\nCrispness (C):\t" + df.format(crispness); returnData(retstr); } 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(); } } }