org.gvsig.geoprocess.lib.sextante.dataObjects

Class FLyrRasterIRasterLayer

java.lang.Object

es.unex.sextante.dataObjects.AbstractRasterLayer

org.gvsig.geoprocess.lib.sextante.dataObjects.FLyrRasterIRasterLayer

All Implemented Interfaces:

es.unex.sextante.dataObjects.IDataObject, es.unex.sextante.dataObjects.ILayer, es.unex.sextante.dataObjects.IRasterLayer

public class FLyrRasterIRasterLayer
extends es.unex.sextante.dataObjects.AbstractRasterLayer

A wrapper for a gvSIG Raster layer. Allows only reading, but not writing to it

Field Summary

Fields inherited from interface es.unex.sextante.dataObjects.IRasterLayer

INTERPOLATION_BicubicSpline, INTERPOLATION_Bilinear, INTERPOLATION_BSpline, INTERPOLATION_InverseDistance, INTERPOLATION_NearestNeighbour, RASTER_DATA_TYPE_BYTE, RASTER_DATA_TYPE_DOUBLE, RASTER_DATA_TYPE_FLOAT, RASTER_DATA_TYPE_INT, RASTER_DATA_TYPE_SHORT

Constructor Summary

Constructors

Constructor and Description
FLyrRasterIRasterLayer()
FLyrRasterIRasterLayer(String fName)

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the data object, which was opened using the open() method.
void	create(FLyrRaster lyr)
void	free() This method deallocates memory used by the data object.
int	getBandsCount() Returns the number of bands of the layer
Object	getBaseDataObject() Returns the base data object (i.e. the object that this class wraps, which contains the data itself)
double	getCellValueInLayerCoords(int x, int y, int iBand) Returns the value of a cell in the original image coords, that is, not using the query window.
Object	getCRS() Returns an object with information about the CRS associated to this layer.
int	getDataType() Returns the data type of the layer
Rectangle2D	getFullExtent() Returns the extent covered by the layer
double	getLayerCellSize() Return the original cellsize of the layer.
es.unex.sextante.core.AnalysisExtent	getLayerGridExtent() Returns the extent of the whole layer
String	getName() Returns the name of this data object
double	getNoDataValue() Gets the no-data value of the layer
es.unex.sextante.outputs.IOutputChannel	getOutputChannel() Returns the channel associated to this data object.
void	open() This methods initialize the data object, so it is ready to be accessed
void	postProcess() This method post-processes the object after it has been created.
void	setBaseDataObject(FLyrRaster lyr)
void	setBaseDataObject(RasterDataStore store)
void	setBaseDataObject(String fileName)
void	setCellValue(int x, int y, int iBand, double dValue) Sets the value at a cell
void	setName(String name) Sets a new name for this object
void	setNoData(int x, int y) Set the value of a cell in the first band of a layer to the no-data value
void	setNoDataValue(double dNoDataValue) Sets the no-data value of the layer
void	setWindowExtent(es.unex.sextante.core.AnalysisExtent extent) Sets a new query window extent

Methods inherited from class es.unex.sextante.dataObjects.AbstractRasterLayer

add, addToCellValue, addToCellValue, assign, assign, assignNoData, calculateHistogram, calculateStatistics, getAccumulatedHistogram, getAccumulatedHistogram, getAspect, getCellValueAsByte, getCellValueAsByte, getCellValueAsDouble, getCellValueAsDouble, getCellValueAsFloat, getCellValueAsFloat, getCellValueAsInt, getCellValueAsInt, getCellValueAsShort, getCellValueAsShort, getDirToNextDownslopeCell, getDirToNextDownslopeCell, getDistToNeighborInDir, getHistogram, getHistogram, getMaxValue, getMaxValue, getMeanValue, getMeanValue, getMinValue, getMinValue, getNX, getNY, getSlope, getSubMatrix3x3, getUnitDistToNeighborInDir, getValueAt, getValueAt, getVariance, getVariance, getWindowCellSize, getWindowGridExtent, isInWindow, isNoDataValue, multiply, setCellValue, setConstants, setFullExtent, setInterpolationMethod, setNoData, setStatisticsHaveToBeCalculated, setWindowExtent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FLyrRasterIRasterLayer

public FLyrRasterIRasterLayer()

