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

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkAbstract
          uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkMap

All Implemented Interfaces:

java.io.Serializable

public class Grid2DSquareCellIntChunkMap
extends Grid2DSquareCellIntChunkAbstract
implements java.io.Serializable

TODO: 1. Have a default value to use instead of noDataValue. 2. docs

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

Grid2DSquareCellChunkAbstract.ChunkCellID

Field Summary

Fields inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

chunkID, grid2DSquareCell

Constructor Summary

protected	Grid2DSquareCellIntChunkMap() Default constructor.
protected	Grid2DSquareCellIntChunkMap(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk, Grid2DSquareCellAbstract.ChunkID chunkID) Creates a new Grid2DSquareCellIntChunkMap
protected	Grid2DSquareCellIntChunkMap(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk, Grid2DSquareCellAbstract.ChunkID chunkID, int defaultValue) Creates a new Grid2DSquareCellIntChunkMap
protected	Grid2DSquareCellIntChunkMap(Grid2DSquareCellInt grid2DSquareCellInt, Grid2DSquareCellAbstract.ChunkID chunkID) Creates a new Grid2DSquareCellIntChunkMap
protected	Grid2DSquareCellIntChunkMap(Grid2DSquareCellInt grid2DSquareCellInt, Grid2DSquareCellAbstract.ChunkID chunkID, int defaultValue) Creates a new Grid2DSquareCellIntChunkMap

Method Summary

void	clearData() Clears the data associated with this.
int	getCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, int noDataValue) Returns the value of cell with CellID given by chunkCellID
int	getCell(int chunkCellRowIndex, int chunkCellColIndex, int noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex as a int.
gnu.trove.TIntObjectHashMap	getData() Returns this.data.
java.math.BigInteger	getNonNoDataValueCountBigInteger() Returns the number of cells with non noDataValues as a BigInteger.
java.math.BigDecimal	getSum() Returns the sum of all non noDataValues as a BigDecimal.
protected void	initCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, int valueToInitialise) Initialises the value of the chunk referred to by chunkCellID to valueToInitialise.
protected void	initCell(int chunkCellRowIndex, int chunkCellColIndex, int valueToInitialise) Initialises the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex.
void	initData() Initialises the data associated with this.
AbstractIterator	iterator() Returns an AbstractIterator for iterating over the cells in this.
int	setCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, int valueToSet) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet
int	setCell(int chunkCellRowIndex, int chunkCellColIndex, int valueToSet, int noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet
int[]	toArrayIncludingNoDataValues() Returns values in row major order as a int[].
int[]	toArrayNotIncludingNoDataValues() Returns non noDataValue in row major order as a int[].
java.lang.String	toString() Returns a description of this.

Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellIntChunkAbstract

getArithmeticMeanDouble, getCellDouble, getGrid2DSquareCellInt, getMaxInt, getMedianDouble, getMinInt, getModeTIntHashSet, getNonNoDataValueCountInt, getStandardDeviationDouble, getSumBigDecimal, initCells, sort1

Methods inherited from class uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract

getChunkID, getGrid2DSquareCell, getName, inChunk, initChunkID, initGrid2DSquareCell

Methods inherited from class java.lang.Object

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

Constructor Detail

Grid2DSquareCellIntChunkMap

protected Grid2DSquareCellIntChunkMap()

Default constructor.

Grid2DSquareCellIntChunkMap

protected Grid2DSquareCellIntChunkMap(Grid2DSquareCellInt grid2DSquareCellInt,
                                      Grid2DSquareCellAbstract.ChunkID chunkID)

Creates a new Grid2DSquareCellIntChunkMap

Parameters:

grid2DSquareCellInt -

chunkID - Default: default value to grid2DSquareCellInt.getNoDataValue()

Grid2DSquareCellIntChunkMap

protected Grid2DSquareCellIntChunkMap(Grid2DSquareCellInt grid2DSquareCellInt,
                                      Grid2DSquareCellAbstract.ChunkID chunkID,
                                      int defaultValue)

Creates a new Grid2DSquareCellIntChunkMap

Parameters:

grid2DSquareCellInt -

chunkID -

defaultValue -

Grid2DSquareCellIntChunkMap

protected Grid2DSquareCellIntChunkMap(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk,
                                      Grid2DSquareCellAbstract.ChunkID chunkID)

Creates a new Grid2DSquareCellIntChunkMap

Parameters:

grid2DSquareCellIntChunk -

chunkID - Default: default value to grid2DSquareCellInt.getNoDataValue() TODO: Optimise for different types.

Grid2DSquareCellIntChunkMap

protected Grid2DSquareCellIntChunkMap(Grid2DSquareCellIntChunkAbstract grid2DSquareCellIntChunk,
                                      Grid2DSquareCellAbstract.ChunkID chunkID,
                                      int defaultValue)

Creates a new Grid2DSquareCellIntChunkMap

Parameters:

grid2DSquareCellIntChunk -

chunkID - Default: default value to grid2DSquareCellInt.getNoDataValue() TODO: Optimise for different types.

Method Detail

toString

public java.lang.String toString()

Returns a description of this.

Specified by:

toString in class Grid2DSquareCellChunkAbstract

initData

public void initData()

Initialises the data associated with this.

Specified by:

initData in class Grid2DSquareCellIntChunkAbstract

getData

public gnu.trove.TIntObjectHashMap getData()

Returns this.data.

clearData

public void clearData()

Clears the data associated with this.

Specified by:

clearData in class Grid2DSquareCellIntChunkAbstract

toArrayIncludingNoDataValues

public int[] toArrayIncludingNoDataValues()

Returns values in row major order as a int[].

Overrides:

toArrayIncludingNoDataValues in class Grid2DSquareCellIntChunkAbstract

toArrayNotIncludingNoDataValues

public int[] toArrayNotIncludingNoDataValues()

Returns non noDataValue in row major order as a int[].

Overrides:

toArrayNotIncludingNoDataValues in class Grid2DSquareCellIntChunkAbstract

getCell

public int getCell(int chunkCellRowIndex,
                   int chunkCellColIndex,
                   int noDataValue)

Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex as a int.

Specified by:

getCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - the row index of the cell w.r.t. the origin of this chunk

chunkCellColIndex - the column index of the cell w.r.t. the origin of this chunk

noDataValue - the noDataValue of this.grid2DSquareCellInt

getCell

public int getCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID,
                   int noDataValue)

