uk.ac.leeds.ccg.andyt.grids.core
Class Grid2DSquareCellDouble

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.grids.core.OutOfMemoryErrorHandler
      extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstract
          extended by uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDouble
All Implemented Interfaces:
java.io.Serializable

public class Grid2DSquareCellDouble
extends Grid2DSquareCellAbstract
implements java.io.Serializable

A class for representing grids of double precision values.

See Also:
Grid2DSquareCellAbstract, Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstract
Grid2DSquareCellAbstract.CellID, Grid2DSquareCellAbstract.ChunkID
 
Field Summary
protected  double noDataValue
          For storing the NODATA value of the grid, which by default is Double.NEGATIVE_INFINITY.
 
Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstract
chunkNcols, chunkNrows, dimensions, dimensionsScale, directory, grid2DSquareCellChunks, grid2DSquareCells, gridStatistics, name, nChunkCols, nChunkRows, ncols, nrows, unsignedLongPowersOf2
 
Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.OutOfMemoryErrorHandler
handleOutOfMemoryErrorFalse, handleOutOfMemoryErrorTrue, memoryReserve
 
Constructor Summary
  Grid2DSquareCellDouble()
          Creates a new Grid2DSquareCellDouble
protected Grid2DSquareCellDouble(java.io.File directory, java.io.File gridFile, java.io.ObjectInputStream ois, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Creates a new Grid2DSquareCellDouble.
protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics, java.io.File directory, java.io.File gridFile, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, int chunkNrows, int chunkNcols, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, double noDataValue, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Creates a new Grid2DSquareCellDouble with values obtained from gridFile.
protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellAbstract grid2DSquareCell, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, int chunkNrows, int chunkNcols, long startRowIndex, long startColIndex, long endRowIndex, long endColIndex, double noDataValue, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Creates a new Grid2DSquareCellDouble based on values in grid2DSquareCell.
protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics, java.io.File directory, Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory, int chunkNrows, int chunkNcols, long nrows, long ncols, java.math.BigDecimal[] dimensions, double noDataValue, java.util.HashSet grid2DSquareCells, boolean handleOutOfMemoryError)
          Creates a new Grid2DSquareCellDouble with each cell value equal to noDataValue and all chunks of the same type.
 
Method Summary
protected  double addToCell(double x, double y, double valueToAdd)
          Returns current value of cell containing the point given by x-coordinate x, y-coordinate y, and adds valueToAdd to that cell.
 double addToCell(double x, double y, double valueToAdd, boolean handleOutOfMemoryError)
          Returns current value of cell containing the point given by x-coordinate x, y-coordinate y, and adds valueToAdd to that cell.
protected  double addToCell(Grid2DSquareCellAbstract.CellID cellID, double valueToAdd)
          Returns the value of the cell with cell ID cellID and adds valueToAdd to that cell.
 double addToCell(Grid2DSquareCellAbstract.CellID cellID, double valueToAdd, boolean handleOutOfMemoryError)
          Returns the value of the cell with cell ID cellID and adds valueToAdd to that cell.
protected  double addToCell(long cellRowIndex, long cellColIndex, double valueToAdd)
          Returns current value of cell with row index rowIndex and column index colIndex and adds valueToAdd to that cell.
 double addToCell(long cellRowIndex, long cellColIndex, double valueToAdd, boolean handleOutOfMemoryError)
          Returns current value of cell with row index rowIndex and column index colIndex and adds valueToAdd to that cell.
 double getCell(double x, double y)
          For returning the value of the cell containing point given by x-coordinate x, y-coordinate y as a int.
 double getCell(double x, double y, boolean handleOutOfMemoryError)
          For returning the value of the cell containing point given by x-coordinate x, y-coordinate y as a double.
 double getCell(Grid2DSquareCellAbstract.CellID cellID, boolean handleOutOfMemoryError)
          For returning the value of the cell with cell ID cellID as a int.
 double getCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk, int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex)
          Returns the value at position given by chunk row index chunkRowIndex, chunk column index chunkColIndex, chunk cell row index chunkCellRowIndex, chunk cell column index chunkCellColIndex.
 double getCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk, int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex, boolean handleOutOfMemoryError)
          Returns the value at position given by chunk row index chunkRowIndex, chunk column index chunkColIndex, chunk cell row index chunkCellRowIndex, chunk cell column index chunkCellColIndex.
