/*
* Copyright (C) 2013 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.Date;
import whitebox.geospatialfiles.WhiteboxRaster;
import whitebox.interfaces.WhiteboxPlugin;
import whitebox.interfaces.WhiteboxPluginHost;
/**
* This tool can be used to reduce the grid resolution of a raster by a user specified amount.
*
* @author Dr. John Lindsay email: jlindsay@uoguelph.ca
*/
public class Aggregate 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 "Aggregate";
}
/**
* 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 "Aggregate";
}
/**
* Used to retrieve a short description of what the plugin tool does.
*
* @return String containing the plugin's description.
*/
@Override
public String getToolDescription() {
return "Aggregates a raster to a lower resolution.";
}
/**
* Used to identify which toolboxes this plugin tool should be listed in.
*
* @return Array of Strings.
*/
@Override
public String[] getToolbox() {
String[] ret = {"RasterCreation"};
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 = null;
String outputHeader = null;
String aggregationType = "mean";
int aggregationFactor = 2;
int progress, oldProgress;
int rIn, cIn, rOut, cOut, r, c;
double value;
if (args.length <= 0) {
showFeedback("Plugin parameters have not been set.");
return;
}
inputHeader = args[0];
outputHeader = args[1];
aggregationFactor = Integer.parseInt(args[2]);
aggregationType = args[3].toLowerCase();
if (inputHeader.isEmpty() || outputHeader.isEmpty() || aggregationType.isEmpty()) {
showFeedback("One or more of the input parameters have not been set properly.");
return;
}
if (aggregationFactor < 2) {
aggregationFactor = 2;
}
try {
WhiteboxRaster input = new WhiteboxRaster(inputHeader, "r");
double nodata = input.getNoDataValue();
int nColsIn = input.getNumberColumns();
int nRowsIn = input.getNumberRows();
int nColsOut = (int) ((double) nColsIn / aggregationFactor);
int nRowsOut = (int) ((double) nRowsIn / aggregationFactor);
double north = input.getNorth();
double south = north - (input.getCellSizeY() * aggregationFactor * nRowsOut);
double west = input.getWest();
double east = west + (input.getCellSizeX() * aggregationFactor * nColsOut);
WhiteboxRaster output = new WhiteboxRaster(outputHeader, north, south, east, west, nRowsOut,
nColsOut, input.getDataScale(), input.getDataType(), 0, nodata);
output.setPreferredPalette(input.getPreferredPalette());
output.addMetadataEntry("Created by the "
+ getDescriptiveName() + " tool.");
if (aggregationType.equals("mean")) {
oldProgress = -1;
for (rOut = 0; rOut < nRowsOut; rOut++) {
for (cOut = 0; cOut < nColsOut; cOut++) {
rIn = rOut * aggregationFactor;
cIn = cOut * aggregationFactor;
double stat = 0;
double count = 0;
for (r = rIn; r < rIn + aggregationFactor; r++) {
for (c = cIn; c < cIn + aggregationFactor; c++) {
value = input.getValue(r, c);
if (value != nodata) {
stat += value;
count++;
}
}
}
if (count > 0) {
stat = stat / count;
output.setValue(rOut, cOut, stat);
} else {
output.setValue(rOut, cOut, nodata);
}
}
progress = (int) (100f * rOut / (nRowsOut - 1));
if (progress > oldProgress) {
oldProgress = progress;
updateProgress(progress);
}
}
} else if (aggregationType.equals("sum")) {
oldProgress = -1;
for (rOut = 0; rOut < nRowsOut; rOut++) {
for (cOut = 0; cOut < nColsOut; cOut++) {
rIn = rOut * aggregationFactor;
cIn = cOut * aggregationFactor;
double stat = 0;
double count = 0;
for (r = rIn; r < rIn + aggregationFactor; r++) {
for (c = cIn; c < cIn + aggregationFactor; c++) {
value = input.getValue(r, c);
if (value != nodata) {
stat += value;
count++;
}
}
}
if (count > 0) {
output.setValue(rOut, cOut, stat);
} else {
output.setValue(rOut, cOut, nodata);
}
}
progress = (int) (100f * rOut / (nRowsOut - 1));
if (progress > oldProgress) {
oldProgress = progress;
updateProgress(progress);
}
}
} else if (aggregationType.contains("max")) {
oldProgress = -1;
for (rOut = 0; rOut < nRowsOut; rOut++) {
for (cOut = 0; cOut < nColsOut; cOut++) {
rIn = rOut * aggregationFactor;
cIn = cOut * aggregationFactor;
double stat = Double.NEGATIVE_INFINITY;
double count = 0;
for (r = rIn; r < rIn + aggregationFactor; r++) {
for (c = cIn; c < cIn + aggregationFactor; c++) {
value = input.getValue(r, c);
if (value != nodata) {
if (value > stat) { stat = value; }
count++;
}
}
}
if (count > 0) {
output.setValue(rOut, cOut, stat);
} else {
output.setValue(rOut, cOut, nodata);
}
}
progress = (int) (100f * rOut / (nRowsOut - 1));
if (progress > oldProgress) {
oldProgress = progress;
updateProgress(progress);
}
}
} else if (aggregationType.contains("min")) {
oldProgress = -1;
for (rOut = 0; rOut < nRowsOut; rOut++) {
for (cOut = 0; cOut < nColsOut; cOut++) {
rIn = rOut * aggregationFactor;
cIn = cOut * aggregationFactor;
double stat = Double.POSITIVE_INFINITY;
double count = 0;
for (r = rIn; r < rIn + aggregationFactor; r++) {
for (c = cIn; c < cIn + aggregationFactor; c++) {
value = input.getValue(r, c);
if (value != nodata) {
if (value < stat) { stat = value; }
count++;
}
}
}
if (count > 0) {
output.setValue(rOut, cOut, stat);
} else {
output.setValue(rOut, cOut, nodata);
}
}
progress = (int) (100f * rOut / (nRowsOut - 1));
if (progress > oldProgress) {
oldProgress = progress;
updateProgress(progress);
}
}
} else if (aggregationType.contains("range")) {
oldProgress = -1;
for (rOut = 0; rOut < nRowsOut; rOut++) {
for (cOut = 0; cOut < nColsOut; cOut++) {
rIn = rOut * aggregationFactor;
cIn = cOut * aggregationFactor;
double min = Double.POSITIVE_INFINITY;
double max = Double.NEGATIVE_INFINITY;
double count = 0;
for (r = rIn; r < rIn + aggregationFactor; r++) {
for (c = cIn; c < cIn + aggregationFactor; c++) {
value = input.getValue(r, c);
if (value != nodata) {
if (value < min) { min = value; }
if (value > max) { max = value; }
count++;
}
}
}
if (count > 0) {
output.setValue(rOut, cOut, (max - min));
} else {
output.setValue(rOut, cOut, nodata);
}
}
progress = (int) (100f * rOut / (nRowsOut - 1));
if (progress > oldProgress) {
oldProgress = progress;
updateProgress(progress);
}
}
}
output.addMetadataEntry("Created on " + new Date());
input.close();
output.close();
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();
}
}
}