FLyrRasterIRasterLayer

public FLyrRasterIRasterLayer(String fName)

Method Detail

create

public void create(FLyrRaster lyr)

getDataType

public int getDataType()

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Returns the data type of the layer

Returns:

the data type of the layer

setCellValue

public void setCellValue(int x,
                         int y,
                         int iBand,
                         double dValue)

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Sets the value at a cell

Parameters:

x - the x coordinate (cols)

y - the y coordinate (rows)

iBand - the band (zero-based)

dValue - the new value

setNoDataValue

public void setNoDataValue(double dNoDataValue)

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Sets the no-data value of the layer

Parameters:

dNoDataValue - the new no-data value

setNoData

public void setNoData(int x,
                      int y)

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Set the value of a cell in the first band of a layer to the no-data value

Specified by:

setNoData in interface es.unex.sextante.dataObjects.IRasterLayer

Overrides:

setNoData in class es.unex.sextante.dataObjects.AbstractRasterLayer

Parameters:

x - the x coordinate(col) of the cell to set to no-data

y - the y coordinate(row) of the cell to set to no-data

getNoDataValue

public double getNoDataValue()

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Gets the no-data value of the layer

Returns:

the no-data value of the layer

getCellValueInLayerCoords

public double getCellValueInLayerCoords(int x,
                                        int y,
                                        int iBand)

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Returns the value of a cell in the original image coords, that is, not using the query window. Ckecking that coordinates are within bounds is not needed, and is assumed to be done by methods calling this method.

Parameters:

x - the x coordinate(col) of the cell

y - the y coordinate(row) of the cell

iBand - the band to be queried

Returns:

the value of a cell in the original image coords.

getBandsCount

public int getBandsCount()

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Returns the number of bands of the layer

Returns:

the number of bands of the layer

getName

public String getName()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the name of this data object

Returns:

the name of this data object

postProcess

public void postProcess()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method post-processes the object after it has been created. If, for instance, data are kept in memory before they are dumped to file, this method should write that file.

open

public void open()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This methods initialize the data object, so it is ready to be accessed

close

public void close()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method closes the data object, which was opened using the open() method.

getFullExtent

public Rectangle2D getFullExtent()

Description copied from interface: es.unex.sextante.dataObjects.ILayer

Returns the extent covered by the layer

Returns:

the extent of the layer

getLayerGridExtent

public es.unex.sextante.core.AnalysisExtent getLayerGridExtent()

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Returns the extent of the whole layer

Returns:

the extent of the whole layer

setWindowExtent

public void setWindowExtent(es.unex.sextante.core.AnalysisExtent extent)

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Sets a new query window extent

Specified by:

setWindowExtent in interface es.unex.sextante.dataObjects.IRasterLayer

Overrides:

setWindowExtent in class es.unex.sextante.dataObjects.AbstractRasterLayer

Parameters:

extent - the new grid extent to set fro this layer

getLayerCellSize

public double getLayerCellSize()

Description copied from interface: es.unex.sextante.dataObjects.IRasterLayer

Return the original cellsize of the layer. X and Y cellsizes are assumed to be equal

Returns:

the original cellsize of the layer

getCRS

public Object getCRS()

Description copied from interface: es.unex.sextante.dataObjects.ILayer

Returns an object with information about the CRS associated to this layer. The class of this object depends on the implementation of this interface

Returns:

An object with information about the CRS used for this layer (i.e. a string with a EPSG code)

setName

public void setName(String name)

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Sets a new name for this object

Parameters:

name - the new name

free

public void free()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

This method deallocates memory used by the data object. Calling this method might render the object unusable for querying, even if the open() method is called again, so call it it use only if you are sure that the object will no longer be used.

getBaseDataObject

public Object getBaseDataObject()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the base data object (i.e. the object that this class wraps, which contains the data itself)

Returns:

the base data object

setBaseDataObject

public void setBaseDataObject(FLyrRaster lyr)

setBaseDataObject

public void setBaseDataObject(RasterDataStore store)

setBaseDataObject

public void setBaseDataObject(String fileName)

getOutputChannel

public es.unex.sextante.outputs.IOutputChannel getOutputChannel()

Description copied from interface: es.unex.sextante.dataObjects.IDataObject

Returns the channel associated to this data object.

Returns:

the channel associated to this data object.