/*
* 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 com.vividsolutions.jts.geom.Coordinate;
import com.vividsolutions.jts.geom.GeometryCollection;
import com.vividsolutions.jts.geom.GeometryFactory;
import com.vividsolutions.jts.geom.LineString;
import java.io.File;
import java.util.ArrayList;
import whitebox.geospatialfiles.ShapeFile;
import whitebox.geospatialfiles.shapefile.attributes.DBFField;
import whitebox.geospatialfiles.shapefile.attributes.DBFWriter;
import whitebox.geospatialfiles.shapefile.PointsList;
import whitebox.geospatialfiles.shapefile.ShapeFileRecord;
import whitebox.geospatialfiles.shapefile.ShapeType;
import whitebox.geospatialfiles.shapefile.ShapefilePoint;
import whitebox.interfaces.WhiteboxPlugin;
import whitebox.interfaces.WhiteboxPluginHost;
import whitebox.utilities.Topology;
/**
* This tool can be used to isolate all of the features, or parts of features, in two input vectors that overlap.
*
* @author Dr. John Lindsay email: jlindsay@uoguelph.ca
*/
public class Intersect 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 "Intersect";
}
/**
* 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 "Intersect";
}
/**
* Used to retrieve a short description of what the plugin tool does.
*
* @return String containing the plugin's description.
*/
@Override
public String getToolDescription() {
return "Computes a geometric intersection of vector features";
}
/**
* 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 inputFilesString = null;
String[] shapefiles;
int numFiles;
String outputFile;
int progress;
int i, n, FID;
int oneHundredthTotal;
int numRecs;
ShapeType shapeType;
ShapeType outputShapeType = ShapeType.POLYGON;
GeometryFactory factory = new GeometryFactory();
com.vividsolutions.jts.geom.Geometry g1 = null;
com.vividsolutions.jts.geom.Geometry g2 = null;
if (args.length <= 0) {
showFeedback("Plugin parameters have not been set.");
return;
}
inputFilesString = args[0];
outputFile = args[1];
// check to see that the inputHeader and outputHeader are not null.
if ((inputFilesString == null) || (outputFile == null)) {
showFeedback("One or more of the input parameters have not been set properly.");
return;
}
shapefiles = inputFilesString.split(";");
numFiles = shapefiles.length;
if (numFiles < 2) {
showFeedback("At least two input vector files must be specified.");
return;
}
try {
com.vividsolutions.jts.geom.Geometry[] recJTSGeometries = null;
ArrayList<com.vividsolutions.jts.geom.Geometry> inputGeometryList =
new ArrayList<>();
com.vividsolutions.jts.geom.Geometry outputGeometry = null;
for (int k = 0; k < numFiles; k++) {
ShapeFile input = new ShapeFile(shapefiles[k]);
shapeType = input.getShapeType();
numRecs = input.getNumberOfRecords();
if (shapeType.getBaseType() == ShapeType.POINT ||
shapeType.getBaseType() == ShapeType.MULTIPOINT) {
showFeedback("This tool can only work for shapefiles of a "
+ "POLYLINE or POLYGON shape-type. Tool execution "
+ "ceased.");
return;
} else if (shapeType.getBaseType() == ShapeType.POLYLINE &&
outputShapeType == ShapeType.POLYGON) {
outputShapeType = ShapeType.POLYLINE;
}
oneHundredthTotal = numRecs / 100;
progress = 0;
n = 0;
for (ShapeFileRecord record : input.records) {
if (record.getShapeType() != ShapeType.NULLSHAPE) {
recJTSGeometries = record.getGeometry().getJTSGeometries();
for (int a = 0; a < recJTSGeometries.length; a++) {
recJTSGeometries[a].setUserData(record.getRecordNumber());
if (recJTSGeometries[a].isValid()) {
inputGeometryList.add(recJTSGeometries[a]);
} else {
System.out.println(record.getRecordNumber() + " is invalid.");
}
}
}
n++;
if (n >= oneHundredthTotal) {
n = 0;
if (cancelOp) {
cancelOperation();
return;
}
progress++;
updateProgress("Loop " + (k + 1) + " of " + numFiles + ": Reading data:", progress);
}
}
if (k == 0) {
g1 = factory.buildGeometry(inputGeometryList);
inputGeometryList.clear();
} else {
g2 = factory.buildGeometry(inputGeometryList);
updateProgress("Performing operation (progress will not be updated):", -1);
try {
outputGeometry = g1.intersection(g2);
} catch (Exception ex) {
outputGeometry = com.vividsolutions.jts.operation.overlay.snap.SnapOverlayOp.intersection(g1, g2);
}
g1 = (com.vividsolutions.jts.geom.Geometry)outputGeometry.clone();
inputGeometryList.clear();
}
}
ShapeFile output = null;
DBFWriter writer = null;
if (outputGeometry instanceof GeometryCollection) {
// see if the collection is a collection of points
com.vividsolutions.jts.geom.Geometry gN0 = outputGeometry.getGeometryN(0);
if (gN0 instanceof com.vividsolutions.jts.geom.Point
&& outputShapeType == ShapeType.POLYLINE) {
// this happens when the input files are line segments (not
// closed rings) and the intersection results in points.
outputShapeType = ShapeType.POINT;
}
// set up the output files of the shapefile and the dbf
output = new ShapeFile(outputFile, outputShapeType);
output.setProjectionStringFromOtherShapefile(new ShapeFile(shapefiles[0]));
DBFField fields[] = new DBFField[1];
fields[0] = new DBFField();
fields[0].setName("FID");
fields[0].setDataType(DBFField.DBFDataType.NUMERIC);
fields[0].setFieldLength(10);
fields[0].setDecimalCount(0);
String DBFName = output.getDatabaseFile();
writer = new DBFWriter(new File(DBFName));
writer.setFields(fields);
int numGeometries = outputGeometry.getNumGeometries();
oneHundredthTotal = (int)(numGeometries / 100.0);
progress = 0;
n = 0;
FID = 0;
for (int a = 0; a < numGeometries; a++) {
com.vividsolutions.jts.geom.Geometry gN = outputGeometry.getGeometryN(a);
if (gN instanceof LineString) {
LineString ls = (LineString) gN;
ArrayList<ShapefilePoint> pnts = new ArrayList<>();
int[] parts = {0};
Coordinate[] coords = ls.getCoordinates();
for (i = 0; i < coords.length; i++) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
PointsList pl = new PointsList(pnts);
whitebox.geospatialfiles.shapefile.PolyLine wbGeometry = new whitebox.geospatialfiles.shapefile.PolyLine(parts, pl.getPointsArray());
output.addRecord(wbGeometry);
FID++;
Object[] rowData = new Object[1];
rowData[0] = (double) FID;
writer.addRecord(rowData);
} else if (gN instanceof com.vividsolutions.jts.geom.Polygon
&& outputShapeType == ShapeType.POLYLINE) {
com.vividsolutions.jts.geom.Polygon p = (com.vividsolutions.jts.geom.Polygon)gN;
ArrayList<ShapefilePoint> pnts = new ArrayList<>();
int[] parts = new int[p.getNumInteriorRing() + 1];
Coordinate[] coords = p.getExteriorRing().getCoordinates();
if (!Topology.isClockwisePolygon(coords)) {
for (i = coords.length - 1; i >= 0; i--) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
} else {
for (i = 0; i < coords.length; i++) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
}
for (int b = 0; b < p.getNumInteriorRing(); b++) {
parts[b + 1] = pnts.size();
coords = p.getInteriorRingN(b).getCoordinates();
if (Topology.isClockwisePolygon(coords)) {
for (i = coords.length - 1; i >= 0; i--) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
} else {
for (i = 0; i < coords.length; i++) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
}
}
PointsList pl = new PointsList(pnts);
whitebox.geospatialfiles.shapefile.PolyLine wbGeometry = new whitebox.geospatialfiles.shapefile.PolyLine(parts, pl.getPointsArray());
output.addRecord(wbGeometry);
FID++;
Object[] rowData = new Object[1];
rowData[0] = (double) FID;
writer.addRecord(rowData);
} else if (gN instanceof com.vividsolutions.jts.geom.Polygon
&& outputShapeType == ShapeType.POLYGON) {
com.vividsolutions.jts.geom.Polygon p = (com.vividsolutions.jts.geom.Polygon)gN;
ArrayList<ShapefilePoint> pnts = new ArrayList<>();
int[] parts = new int[p.getNumInteriorRing() + 1];
Coordinate[] coords = p.getExteriorRing().getCoordinates();
if (!Topology.isClockwisePolygon(coords)) {
for (i = coords.length - 1; i >= 0; i--) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
} else {
for (i = 0; i < coords.length; i++) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
}
for (int b = 0; b < p.getNumInteriorRing(); b++) {
parts[b + 1] = pnts.size();
coords = p.getInteriorRingN(b).getCoordinates();
if (Topology.isClockwisePolygon(coords)) {
for (i = coords.length - 1; i >= 0; i--) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
} else {
for (i = 0; i < coords.length; i++) {
pnts.add(new ShapefilePoint(coords[i].x, coords[i].y));
}
}
}
PointsList pl = new PointsList(pnts);
whitebox.geospatialfiles.shapefile.Polygon wbGeometry = new whitebox.geospatialfiles.shapefile.Polygon(parts, pl.getPointsArray());
output.addRecord(wbGeometry);
FID++;
Object[] rowData = new Object[1];
rowData[0] = new Double(FID);
writer.addRecord(rowData);
} else if (gN instanceof com.vividsolutions.jts.geom.Point
&& outputShapeType == ShapeType.POINT) {
com.vividsolutions.jts.geom.Point p = (com.vividsolutions.jts.geom.Point)gN;
whitebox.geospatialfiles.shapefile.Point wbGeometry = new whitebox.geospatialfiles.shapefile.Point(p.getX(), p.getY());
output.addRecord(wbGeometry);
FID++;
Object[] rowData = new Object[1];
rowData[0] = new Double(FID);
writer.addRecord(rowData);
} else {
// it shouldn't really hit here ever.
//showFeedback("An error was encountered when saving the output file.");
//return;
}
n++;
if (n >= oneHundredthTotal) {
n = 0;
if (cancelOp) {
cancelOperation();
return;
}
progress++;
updateProgress("Saving output file", progress);
}
}
} else {
// it shouldn't really hit here ever.
showFeedback("An error was encountered when saving the output file.");
return;
}
output.write();
writer.write();
// returning a header file string displays the image.
returnData(outputFile);
} 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[2];
//// args[0] = "/Users/johnlindsay/Documents/Data/ShapeFiles/NTDB_roads_rmow.shp"
//// + ";/Users/johnlindsay/Documents/Data/ShapeFiles/Water_Line_rmow.shp"
//// + ";/Users/johnlindsay/Documents/Data/ShapeFiles/Water_Body_rmow.shp";
//// args[1] = "/Users/johnlindsay/Documents/Data/ShapeFiles/tmp1.shp";
//
//// args[0] = "/Users/johnlindsay/Documents/Data/ShapeFiles/someLakes.shp"
//// + ";/Users/johnlindsay/Documents/Data/ShapeFiles/tmp5.shp";
//// args[1] = "/Users/johnlindsay/Documents/Data/ShapeFiles/tmp1.shp";
//
//// args[0] = "/Users/johnlindsay/Documents/Data/ShapeFiles/rondeau lakes.shp"
//// + ";/Users/johnlindsay/Documents/Research/Conference Presentations and Guest Talks/2012 CGU/Data/rivers.shp";
//// args[1] = "/Users/johnlindsay/Documents/Data/ShapeFiles/tmp2.shp";
//
// args[0] = "/Users/johnlindsay/Documents/Data/ShapeFiles/tmp1.shp"
// + ";/Users/johnlindsay/Documents/Data/ShapeFiles/tmp2.shp";
// args[1] = "/Users/johnlindsay/Documents/Data/ShapeFiles/tmp3.shp";
//
// Union u = new Union();
// u.setArgs(args);
// u.run();
// }
}