protected  double getCell(long cellRowIndex, long cellColIndex)
          Returns the value at cellRowIndex, cellColIndex else returns noDataValue.
 double getCell(long cellRowIndex, long cellColIndex, boolean handleOutOfMemoryError)
          Returns the value at cellRowIndex, cellColIndex else returns noDataValue.
 double[] getCells(double x, double y, double distance)
          Returns a double[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.
 double[] getCells(double x, double y, double distance, boolean handleOutOfMemoryError)
          Returns a double[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.
protected  double[] getCells(double x, double y, long cellRowIndex, long cellColIndex, double distance)
          Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.
 double[] getCells(double x, double y, long cellRowIndex, long cellColIndex, double distance, boolean handleOutOfMemoryError)
          Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.
protected  double[] getCells(long cellRowIndex, long cellColIndex, double distance)
          Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at centroid of cell given by cell row index cellRowIndex, cell column index cellColIndex, and radius distance.
 double[] getCells(long cellRowIndex, long cellColIndex, double distance, boolean handleOutOfMemoryError)
          Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at centroid of cell given by cell row index cellRowIndex, cell column index cellColIndex, and radius distance.
protected  Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(Grid2DSquareCellAbstract.ChunkID chunkID)
          Returns grid2DSquareCellDoubleChunksAbstract for the given ChunkID
 Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(Grid2DSquareCellAbstract.ChunkID chunkID, boolean handleOutOfMemoryError)
          Returns grid2DSquareCellDoubleChunksAbstract for the given ChunkID
protected  Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(int chunkRowIndex, int chunkColIndex)
          Returns grid2DSquareCellDoubleChunks.
 Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(int chunkRowIndex, int chunkColIndex, boolean handleOutOfMemoryError)
          Returns grid2DSquareCellDoubleChunks.
protected  double getNearestValueDouble(double x, double y)
          Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y as a double.
 double getNearestValueDouble(double x, double y, boolean handleOutOfMemoryError)
          Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y as a double.
protected  double getNearestValueDouble(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue)
          Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex
protected  double getNearestValueDouble(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue, boolean handleOutOfMemoryError)
          Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex
protected  double getNearestValueDouble(long cellRowIndex, long cellColIndex)
          Returns the average of the nearest data values to position given by row index rowIndex, column index colIndex
 double getNearestValueDouble(long cellRowIndex, long cellColIndex, boolean handleOutOfMemoryError)
          Returns the average of the nearest data values to position given by row index rowIndex, column index colIndex
protected  double getNearestValueDoubleDistance(double x, double y)
          Returns the distance to the nearest data value from point given by x-coordinate x, y-coordinate y as a double.
 double getNearestValueDoubleDistance(double x, double y, boolean handleOutOfMemoryError)
          Returns the distance to the nearest data value from point given by x-coordinate x, y-coordinate y as a double.
protected  double getNearestValueDoubleDistance(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue)
          Returns the distance to the nearest data value from: point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex as a double.
 double getNearestValueDoubleDistance(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue, boolean handleOutOfMemoryError)
          Returns the distance to the nearest data value from: point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex as a double.
protected  double getNearestValueDoubleDistance(long cellRowIndex, long cellColIndex)
          Returns the distance to the nearest data value from position given by row index rowIndex, column index colIndex as a double.
 double getNearestValueDoubleDistance(long cellRowIndex, long cellColIndex, boolean handleOutOfMemoryError)
          Returns the distance to the nearest data value from position given by row index rowIndex, column index colIndex as a double.
protected  Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x, double y)
          Returns a CellID[] - The CellIDs of the nearest cells with data values to point given by x-coordinate x, y-coordinate y.
 Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x, double y, boolean handleOutOfMemoryError)
          Returns a CellID[] - The CellIDs of the nearest cells with data values to point given by x-coordinate x, y-coordinate y.
protected  Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue)
          Returns a CellID[] - The CellIDs of the nearest cells with data values nearest to point with position given by: x-coordinate x, y-coordinate y; and, cell row index cellRowIndex, cell column index cellColIndex.
 Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x, double y, long cellRowIndex, long cellColIndex, double noDataValue, boolean handleOutOfMemoryError)
          Returns a CellID[] - The CellIDs of the nearest cells with data values nearest to point with position given by: x-coordinate x, y-coordinate y; and, cell row index cellRowIndex, cell column index cellColIndex.
protected  Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(long cellRowIndex, long cellColIndex)
          Returns a CellID[] - The CellIDs of the nearest cells with data values to position given by row index rowIndex, column index colIndex.
 Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(long cellRowIndex, long cellColIndex, boolean handleOutOfMemoryError)
          Returns a CellID[] - The CellIDs of the nearest cells with data values to position given by row index rowIndex, column index colIndex.
 double getNoDataValue(boolean handleOutOfMemoryError)
          Returns noDataValue.
 java.math.BigDecimal getNoDataValueBigDecimal(boolean handleOutOfMemoryError)
          Returns the noDataValue of this as a BigDecimal.
protected  void initCell(long cellRowIndex, long cellColIndex, double valueToInitialise)
          Initilises the value at cellRowIndex, cellColIndex
protected  void initCell(long cellRowIndex, long cellColIndex, double valueToInitialise, boolean handleOutOfMemoryError)
          Initilises the value at cellRowIndex, cellColIndex
protected  void initCellFast(long cellRowIndex, long cellColIndex, double valueToInitialise)
          Initilises the value at cellRowIndex, cellColIndex and does nothing about this.gridStatistics
protected  void initCellFast(long cellRowIndex, long cellColIndex, double valueToInitialise, boolean handleOutOfMemoryError)
          Initilises the value at cellRowIndex, cellColIndex and does nothing about this.gridStatistics
