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

java.lang.Object
  uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellChunkAbstract
      uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkAbstract
          uk.ac.leeds.ccg.andyt.grids.core.Grid2DSquareCellDoubleChunkMap

All Implemented Interfaces:

java.io.Serializable

public class Grid2DSquareCellDoubleChunkMap
extends Grid2DSquareCellDoubleChunkAbstract
implements java.io.Serializable

The maximum size of this Grid2DSquareCellDoubleChunkAbstract is 64 cells.

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	Grid2DSquareCellDoubleChunkMap() Default constructor.
protected	Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk, Grid2DSquareCellAbstract.ChunkID chunkID, double defaultValue) Creates a new Grid2DSquareCellDoubleChunkMap
protected	Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDouble grid2DSquareCellDouble, Grid2DSquareCellAbstract.ChunkID chunkID) Creates a new Grid2DSquareCellDoubleChunkMap
protected	Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDouble grid2DSquareCellDouble, Grid2DSquareCellAbstract.ChunkID chunkID, double defaultValue) Creates a new Grid2DSquareCellDoubleChunkMap

Method Summary

void	clearData() Clears the data associated with this.
double	getArithmeticMeanDouble() Returns the Arithmetic Mean of all non noDataValues as a double.
double	getCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, double noDataValue) Returns the value of cell with CellID given by chunkCellID
double	getCell(int chunkCellRowIndex, int chunkCellColIndex, double noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell row chunkCellColIndex.
gnu.trove.TDoubleObjectHashMap	getData() Returns this.data.
java.math.BigInteger	getDiversityBigInteger() For returning the number of different values.
double	getMaxDouble() Returns the maximum of all non noDataValues as a double
double	getMedianDouble() For returning the median of all non noDataValues as a double
double	getMinDouble() Returns the minimum of all non noDataValues as a double.
gnu.trove.TDoubleHashSet	getModeTDoubleHashSet() For returning the mode of all non noDataValues as a TDoubleHashSet
java.math.BigInteger	getNonNoDataValueCountBigInteger() Returns the number of cells with non noDataValues as a BigInteger.
double	getStandardDeviationDouble() For returning the standard deviation of all non noDataValues as a double
java.math.BigDecimal	getSumBigDecimal() Returns the sum of all non noDataValues as a BigDecimal.
protected void	initCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, double valueToInitialise) Initialises the value of the chunk referred to by chunkCellID to valueToInitialise.
protected void	initCell(int chunkCellRowIndex, int chunkCellColIndex, double 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 a Grid2DSquareCellDoubleChunkMapIterator for iterating over the cells in this.
double	setCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID, double valueToSet, double noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet
double	setCell(int chunkCellRowIndex, int chunkCellColIndex, double valueToSet, double noDataValue) Returns the value at position given by: chunk cell row chunkCellRowIndex; chunk cell column chunkCellColIndex and sets it to valueToSet
double[]	toArrayIncludingNoDataValues() Returns values in row major order as a double[].
double[]	toArrayNotIncludingNoDataValues() Returns non noDataValue in row major order as a double[].
java.lang.String	toString() Returns a description of this.

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

getArithmeticMeanBigDecimal, getCellBigDecimal, getGrid2DSquareCellDouble, getNonNoDataValueCountInt, 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

Grid2DSquareCellDoubleChunkMap

protected Grid2DSquareCellDoubleChunkMap()

Default constructor.

Grid2DSquareCellDoubleChunkMap

protected Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDouble grid2DSquareCellDouble,
                                         Grid2DSquareCellAbstract.ChunkID chunkID)

Creates a new Grid2DSquareCellDoubleChunkMap

Parameters:

grid2DSquareCellDouble -

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

Grid2DSquareCellDoubleChunkMap

protected Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDouble grid2DSquareCellDouble,
                                         Grid2DSquareCellAbstract.ChunkID chunkID,
                                         double defaultValue)

Creates a new Grid2DSquareCellDoubleChunkMap

Parameters:

grid2DSquareCellDouble -

chunkID -

defaultValue -

Grid2DSquareCellDoubleChunkMap

protected Grid2DSquareCellDoubleChunkMap(Grid2DSquareCellDoubleChunkAbstract grid2DSquareCellDoubleChunk,
                                         Grid2DSquareCellAbstract.ChunkID chunkID,
                                         double defaultValue)

