/*
* 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.util.ArrayList;
import java.util.Date;
import whitebox.geospatialfiles.WhiteboxRaster;
import whitebox.interfaces.WhiteboxPlugin;
import whitebox.interfaces.WhiteboxPluginHost;
/**
* This tool performs a weighted summation on multiple input images.
* @author johnlindsay
*/
public class WeightedSum 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 "WeightedSum";
}
/**
* 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 "Weighted Sum";
}
/**
* Used to retrieve a short description of what the plugin tool does.
* @return String containing the plugin's description.
*/
@Override
public String getToolDescription() {
return "Performs a weighted sum on multiple input raster images.";
}
/**
* Used to identify which toolboxes this plugin tool should be listed in.
* @return Array of Strings.
*/
@Override
public String[] getToolbox() {
String[] ret = { "OverlayTools" };
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 outputHeader = null;
WhiteboxRaster image = null;
WhiteboxRaster output = null;
int row, col;
int nRows, nCols;
double z;
int progress = 0;
int i, a;
double noData = -32768;
double outputNoData = -32768;
String inputDataString = null;
int numImages = 0;
double sumOfWeights = 0;
double d = 0;
double weight = 0;
if (args.length <= 0) {
showFeedback("Plugin parameters have not been set.");
return;
}
String[] dataSplit = args[0].split(";");
outputHeader = args[1];
// check to see that the inputHeader and outputHeader are not null.
if (outputHeader == null) {
showFeedback("One or more of the input parameters have not been set properly.");
return;
}
ArrayList<String> imageFiles = new ArrayList<>();
ArrayList<Double> weights = new ArrayList<>();
for (a = 0; a < dataSplit.length; a += 2) {
if (!dataSplit[a].trim().equals("") &&
!dataSplit[a].trim().toLowerCase().equals("not specified")) {
imageFiles.add(dataSplit[a]);
weights.add(Double.parseDouble(dataSplit[a + 1]));
sumOfWeights += weights.get(numImages);
numImages++;
}
}
for (a = 0; a < numImages; a++) {
d = weights.get(a) / sumOfWeights;
weights.set(a, d);
}
try {
image = new WhiteboxRaster(imageFiles.get(0), "r");
nRows = image.getNumberRows();
nCols = image.getNumberColumns();
outputNoData = image.getNoDataValue();
output = new WhiteboxRaster(outputHeader, "rw", imageFiles.get(0),
WhiteboxRaster.DataType.FLOAT, 0);
for (i = 0; i < numImages; i++) {
progress = (int)(100f * (i + 1) / numImages);
updateProgress("Loop " + (i + 1) + " of " + numImages + ":", progress);
weight = weights.get(i);
if (i > 0) {
image = new WhiteboxRaster(imageFiles.get(i), "r");
noData = image.getNoDataValue();
if (image.getNumberRows() != nRows || image.getNumberColumns() != nCols) {
showFeedback("All input images must have the same dimensions (rows and columns).");
return;
}
}
double[] data = null;
for (row = 0; row < nRows; row++) {
data = image.getRowValues(row);
for (col = 0; col < nCols; col++) {
if (data[col] != noData) {
z = output.getValue(row, col);
if (z != outputNoData) {
output.setValue(row, col, z + data[col] * weight);
}
} else {
output.setValue(row, col, outputNoData);
}
}
if (cancelOp) {
cancelOperation();
return;
}
//progress = (int) (100f * row / (nRows - 1));
//updateProgress(label, progress);
}
image.close();
}
output.addMetadataEntry("Created by the "
+ getDescriptiveName() + " tool.");
output.addMetadataEntry("Created on " + new Date());
output.close();
// returning a header file string displays the image.
returnData(outputHeader);
} 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();
}
}
}