protected  void initNoDataValue(double noDataValue)
          Initialises noDataValue.
 java.util.Iterator iterator(boolean handleOutOfMemoryError)
          Returns an iterator over the cell value in this.
 double setCell(double x, double y, double newValue)
          For returning the value at x-coordinate x, y-coordinate y and setting it to newValue.
 double setCell(double x, double y, double newValue, boolean handleOutOfMemoryError)
          For returning the value at x-coordinate x, y-coordinate y and setting it to newValue.
 double setCell(Grid2DSquareCellAbstract.CellID cellID, double newValue, boolean handleOutOfMemoryError)
          For returning the value of the cell with cell ID cellID and setting it to newValue.
 double setCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk, int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex, double newValue)
          Returns the value at cellRowIndex, cellColIndex and sets it to newValue.
 double setCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk, int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex, double newValue, boolean handleOutOfMemoryError)
          Returns the value at cellRowIndex, cellColIndex and sets it to newValue.
 double setCell(int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex, double newValue)
          For returning the value of the cell in chunk given by chunkRowIndex and chunkColIndex and cell in the chunk given by chunkCellColIndex and chunkCellRowIndex and setting it to newValue.
 double setCell(int chunkRowIndex, int chunkColIndex, int chunkCellRowIndex, int chunkCellColIndex, double newValue, boolean handleOutOfMemoryError)
          For returning the value of the cell in chunk given by chunkRowIndex and chunkColIndex and cell in the chunk given by chunkCellColIndex and chunkCellRowIndex and setting it to newValue.
 double setCell(long cellRowIndex, long cellColIndex, double newValue)
          For returning the value at cellRowIndex, cellColIndex and setting it to newValue.
 double setCell(long cellRowIndex, long cellColIndex, double newValue, boolean handleOutOfMemoryError)
          For returning the value at cellRowIndex, cellColIndex and setting it to newValue.
 java.lang.String toString(boolean handleOutOfMemoryError)
          Returns a string description of the instance.
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellAbstract
clearFromCacheGrid2DSquareCellChunk, clearFromCacheGrid2DSquareCellChunk, clearFromCacheGrid2DSquareCellChunkExcept, clearFromCacheGrid2DSquareCellChunkExcept, clearFromCacheGrid2DSquareCellChunks, clearFromCacheGrid2DSquareCellChunks, clearFromCacheGrid2DSquareCellChunks, clearFromCacheGrid2DSquareCellChunks, clearFromCacheGrid2DSquareCellChunksExcept, clearFromCacheGrid2DSquareCellChunksExcept, clearFromCacheGrid2DSquareCellChunksExcept, clearFromCacheGrid2DSquareCellChunksExcept, getBasicDescription, getBasicDescription, getCellBoundsDoubleArray, getCellBoundsDoubleArray, getCellBoundsDoubleArray, getCellBoundsDoubleArray, getCellColIndex, getCellColIndex, getCellColIndex, getCellColIndex, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellDouble, getCellID, getCellID, getCellID, getCellID, getCellIDs, getCellIDs, getCellIDs, getCellIDs, getCellIDs, getCellIDs, getCellInt, getCellInt, getCellInt, getCellInt, getCellInt, getCellInt, getCellRowIndex, getCellRowIndex, getCellRowIndex, getCellRowIndex, getCellsizeDouble, getCellXBigDecimal, getCellXBigDecimal, getCellXBigDecimal, getCellXBigDecimal, getCellXDouble, getCellXDouble, getCellXDouble, getCellXDouble, getCellYBigDecimal, getCellYBigDecimal, getCellYBigDecimal, getCellYBigDecimal, getCellYDouble, getCellYDouble, getCellYDouble, getCellYDouble, getChunkCellColIndex, getChunkCellColIndex, getChunkCellColIndex, getChunkCellColIndex, getChunkCellRowIndex, getChunkCellRowIndex, getChunkCellRowIndex, getChunkCellRowIndex, getChunkColIndex, getChunkColIndex, getChunkColIndex, getChunkColIndex, getChunkNcols, getChunkNcols, getChunkNcols, getChunkNcols, getChunkNcols, getChunkNcolsFinalColChunks, getChunkNcolsFinalColChunks, getChunkNrows, getChunkNrows, getChunkNrows, getChunkNrows, getChunkNrows, getChunkNrowsFinalRowChunks, getChunkNrowsFinalRowChunks, getChunkRowIndex, getChunkRowIndex, getChunkRowIndex, getChunkRowIndex, getDimensions, getDimensionsScale, getDirectory, getDirectory, getGrid2DSquareCellChunk, getGrid2DSquareCellChunk, getGrid2DSquareCellChunk, getGrid2DSquareCellChunk, getGrid2DSquareCells, getGridBounds, getGridBounds, getGridStatistics, getHeightBigDecimal, getHeightBigDecimal, getHeightDouble, getHeightDouble, getName, getName, getNChunkCols, getNChunkRows, getNChunks, getNChunks, getNcols, getNearestCellID, getNearestCellID, getNearestCellID, getNearestCellID, getNearestCellID, getNearestCellID, getNextChunk, getNextChunk, getNextChunkRowMinor, getNextChunkRowMinor, getNrows, getPreviousChunk, getPreviousChunk, getWidthBigDecimal, getWidthBigDecimal, getWidthDouble, getWidthDouble, initDimensions, initGrid2DSquareCellAbstract, initGrid2DSquareCellAbstract, initGrid2DSquareCellChunks, initMemoryReserve, initNChunkCols, initNChunkRows, isInCache, isInCache, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, isInGrid, loadIntoCacheChunk, loadIntoCacheChunk, loadIntoCacheChunk, loadIntoCacheChunk, setChunk, setGrid2DSquareCells, setName, setName, swapToFileGrid2DSquareCellChunk, swapToFileGrid2DSquareCellChunk, swapToFileGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellChunks, swapToFileGrid2DSquareCellChunks, swapToFileGrid2DSquareCellChunks, swapToFileGrid2DSquareCellChunks, swapToFileGrid2DSquareCellChunksExcept, swapToFileGrid2DSquareCellChunksExcept, swapToFileGrid2DSquareCellsGrid2DSquareCellChunk, swapToFileGrid2DSquareCellsGrid2DSquareCellChunk, swapToFileGrid2DSquareCellsGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellsGrid2DSquareCellChunkExcept, swapToFileGrid2DSquareCellsGrid2DSquareCellChunks, swapToFileGrid2DSquareCellsGrid2DSquareCellChunks, swapToFileGrid2DSquareCellsGrid2DSquareCellChunksExcept, swapToFileGrid2DSquareCellsGrid2DSquareCellChunksExcept, toString, toString, writeToFile, writeToFile, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunk, writeToFileGrid2DSquareCellChunkExcept, writeToFileGrid2DSquareCellChunkExcept, writeToFileGrid2DSquareCellChunkExcept, writeToFileGrid2DSquareCellChunkExcept, writeToFileGrid2DSquareCellChunkExceptReverseOrder, writeToFileGrid2DSquareCellChunkExceptReverseOrder, writeToFileGrid2DSquareCellChunkExceptReverseOrder, writeToFileGrid2DSquareCellChunkExceptReverseOrder, writeToFileGrid2DSquareCellChunks, writeToFileGrid2DSquareCellChunks, writeToFileGrid2DSquareCellChunks, writeToFileGrid2DSquareCellChunks, writeToFileGrid2DSquareCellChunksExcept, writeToFileGrid2DSquareCellChunksExcept, writeToFileGrid2DSquareCellChunksExcept, writeToFileGrid2DSquareCellChunksExcept
 
Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.OutOfMemoryErrorHandler
clearMemoryReserve, initMemoryReserve, initMemoryReserve
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