Returns the value of cell with CellID given by chunkCellID

Parameters:

chunkCellID - the chunk CellID of cell thats value is to be returned

noDataValue - the noDataValue of this.grid2DSquareCellInt

initCell

protected void initCell(int chunkCellRowIndex,
                        int chunkCellColIndex,
                        int valueToInitialise)

Initialises the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex. Utility method for constructor.

Specified by:

initCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - the row index of the cell w.r.t. the origin of this chunk

chunkCellColIndex - the column index of the cell w.r.t. the origin of this chunk

valueToInitialise - the value with which the cell is initialised

initCell

protected void initCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID,
                        int valueToInitialise)

Initialises the value of the chunk referred to by chunkCellID to valueToInitialise. Utility method for constructor.

Parameters:

chunkCellID - the Grid2DSquareCellIntChunkAbstract.ChunkCellID of the cell to be initialised

valueToInitialise - the value with which the cell is initialised

setCell

public int setCell(int chunkCellRowIndex,
                   int chunkCellColIndex,
                   int valueToSet,
                   int noDataValue)

Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet

Specified by:

setCell in class Grid2DSquareCellIntChunkAbstract

Parameters:

chunkCellRowIndex - The row index of the cell w.r.t. the origin of this chunk.

chunkCellColIndex - The column index of the cell w.r.t. the origin of this chunk.

valueToSet - The value the cell is to be set to.

noDataValue - The noDataValue of this.grid2DSquareCellInt.

setCell

public int setCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID,
                   int valueToSet)

Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet

Parameters:

chunkCellID - the Grid2DSquareCellIntChunkAbstract.ChunkCellID of the cell to be initialised

valueToSet - the value the cell is to be set to

getNonNoDataValueCountBigInteger

public java.math.BigInteger getNonNoDataValueCountBigInteger()

Returns the number of cells with non noDataValues as a BigInteger.

Overrides:

getNonNoDataValueCountBigInteger in class Grid2DSquareCellIntChunkAbstract

getSum

public java.math.BigDecimal getSum()

Returns the sum of all non noDataValues as a BigDecimal.

iterator

public AbstractIterator iterator()

Returns an AbstractIterator for iterating over the cells in this.

Specified by:

iterator in class Grid2DSquareCellChunkAbstract