Creates a new Grid2DSquareCellDoubleChunkMap

Parameters:

grid2DSquareCellDoubleChunk -

chunkID - Default: default value to grid2DSquareCellDouble.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 Grid2DSquareCellDoubleChunkAbstract

getData

public gnu.trove.TDoubleObjectHashMap getData()

Returns this.data.

clearData

public void clearData()

Clears the data associated with this.

Specified by:

clearData in class Grid2DSquareCellDoubleChunkAbstract

toArrayIncludingNoDataValues

public double[] toArrayIncludingNoDataValues()

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

Overrides:

toArrayIncludingNoDataValues in class Grid2DSquareCellDoubleChunkAbstract

toArrayNotIncludingNoDataValues

public double[] toArrayNotIncludingNoDataValues()

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

Overrides:

toArrayNotIncludingNoDataValues in class Grid2DSquareCellDoubleChunkAbstract

getCell

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

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

Specified by:

getCell in class Grid2DSquareCellDoubleChunkAbstract

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.grid2DSquareCellDouble

getCell

public double getCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID,
                      double 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.grid2DSquareCellDouble

initCell

protected void initCell(int chunkCellRowIndex,
                        int chunkCellColIndex,
                        double 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 Grid2DSquareCellDoubleChunkAbstract

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,
                        double valueToInitialise)

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

Parameters:

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

valueToInitialise - the value with which the cell is initialised

setCell

public double setCell(int chunkCellRowIndex,
                      int chunkCellColIndex,
                      double valueToSet,
                      double 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 Grid2DSquareCellDoubleChunkAbstract

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.grid2DSquareCellDouble

setCell

public double setCell(Grid2DSquareCellChunkAbstract.ChunkCellID chunkCellID,
                      double valueToSet,
                      double noDataValue)

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

Parameters:

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

valueToSet - the value the cell is to be set to

noDataValue - the noDataValue of this.grid2DSquareCellDouble

getNonNoDataValueCountBigInteger

public java.math.BigInteger getNonNoDataValueCountBigInteger()

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

Overrides:

getNonNoDataValueCountBigInteger in class Grid2DSquareCellDoubleChunkAbstract

getSumBigDecimal

public java.math.BigDecimal getSumBigDecimal()

Returns the sum of all non noDataValues as a BigDecimal.

Overrides:

getSumBigDecimal in class Grid2DSquareCellDoubleChunkAbstract

getMinDouble

public double getMinDouble()

Returns the minimum of all non noDataValues as a double.

Overrides:

getMinDouble in class Grid2DSquareCellDoubleChunkAbstract

getMaxDouble

public double getMaxDouble()

Returns the maximum of all non noDataValues as a double

Overrides:

getMaxDouble in class Grid2DSquareCellDoubleChunkAbstract

getArithmeticMeanDouble

public double getArithmeticMeanDouble()

Returns the Arithmetic Mean of all non noDataValues as a double. Using BigDecimal this should be as precise as possible with doubles.

Overrides:

getArithmeticMeanDouble in class Grid2DSquareCellDoubleChunkAbstract

getModeTDoubleHashSet

public gnu.trove.TDoubleHashSet getModeTDoubleHashSet()

For returning the mode of all non noDataValues as a TDoubleHashSet

Overrides:

getModeTDoubleHashSet in class Grid2DSquareCellDoubleChunkAbstract

getMedianDouble

public double getMedianDouble()

For returning the median of all non noDataValues as a double

Overrides:

getMedianDouble in class Grid2DSquareCellDoubleChunkAbstract

getStandardDeviationDouble

public double getStandardDeviationDouble()

For returning the standard deviation of all non noDataValues as a double

Overrides:

getStandardDeviationDouble in class Grid2DSquareCellDoubleChunkAbstract

getDiversityBigInteger

public java.math.BigInteger getDiversityBigInteger()

For returning the number of different values.

iterator

public AbstractIterator iterator()

Returns a Grid2DSquareCellDoubleChunkMapIterator for iterating over the cells in this.

Specified by:

iterator in class Grid2DSquareCellChunkAbstract