noDataValue

protected double noDataValue
For storing the NODATA value of the grid, which by default is Double.NEGATIVE_INFINITY. N.B. Double.NaN should not be used. N.B. Care should be taken so that noDataValue is not a data value.

Constructor Detail

Grid2DSquareCellDouble

public Grid2DSquareCellDouble()
Creates a new Grid2DSquareCellDouble


Grid2DSquareCellDouble

protected Grid2DSquareCellDouble(java.io.File directory,
                                 java.io.File gridFile,
                                 java.io.ObjectInputStream ois,
                                 java.util.HashSet grid2DSquareCells,
                                 boolean handleOutOfMemoryError)
Creates a new Grid2DSquareCellDouble. Warning!! Concurrent modification may occur if directory is in use. If a completely new instance is wanted then use: Grid2DSquareCellDouble( File, Grid2DSquareCellDoubleAbstract, Grid2DSquareCellDoubleChunkAbstractFactory, int, int, long, long, long, long, double, HashSet) which can be accessed via a Grid2DSquareCellDoubleFactory.

Parameters:
directory - The File directory to be used for swapping.
gridFile - The File directory containing the File names thisFile that the ois was constructed from.
ois - The ObjectInputStream used in first attempt to construct this.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

Grid2DSquareCellDouble

protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics,
                                 java.io.File directory,
                                 Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                 int chunkNrows,
                                 int chunkNcols,
                                 long nrows,
                                 long ncols,
                                 java.math.BigDecimal[] dimensions,
                                 double noDataValue,
                                 java.util.HashSet grid2DSquareCells,
                                 boolean handleOutOfMemoryError)
Creates a new Grid2DSquareCellDouble with each cell value equal to noDataValue and all chunks of the same type.

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany this.
directory - The File directory to be used for swapping.
grid2DSquareCellDoubleChunkFactory - The Grid2DSquareCellDoubleChunkAbstractFactory prefered for creating chunks.
chunkNrows - The number of rows of cells in any chunk.
chunkNcols - The number of columns of cells in any chunk.
nrows - The number of rows of cells.
ncols - The number of columns of cells.
dimensions - The cellsize, xmin, ymin, xmax and ymax.
noDataValue - The noDataValue.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

Grid2DSquareCellDouble

protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics,
                                 java.io.File directory,
                                 Grid2DSquareCellAbstract grid2DSquareCell,
                                 Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                 int chunkNrows,
                                 int chunkNcols,
                                 long startRowIndex,
                                 long startColIndex,
                                 long endRowIndex,
                                 long endColIndex,
                                 double noDataValue,
                                 java.util.HashSet grid2DSquareCells,
                                 boolean handleOutOfMemoryError)
Creates a new Grid2DSquareCellDouble based on values in grid2DSquareCell.

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany this.
directory - The File directory to be used for swapping.
grid2DSquareCell - The Grid2DSquareCellAbstract from which this is to be constructed.
grid2DSquareCellDoubleChunkFactory - The Grid2DSquareCellDoubleChunkAbstractFactory prefered to construct chunks of this.
chunkNrows - The number of rows of cells in any chunk.
chunkNcols - The number of columns of cells in any chunk.
startRowIndex - The grid2DSquareCell row index which is the bottom most row of this.
startColIndex - The grid2DSquareCell column index which is the left most column of this.
endRowIndex - The grid2DSquareCell row index which is the top most row of this.
endColIndex - The grid2DSquareCell column index which is the right most column of this.
noDataValue - The noDataValue for this.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

Grid2DSquareCellDouble

