analysis.java
Class Raster

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

public class Raster
extends java.lang.Object

Class to handle Raster object and methods to read file to/from Raster; also includes methods for accessing data values


Constructor Summary
Raster()
          Creates a generic Raster object
Raster(int rows, int cols)
          Creates a Raster object; with a set number of rows and columns
Raster(java.lang.String rasterfile)
          Creates a Raster object from a tab-delimited text file
 
Method Summary
 int getCol(int id)
          Get column at cell id
 float getData(int id)
          Get value at position id
 float getData(int i, int j)
          Get value at row i, col j
 int getID(int row, int col)
          Get id at row i, col j
 int getNumCols()
          Get number of columns in Raster
 int getNumRows()
          Get number of rows in Raster
 int getRow(int id)
          Get row at cell id
 void read(java.lang.String rasterfile)
          Read tab-delimited file into Raster object
 void setData(float value, int id)
          Enter value at cell id
 void setData(float value, int row, int col)
          Enter value at row i, col j
 java.util.ArrayList toArrayList(analysis.java.Raster raster, int keepValue)
          Convert a binary Raster (e.g.
 analysis.java.Raster toRaster(java.util.ArrayList list, int rows, int cols)
          Convert an ArrayList to Raster
 analysis.java.Raster toRaster(java.util.TreeMap tree, int rows, int cols)
          Convert a TreeMap to Raster
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Raster

public Raster()
Creates a generic Raster object


Raster

public Raster(java.lang.String rasterfile)
Creates a Raster object from a tab-delimited text file

Parameters:
rasterfile - full path name for text file

Raster

public Raster(int rows,
              int cols)
Creates a Raster object; with a set number of rows and columns

Parameters:
rows - number of rows
cols - number of columns
Method Detail

getData

public float getData(int i,
                     int j)
Get value at row i, col j

Parameters:
i - row #
j - column #
Returns:
value at row i column j

getData

public float getData(int id)
Get value at position id

Parameters:
id - cell number
Returns:
value at row i column j

setData

public void setData(float value,
                    int row,
                    int col)
Enter value at row i, col j

Parameters:
value - value to be entered
row - row #
col - column #

setData

public void setData(float value,
                    int id)
Enter value at cell id

Parameters:
value - value to be entered into raster at cell id
id - cell id where value is to be entered

getID

public int getID(int row,
                 int col)
Get id at row i, col j

Parameters:
row - row #
col - column#
Returns:
cell id

getRow

public int getRow(int id)
Get row at cell id

Parameters:
id - cell id for which row# is sought
Returns:
row#

getCol

public int getCol(int id)
Get column at cell id

Parameters:
id - cell id for which column# is sought
Returns:
column#

getNumRows

public int getNumRows()
Get number of rows in Raster

Returns:
number of rows

getNumCols

public int getNumCols()
Get number of columns in Raster

Returns:
number of columns

toArrayList

public java.util.ArrayList toArrayList(analysis.java.Raster raster,
                                       int keepValue)
Convert a binary Raster (e.g. road file) to ArrayList

Parameters:
raster - Raster object to be converted
keepValue - binary value that is to be retained, e.g. "1" or "0"
Returns:
an ArrayList of cell id's

toRaster

public analysis.java.Raster toRaster(java.util.ArrayList list,
                                     int rows,
                                     int cols)
Convert an ArrayList to Raster

Parameters:
list - name of ArrayList to be converted
rows - # of rows in Raster
cols - # of columns in Raster
Returns:
a Raster object

toRaster

public analysis.java.Raster toRaster(java.util.TreeMap tree,
                                     int rows,
                                     int cols)
Convert a TreeMap to Raster

Parameters:
tree - name of TreeMap to be converted
rows - # of rows in Raster
cols - # of columns in Raster

read

public void read(java.lang.String rasterfile)
Read tab-delimited file into Raster object

Parameters:
rasterfile -