AscRaster (ecological-engine-geospatial-extensions 1.5.3-SNAPSHOT API)

java.lang.Object
- org.gcube.dataanalysis.geo.connectors.asc.AscRaster

```
public class AscRaster
extends Object
```
Represents my best guess at the ESRI ASCII raster format. I couldn't find any sensible documentation, so it supports the following features:
- cellsize, xll and xll are stored as doubles, and largely ignored
- NDATA has a string representation (as it is typically read in from an ascii string) and is internally represented as Double.NaN, as this is safer and easier to deal with than the -9999 found in most rasters.
Author:

dmrust

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`cellsize`
`protected int`	`cols`
`protected double[][]`	`data`
`static String`	`DEFAULT_NODATA`
`protected double`	`dx`
`protected double`	`dy`
`protected String`	`NDATA`
`protected int`	`rows`
`protected double`	`xll`
`protected double`	`yll`

Constructor Summary

Constructors
Constructor and Description
`AscRaster()` Creates an empty raster
`AscRaster(double[][] data, double cellsize, double dx, double dy, double xll, double yll)` Creates a raster from the given data
`AscRaster(double cellsize, double dx, double dy, double xll, double yll)` Creates a raster from the given data
`AscRaster(int[][] data, double cellsize, double dx, double dy, double xll, double yll)` Creates a raster from the given data

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCellsize()`
`int`	`getCols()`
`double[][]`	`getData()` Returns the underlying data array - NOTE: this is NOT a copy, if you change it, you change the data
`double`	`getdx()`
`double`	`getdy()`
`double[][]`	`getInvertedAxisData()`
`String`	`getNDATA()`
`int`	`getRows()`
`static AscRaster`	`getTempRaster(double[][] data, double xll, double yll, double size)`
`static AscRaster`	`getTempRaster(double[][] data, double xll, double yll, double size, String ndata)`
`double`	`getValue(int row, int column)`
`double`	`getXll()`
`double`	`getYll()`
`void`	`init(AscRaster other)` Sets the parameters of this raster (rows, columns, corner, cellsize, NDATA etc) to be the same as the other raster.
`void`	`initData()` Initialises the Raster to Double.NaN (i.e.
`void`	`initData(double value)` Initialises the raster so the entire data array contains 'value'
`int`	`latitude2Index(double latitude)`
`int`	`longitude2Index(double longitude)`
`void`	`print()`
`void`	`setCellsize(double cellsize)`
`void`	`setData(double[][] data)` Copies the given data into the underlying data array.
`void`	`setData(int[][] data)` Copies the given data into the underlying data array.
`void`	`setdx(double dx)`
`void`	`setdy(double dy)`
`void`	`setNDATA(String nDATA)`
`void`	`setSize(int nrows, int columns)` Sets the size of the raster, and also initialises the array with NDATA
`void`	`setValue(int row, int column, double value)`
`void`	`setXll(double xll)`
`void`	`setYll(double yll)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

data
```
protected double[][] data
```

xll
```
protected double xll
```

yll
```
protected double yll
```

cellsize
```
protected double cellsize
```

dx
```
protected double dx
```

dy
```
protected double dy
```

cols
```
protected int cols
```

rows
```
protected int rows
```

DEFAULT_NODATA

public static final String DEFAULT_NODATA

See Also:: Constant Field Values

NDATA
```
protected String NDATA
```

Constructor Detail

AscRaster
```
public AscRaster()
```
Creates an empty raster

AscRaster

public AscRaster(double cellsize,
                 double dx,
                 double dy,
                 double xll,
                 double yll)

Creates a raster from the given data

Parameters:: cellsize -; xll -; yll -

AscRaster

public AscRaster(double[][] data,
                 double cellsize,
                 double dx,
                 double dy,
                 double xll,
                 double yll)

Creates a raster from the given data

Parameters:: data -; cellsize -; xll -; yll -

AscRaster

public AscRaster(int[][] data,
                 double cellsize,
                 double dx,
                 double dy,
                 double xll,
                 double yll)

Creates a raster from the given data

Parameters:: data -; cellsize -; xll -; yll -

Method Detail

print
```
public void print()
```

getTempRaster

public static AscRaster getTempRaster(double[][] data,
                                      double xll,
                                      double yll,
                                      double size)

getTempRaster

public static AscRaster getTempRaster(double[][] data,
                                      double xll,
                                      double yll,
                                      double size,
                                      String ndata)

init
```
public void init(AscRaster other)
```
Sets the parameters of this raster (rows, columns, corner, cellsize, NDATA etc) to be the same as the other raster. This includes initialising the data array with NDATAs

Parameters:

other -

initData
```
public void initData()
```
Initialises the Raster to Double.NaN (i.e. NDATA)

initData
```
public void initData(double value)
```
Initialises the raster so the entire data array contains 'value'

Parameters:

value -

getData
```
public double[][] getData()
```
Returns the underlying data array - NOTE: this is *NOT* a copy, if you change it, you change the data

Returns:

the data array

getInvertedAxisData

public double[][] getInvertedAxisData()

setValue

public void setValue(int row,
                     int column,
                     double value)

getValue

public double getValue(int row,
                       int column)

setData
```
public void setData(double[][] data)
```
Copies the given data into the underlying data array. Also updates the number of rows and columns.

Parameters:

data -

setData
```
public void setData(int[][] data)
```
Copies the given data into the underlying data array. Also updates the number of rows and columns.

Parameters:

data -

getXll
```
public double getXll()
```

setXll
```
public void setXll(double xll)
```

getYll
```
public double getYll()
```

setYll
```
public void setYll(double yll)
```

getCellsize
```
public double getCellsize()
```

setCellsize

public void setCellsize(double cellsize)

getdx
```
public double getdx()
```

setdx
```
public void setdx(double dx)
```

getdy
```
public double getdy()
```

setdy
```
public void setdy(double dy)
```

getCols
```
public int getCols()
```

getRows
```
public int getRows()
```

setSize
```
public void setSize(int nrows,
                    int columns)
```
Sets the size of the raster, and also initialises the array with NDATA

Parameters:

nrows -

columns -

getNDATA
```
public String getNDATA()
```

setNDATA
```
public void setNDATA(String nDATA)
```

longitude2Index

public int longitude2Index(double longitude)

latitude2Index

public int latitude2Index(double latitude)

Class AscRaster

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

data

xll

yll

cellsize

dx

dy

cols

rows

DEFAULT_NODATA

NDATA

Constructor Detail

AscRaster

AscRaster

AscRaster

AscRaster

Method Detail

print

getTempRaster

getTempRaster

init

initData

initData

getData

getInvertedAxisData

setValue

getValue

setData

setData

getXll

setXll

getYll

setYll

getCellsize

setCellsize

getdx

setdx

getdy

setdy

getCols

getRows

setSize

getNDATA

setNDATA

longitude2Index

latitude2Index