protected Grid2DSquareCellDouble(GridStatisticsAbstract gridStatistics,
                                 java.io.File directory,
                                 java.io.File gridFile,
                                 Grid2DSquareCellDoubleChunkAbstractFactory grid2DSquareCellDoubleChunkFactory,
                                 int chunkNrows,
                                 int chunkNcols,
                                 long startRowIndex,
                                 long startColIndex,
                                 long endRowIndex,
                                 long endColIndex,
                                 double noDataValue,
                                 java.util.HashSet grid2DSquareCells,
                                 boolean handleOutOfMemoryError)
Creates a new Grid2DSquareCellDouble with values obtained from gridFile. Currently gridFile must be a directory of a Grid2DSquareCellDouble or Grid2DSquareCellInt or a ESRI Asciigrid format file with a name ending ".asc".

Parameters:
gridStatistics - The GridStatisticsAbstract to accompany this.
directory - The File directory to be used for swapping.
gridFile - Either a directory, or a formatted File with a specific extension containing the data and information about the Grid2DSquareCellDouble to be returned.
grid2DSquareCellDoubleChunkFactory - The Grid2DSquareCellDoubleChunkAbstractFactory prefered to construct chunks of this.
startRowIndex - The grid2DSquareCell row index which is the bottom most row of this.
startColIndex - The grid2DSquareCell column index which is the left most column of this.
endRowIndex - The grid2DSquareCell row index which is the top most row of this.
endColIndex - The grid2DSquareCell column index which is the right most column of this.
noDataValue - The noDataValue for this.
grid2DSquareCells - A HashSet of swappable Grid2DSquareCellAbstract instances.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.
Method Detail

toString

public java.lang.String toString(boolean handleOutOfMemoryError)
Returns a string description of the instance. Basically the values of each field.

Specified by:
toString in class Grid2DSquareCellAbstract
Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught in this method then caching operations are initiated prior to retrying. If false then OutOfMemoryErrors are caught and thrown.

getGrid2DSquareCellDoubleChunk

public Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(int chunkRowIndex,
                                                                          int chunkColIndex,
                                                                          boolean handleOutOfMemoryError)
Returns grid2DSquareCellDoubleChunks.

Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getGrid2DSquareCellDoubleChunk

protected Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(int chunkRowIndex,
                                                                             int chunkColIndex)
Returns grid2DSquareCellDoubleChunks.


getGrid2DSquareCellDoubleChunk

public Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(Grid2DSquareCellAbstract.ChunkID chunkID,
                                                                          boolean handleOutOfMemoryError)
Returns grid2DSquareCellDoubleChunksAbstract for the given ChunkID

Parameters:
chunkID -
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getGrid2DSquareCellDoubleChunk

protected Grid2DSquareCellDoubleChunkAbstract getGrid2DSquareCellDoubleChunk(Grid2DSquareCellAbstract.ChunkID chunkID)
Returns grid2DSquareCellDoubleChunksAbstract for the given ChunkID

Parameters:
chunkID -

getNoDataValue

public final double getNoDataValue(boolean handleOutOfMemoryError)
Returns noDataValue.

Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNoDataValueBigDecimal

public java.math.BigDecimal getNoDataValueBigDecimal(boolean handleOutOfMemoryError)
Returns the noDataValue of this as a BigDecimal.

Specified by:
getNoDataValueBigDecimal in class Grid2DSquareCellAbstract
Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

initNoDataValue

protected final void initNoDataValue(double noDataValue)
Initialises noDataValue.

Parameters:
noDataValue - The value this.noDataValue is initialised to.

getCell

public double getCell(long cellRowIndex,
                      long cellColIndex,
                      boolean handleOutOfMemoryError)
Returns the value at cellRowIndex, cellColIndex else returns noDataValue.

Parameters:
cellRowIndex - .
cellColIndex - .
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCell

protected double getCell(long cellRowIndex,
                         long cellColIndex)
Returns the value at cellRowIndex, cellColIndex else returns noDataValue.

Parameters:
cellRowIndex - .
cellColIndex - .

getCell

public double getCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk,
                      int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex,
                      boolean handleOutOfMemoryError)
Returns the value at position given by chunk row index chunkRowIndex, chunk column index chunkColIndex, chunk cell row index chunkCellRowIndex, chunk cell column index chunkCellColIndex.

Parameters:
chunkRowIndex - The chunk row index of the cell thats value is returned.
chunkColIndex - The chunk column index of the cell thats value is returned.
chunkCellRowIndex - The chunk cell row index of the cell thats value is returned.
chunkCellColIndex - The chunk cell column index of the cell thats value is returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCell

public double getCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk,
                      int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex)
Returns the value at position given by chunk row index chunkRowIndex, chunk column index chunkColIndex, chunk cell row index chunkCellRowIndex, chunk cell column index chunkCellColIndex.

Parameters:
chunkRowIndex - The chunk row index of the cell thats value is returned.
chunkColIndex - The chunk column index of the cell thats value is returned.
chunkCellRowIndex - The chunk cell row index of the cell thats value is returned.
chunkCellColIndex - The chunk cell column index of the cell thats value is returned.

getCell

public final double getCell(double x,
                            double y,
                            boolean handleOutOfMemoryError)
For returning the value of the cell containing point given by x-coordinate x, y-coordinate y as a double.

Parameters:
x - the x-coordinate of the point.
y - the y-coordinate of the point.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCell

public final double getCell(double x,
                            double y)
For returning the value of the cell containing point given by x-coordinate x, y-coordinate y as a int.

