analysis.java
Class BasinModule

java.lang.Object
  |
  +--analysis.java.BasinModule

public class BasinModule

extends java.lang.Object

Class for handling basin-related procedures, among which: finding basins in DEM assigning risk values to each basin converting all or each basin into a Raster object for output

Constructor Summary

BasinModule()
Creates a module for handling basin-related operations

Method Summary

analysis.java.Raster	allBasinsRiskToRaster(java.util.ArrayList list, java.util.TreeMap riskmap, analysis.java.Raster raster) Converts an ArrayList into a Raster object This method converts an ArrayList of basins into a Raster object.
analysis.java.Raster	allBasinsToRaster(java.util.ArrayList list, analysis.java.Raster raster) Converts an ArrayList into a Raster object This method converts an ArrayList of basins into a Raster object.
analysis.java.Raster	allOutlinesToRaster(java.util.TreeMap outlines, analysis.java.Raster raster) Converts aTreeMap into a Raster object This method converts a TreeMap of all basin outlines into a single Raster object.
analysis.java.Raster	allPitsToRaster(java.util.ArrayList list, analysis.java.Raster raster) Converts an ArrayList into a Raster object This method converts an ArrayList of pits into a Raster object.
int	basinSize()
java.util.ArrayList	findBasins(java.util.ArrayList source, analysis.java.Raster direction) Calculates upstream cells (basins) for a given layer of cells This method calculates the upstream cells and basins from a given input layer of cells, and a direction layer.
int	numBasins() Returns number of basins This method queries the length of the ArrayList of basins
analysis.java.Raster	singleBasinToRaster(java.util.ArrayList basin, analysis.java.Raster raster) Converts an ArrayList into a Raster object This method converts an ArrayList of basin cells for one basin into a Raster object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasinModule

public BasinModule()

Creates a module for handling basin-related operations

Method Detail

findBasins

public java.util.ArrayList findBasins(java.util.ArrayList source,
                                      analysis.java.Raster direction)

Calculates upstream cells (basins) for a given layer of cells This method calculates the upstream cells and basins from a given input layer of cells, and a direction layer.

Parameters:

source - an ArrayList containg cells for which upstream basins are to be calculated

direction - a Raster object containing directional values

Returns:

an ArrayList object of ArrayList objects for each basin found

singleBasinToRaster

public analysis.java.Raster singleBasinToRaster(java.util.ArrayList basin,
                                                analysis.java.Raster raster)

Converts an ArrayList into a Raster object This method converts an ArrayList of basin cells for one basin into a Raster object.

Parameters:

raster - an output Raster

Returns:

a Raster object This method is still under contruction

allBasinsToRaster

public analysis.java.Raster allBasinsToRaster(java.util.ArrayList list,
                                              analysis.java.Raster raster)

Converts an ArrayList into a Raster object This method converts an ArrayList of basins into a Raster object. Each [][] in the Raster object is assigned a value corresponding to the basin it is in.

Parameters:

list - an ArrayList of all basins

raster - an output Raster

Returns:

a Raster object of basin cell IDs

allOutlinesToRaster

public analysis.java.Raster allOutlinesToRaster(java.util.TreeMap outlines,
                                                analysis.java.Raster raster)

Converts aTreeMap into a Raster object This method converts a TreeMap of all basin outlines into a single Raster object.

Parameters:

outlines - a TreeMap of basin outlines cell IDs

Returns:

a Raster object of basin outlines

allPitsToRaster

public analysis.java.Raster allPitsToRaster(java.util.ArrayList list,
                                            analysis.java.Raster raster)

Converts an ArrayList into a Raster object This method converts an ArrayList of pits into a Raster object.

Parameters:

list - an ArrayList of all pits

raster - an output Raster

Returns:

a Raster object of pits

allBasinsRiskToRaster

public analysis.java.Raster allBasinsRiskToRaster(java.util.ArrayList list,
                                                  java.util.TreeMap riskmap,
                                                  analysis.java.Raster raster)

Converts an ArrayList into a Raster object This method converts an ArrayList of basins into a Raster object. Each cell in the Raster is assigned a value corresponding to the risk value of the basin it is in.

Parameters:

list - an ArrayList of all basins

riskmap - a TreeMap with key/value pairs of basin/risk

raster - an output Raster

Returns:

a Raster object

basinSize

public int basinSize()

numBasins

public int numBasins()

Returns number of basins This method queries the length of the ArrayList of basins

Returns:

an integer value