Parameters:
x - the x-coordinate of the point.
y - the y-coordinate of the point.

getCell

public final double getCell(Grid2DSquareCellAbstract.CellID cellID,
                            boolean handleOutOfMemoryError)
For returning the value of the cell with cell ID cellID as a int.

Parameters:
cellID - the CellID of the cell.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public final double setCell(double x,
                            double y,
                            double newValue,
                            boolean handleOutOfMemoryError)
For returning the value at x-coordinate x, y-coordinate y and setting it to newValue.

Parameters:
x - the x-coordinate of the point.
y - the y-coordinate of the point.
newValue - .
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public final double setCell(double x,
                            double y,
                            double newValue)
For returning the value at x-coordinate x, y-coordinate y and setting it to newValue.

Parameters:
x - the x-coordinate of the point.
y - the y-coordinate of the point.
newValue - .

setCell

public final double setCell(Grid2DSquareCellAbstract.CellID cellID,
                            double newValue,
                            boolean handleOutOfMemoryError)
For returning the value of the cell with cell ID cellID and setting it to newValue.

Parameters:
cellID - the CellID of the cell.
newValue - .
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public double setCell(long cellRowIndex,
                      long cellColIndex,
                      double newValue,
                      boolean handleOutOfMemoryError)
For returning the value at cellRowIndex, cellColIndex and setting it to newValue.

Specified by:
setCell in class Grid2DSquareCellAbstract
Parameters:
cellRowIndex - .
cellColIndex - .
newValue - .
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public double setCell(long cellRowIndex,
                      long cellColIndex,
                      double newValue)
For returning the value at cellRowIndex, cellColIndex and setting it to newValue.

Parameters:
cellRowIndex - .
cellColIndex - .
newValue - .

setCell

public double setCell(int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double newValue,
                      boolean handleOutOfMemoryError)
For returning the value of the cell in chunk given by chunkRowIndex and chunkColIndex and cell in the chunk given by chunkCellColIndex and chunkCellRowIndex and setting it to newValue.

Parameters:
chunkRowIndex -
chunkColIndex -
chunkCellRowIndex -
chunkCellColIndex -
newValue -
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public double setCell(int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double newValue)
For returning the value of the cell in chunk given by chunkRowIndex and chunkColIndex and cell in the chunk given by chunkCellColIndex and chunkCellRowIndex and setting it to newValue.

Parameters:
chunkRowIndex -
chunkColIndex -
chunkCellRowIndex -
chunkCellColIndex -
newValue -

setCell

public double setCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk,
                      int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double newValue,
                      boolean handleOutOfMemoryError)
Returns the value at cellRowIndex, cellColIndex and sets it to newValue.

Parameters:
chunkRowIndex - .
chunkColIndex - .
newValue - .
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

setCell

public double setCell(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellChunk,
                      int chunkRowIndex,
                      int chunkColIndex,
                      int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double newValue)
Returns the value at cellRowIndex, cellColIndex and sets it to newValue.

Parameters:
chunkRowIndex - .
chunkColIndex - .
newValue - .

initCell

protected void initCell(long cellRowIndex,
                        long cellColIndex,
                        double valueToInitialise,
                        boolean handleOutOfMemoryError)
Initilises the value at cellRowIndex, cellColIndex

Parameters:
cellRowIndex -
cellColIndex -
valueToInitialise -
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

initCell

protected void initCell(long cellRowIndex,
                        long cellColIndex,
                        double valueToInitialise)
Initilises the value at cellRowIndex, cellColIndex

Parameters:
cellRowIndex -
cellColIndex -
valueToInitialise -

initCellFast

protected void initCellFast(long cellRowIndex,
                            long cellColIndex,
                            double valueToInitialise,
                            boolean handleOutOfMemoryError)
Initilises the value at cellRowIndex, cellColIndex and does nothing about this.gridStatistics

Parameters:
cellRowIndex -
cellColIndex -
valueToInitialise -
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

initCellFast

protected void initCellFast(long cellRowIndex,
                            long cellColIndex,
                            double valueToInitialise)
Initilises the value at cellRowIndex, cellColIndex and does nothing about this.gridStatistics

Parameters:
cellRowIndex -
cellColIndex -
valueToInitialise -

getCells

public double[] getCells(double x,
                         double y,
                         double distance,
                         boolean handleOutOfMemoryError)
Returns a double[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.

Parameters:
x - the x-coordinate of the circle centre from which cell values are returned.
y - the y-coordinate of the circle centre from which cell values are returned.
distance - the radius of the circle for which intersected cell values are returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCells

public double[] getCells(double x,
                         double y,
                         double distance)
Returns a double[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.

Parameters:
x - the x-coordinate of the circle centre from which cell values are returned.
y - the y-coordinate of the circle centre from which cell values are returned.
distance - the radius of the circle for which intersected cell values are returned.

getCells

public double[] getCells(long cellRowIndex,
                         long cellColIndex,
                         double distance,
                         boolean handleOutOfMemoryError)
Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at centroid of cell given by cell row index cellRowIndex, cell column index cellColIndex, and radius distance.

Parameters:
cellRowIndex - the row index for the cell thats centroid is the circle centre from which cell values are returned.
cellColIndex - the column index for the cell thats centroid is the circle centre from which cell values are returned.
distance - the radius of the circle for which intersected cell values are returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCells

protected double[] getCells(long cellRowIndex,
                            long cellColIndex,
                            double distance)
Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at centroid of cell given by cell row index cellRowIndex, cell column index cellColIndex, and radius distance.

Parameters:
cellRowIndex - the row index for the cell thats centroid is the circle centre from which cell values are returned.
cellColIndex - the column index for the cell thats centroid is the circle centre from which cell values are returned.
distance - the radius of the circle for which intersected cell values are returned.

getCells

public double[] getCells(double x,
                         double y,
                         long cellRowIndex,
                         long cellColIndex,
                         double distance,
                         boolean handleOutOfMemoryError)
Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.

Parameters:
x - The x-coordinate of the circle centre from which cell values are returned.
y - The y-coordinate of the circle centre from which cell values are returned.
cellRowIndex - The row index at y.
cellColIndex - The col index at x.
distance - The radius of the circle for which intersected cell values are returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getCells

protected double[] getCells(double x,
                            double y,
                            long cellRowIndex,
                            long cellColIndex,
                            double distance)
Returns a int[] of all cell values for cells thats centroids are intersected by circle with centre at x-coordinate x, y-coordinate y, and radius distance.

Parameters:
x - The x-coordinate of the circle centre from which cell values are returned.
y - The y-coordinate of the circle centre from which cell values are returned.
cellRowIndex - The row index at y.
cellColIndex - The col index at x.
distance - The radius of the circle for which intersected cell values are returned.

getNearestValueDouble

public double getNearestValueDouble(double x,
                                    double y,
                                    boolean handleOutOfMemoryError)
Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y as a double.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDouble

protected double getNearestValueDouble(double x,
                                       double y)
Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y as a double.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point

getNearestValueDouble

public double getNearestValueDouble(long cellRowIndex,
                                    long cellColIndex,
                                    boolean handleOutOfMemoryError)
Returns the average of the nearest data values to position given by row index rowIndex, column index colIndex

Parameters:
cellRowIndex - the row index from which average of the nearest data values is returned
cellColIndex - the column index from which average of the nearest data values is returned
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDouble

protected double getNearestValueDouble(long cellRowIndex,
                                       long cellColIndex)
Returns the average of the nearest data values to position given by row index rowIndex, column index colIndex

Parameters:
cellRowIndex - the row index from which average of the nearest data values is returned
cellColIndex - the column index from which average of the nearest data values is returned

getNearestValueDouble

protected double getNearestValueDouble(double x,
                                       double y,
                                       long cellRowIndex,
                                       long cellColIndex,
                                       double noDataValue,
                                       boolean handleOutOfMemoryError)
Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
cellRowIndex - the row index from which average of the nearest data values is returned
cellColIndex - the column index from which average of the nearest data values is returned
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDouble

protected double getNearestValueDouble(double x,
                                       double y,
                                       long cellRowIndex,
                                       long cellColIndex,
                                       double noDataValue)
Returns the average of the nearest data values to point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
cellRowIndex - the row index from which average of the nearest data values is returned
cellColIndex - the column index from which average of the nearest data values is returned

getNearestValuesCellIDs

public Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x,
                                                                 double y,
                                                                 boolean handleOutOfMemoryError)
Returns a CellID[] - The CellIDs of the nearest cells with data values to point given by x-coordinate x, y-coordinate y.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValuesCellIDs

protected Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x,
                                                                    double y)
Returns a CellID[] - The CellIDs of the nearest cells with data values to point given by x-coordinate x, y-coordinate y.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.

getNearestValuesCellIDs

public Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(long cellRowIndex,
                                                                 long cellColIndex,
                                                                 boolean handleOutOfMemoryError)
Returns a CellID[] - The CellIDs of the nearest cells with data values to position given by row index rowIndex, column index colIndex.

Parameters:
cellRowIndex - The row index from which the cell IDs of the nearest cells with data values are returned.
cellColIndex - The column index from which the cell IDs of the nearest cells with data values are returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValuesCellIDs

protected Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(long cellRowIndex,
                                                                    long cellColIndex)
Returns a CellID[] - The CellIDs of the nearest cells with data values to position given by row index rowIndex, column index colIndex.

Parameters:
cellRowIndex - The row index from which the cell IDs of the nearest cells with data values are returned.
cellColIndex - The column index from which the cell IDs of the nearest cells with data values are returned.

getNearestValuesCellIDs

public Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x,
                                                                 double y,
                                                                 long cellRowIndex,
                                                                 long cellColIndex,
                                                                 double noDataValue,
                                                                 boolean handleOutOfMemoryError)
Returns a CellID[] - The CellIDs of the nearest cells with data values nearest to point with position given by: x-coordinate x, y-coordinate y; and, cell row index cellRowIndex, cell column index cellColIndex.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
cellRowIndex - The row index from which the cell IDs of the nearest cells with data values are returned.
cellColIndex - The column index from which the cell IDs of the nearest cells with data values are returned.
noDataValue - the no data value of the grid
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValuesCellIDs

protected Grid2DSquareCellAbstract.CellID[] getNearestValuesCellIDs(double x,
                                                                    double y,
                                                                    long cellRowIndex,
                                                                    long cellColIndex,
                                                                    double noDataValue)
Returns a CellID[] - The CellIDs of the nearest cells with data values nearest to point with position given by: x-coordinate x, y-coordinate y; and, cell row index cellRowIndex, cell column index cellColIndex.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
cellRowIndex - The row index from which the cell IDs of the nearest cells with data values are returned.
cellColIndex - The column index from which the cell IDs of the nearest cells with data values are returned.
noDataValue - the no data value of the grid

getNearestValueDoubleDistance

public double getNearestValueDoubleDistance(double x,
                                            double y,
                                            boolean handleOutOfMemoryError)
Returns the distance to the nearest data value from point given by x-coordinate x, y-coordinate y as a double.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDoubleDistance

protected double getNearestValueDoubleDistance(double x,
                                               double y)
Returns the distance to the nearest data value from point given by x-coordinate x, y-coordinate y as a double.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.

getNearestValueDoubleDistance

public double getNearestValueDoubleDistance(long cellRowIndex,
                                            long cellColIndex,
                                            boolean handleOutOfMemoryError)
Returns the distance to the nearest data value from position given by row index rowIndex, column index colIndex as a double.

Parameters:
cellRowIndex - The cell row index of the cell from which the distance nearest to the nearest cell value is returned.
cellColIndex - The cell column index of the cell from which the distance nearest to the nearest cell value is returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDoubleDistance

protected double getNearestValueDoubleDistance(long cellRowIndex,
                                               long cellColIndex)
Returns the distance to the nearest data value from position given by row index rowIndex, column index colIndex as a double.

Parameters:
cellRowIndex - The cell row index of the cell from which the distance nearest to the nearest cell value is returned.
cellColIndex - The cell column index of the cell from which the distance nearest to the nearest cell value is returned.

getNearestValueDoubleDistance

public double getNearestValueDoubleDistance(double x,
                                            double y,
                                            long cellRowIndex,
                                            long cellColIndex,
                                            double noDataValue,
                                            boolean handleOutOfMemoryError)
Returns the distance to the nearest data value from: point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex as a double.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.
cellRowIndex - The cell row index of the cell from which the distance nearest to the nearest cell value is returned.
cellColIndex - The cell column index of the cell from which the distance nearest to the nearest cell value is returned.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

getNearestValueDoubleDistance

protected double getNearestValueDoubleDistance(double x,
                                               double y,
                                               long cellRowIndex,
                                               long cellColIndex,
                                               double noDataValue)
Returns the distance to the nearest data value from: point given by x-coordinate x, y-coordinate y in position given by row index rowIndex, column index colIndex as a double.

Parameters:
x - The x-coordinate of the point.
y - The y-coordinate of the point.
cellRowIndex - The cell row index of the cell from which the distance nearest to the nearest cell value is returned.
cellColIndex - The cell column index of the cell from which the distance nearest to the nearest cell value is returned.

addToCell

public double addToCell(double x,
                        double y,
                        double valueToAdd,
                        boolean handleOutOfMemoryError)
Returns current value of cell containing the point given by x-coordinate x, y-coordinate y, and adds valueToAdd to that cell.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
valueToAdd - the value to be added to the cell containing the point
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

addToCell

protected double addToCell(double x,
                           double y,
                           double valueToAdd)
Returns current value of cell containing the point given by x-coordinate x, y-coordinate y, and adds valueToAdd to that cell.

Parameters:
x - the x-coordinate of the point
y - the y-coordinate of the point
valueToAdd - the value to be added to the cell containing the point

addToCell

public double addToCell(Grid2DSquareCellAbstract.CellID cellID,
                        double valueToAdd,
                        boolean handleOutOfMemoryError)
Returns the value of the cell with cell ID cellID and adds valueToAdd to that cell.

Parameters:
cellID - the CellID of the cell.
valueToAdd - the value to be added to the cell containing the point
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.

addToCell

protected double addToCell(Grid2DSquareCellAbstract.CellID cellID,
                           double valueToAdd)
Returns the value of the cell with cell ID cellID and adds valueToAdd to that cell.

Parameters:
cellID - the CellID of the cell.
valueToAdd - the value to be added to the cell containing the point

addToCell

public double addToCell(long cellRowIndex,
                        long cellColIndex,
                        double valueToAdd,
                        boolean handleOutOfMemoryError)
Returns current value of cell with row index rowIndex and column index colIndex and adds valueToAdd to that cell.

Parameters:
cellRowIndex - the row index of the cell.
cellColIndex - the col index of the cell.
valueToAdd - the value to be added to the cell.
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown. NB1. If cell is not contained in this then then returns noDataValue. NB2. Adding to noDataValue is done as if adding to a cell with value of 0. TODO: Check Arithmetic

addToCell

protected double addToCell(long cellRowIndex,
                           long cellColIndex,
                           double valueToAdd)
Returns current value of cell with row index rowIndex and column index colIndex and adds valueToAdd to that cell.

Parameters:
cellRowIndex - the row index of the cell.
cellColIndex - the col index of the cell.
valueToAdd - the value to be added to the cell. NB1. If cell is not contained in this then then returns noDataValue. NB2. Adding to noDataValue is done as if adding to a cell with value of 0. TODO: Check Arithmetic

iterator

public java.util.Iterator iterator(boolean handleOutOfMemoryError)
Returns an iterator over the cell value in this.

Specified by:
iterator in class Grid2DSquareCellAbstract
Parameters:
handleOutOfMemoryError - If true then OutOfMemoryErrors are caught, swap operations are initiated, then the method is re-called. If false then OutOfMemoryErrors are caught and thrown.