org.gvsig.raster.lib.buffer.api

Interface Band

All Superinterfaces:

java.lang.Cloneable, ComplexObservable, ComplexWeakReferencingObservable, Disposable, Observable, WeakReferencingObservable

All Known Subinterfaces:

Band.BandByte, Band.BandDouble, Band.BandFloat, Band.BandInt, Band.BandShort

All Known Implementing Classes:

AbstractBand, AbstractClippedBand, AbstractConvertedTypeBand, AbstractPaginatedBand, AbstractTiledBand, ClippedBandByte, ClippedBandDouble, ClippedBandFloat, ClippedBandInt, ClippedBandShort, ConvertedTypeBandByte, ConvertedTypeBandDouble, ConvertedTypeBandFloat, ConvertedTypeBandInt, ConvertedTypeBandShort, MemoryBandByte, MemoryBandDouble, MemoryBandFloat, MemoryBandInt, MemoryBandShort, PaginatedBandByte, PaginatedBandDouble, PaginatedBandFloat, PaginatedBandInt, PaginatedBandShort, TiledBandByte, TiledBandDouble, TiledBandFloat, TiledBandInt, TiledBandShort

public interface Band
extends Cloneable, ComplexWeakReferencingObservable, Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Band.BandByte A Band which elements are bytes.
static interface	Band.BandDouble A Band which elements are doubles.
static interface	Band.BandFloat A Band which elements are floats.
static interface	Band.BandInt A Band which elements are integers.
static interface	Band.BandShort A Band which elements are shorts.

Method Summary

Modifier and Type	Method and Description
void	copyFrom(Band source) Fills this band with a copy of the source data band.
void	copyFrom(Band source, int row, int column) Fills a sector of this band with a copy of the source band data from a position.
java.lang.Object	createRowBuffer() Creates an array of corresponding data type.
void	fetchRow(int row, java.lang.Object rowBuffer) Fills the rowBuffer Object with the row.
void	fill(java.lang.Object value) Fills the band with a unique value.
java.lang.Object	get(int row, int column) Gets the corresponding value to a row and column of the band
java.lang.Double	getAsDouble(int row, int column) Gets the corresponding value to a row and column of the band as a Double.
BandInfo	getBandInfo() Gets information about the specified band.
int	getColumns() Gets the number of columns of the band
int	getDataType() Gets the dataType.
NoData	getNoData() Gets the NoData value
int	getRows() Gets the number of rows of the band
boolean	isPaginated()
boolean	isReadOnly()
void	putRow(int row, java.lang.Object rowBuffer) Fills the row with the rowBuffer
void	set(int row, int column, java.lang.Object value) Set the value in the row and column of the band.

Methods inherited from interface org.gvsig.tools.lang.Cloneable

clone, cloneQuietly, cloneQuietly

Methods inherited from interface org.gvsig.tools.observer.ComplexObservable

beginComplexNotification, disableNotifications, enableNotifications, endComplexNotification

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Method Detail

getColumns

int getColumns()

Gets the number of columns of the band

Returns:

the number of columns of the band

getRows

int getRows()

Gets the number of rows of the band

Returns:

the number of rows of the band

getDataType

int getDataType()

Gets the dataType. The possible data types are defined in BufferManager. The data type of the band can't be changed after being created.

Returns:

the data type

getNoData

NoData getNoData()

Gets the NoData value

Returns:

the noData of the band. Can't be null;

get

java.lang.Object get(int row,
                     int column)

Gets the corresponding value to a row and column of the band

Parameters:

row -

column -

Returns:

value of corresponding data type.

getAsDouble

java.lang.Double getAsDouble(int row,
                             int column)

Gets the corresponding value to a row and column of the band as a Double. return null if the value is the NoData value.

Parameters:

row -

column -

Returns:

set

void set(int row,
         int column,
         java.lang.Object value)

Set the value in the row and column of the band.

Parameters:

row -

column -

value -

fill

void fill(java.lang.Object value)

Fills the band with a unique value. If the value is null, fills with NoData value. If NoData is undefined, do nothing.

Parameters:

value -

copyFrom

void copyFrom(Band source)
       throws BandException

Fills this band with a copy of the source data band.

Parameters:

source -

Throws:

BandException

copyFrom

void copyFrom(Band source,
              int row,
              int column)
       throws BandException

Fills a sector of this band with a copy of the source band data from a position.

Parameters:

source -

row -

column -

Throws:

BandException

createRowBuffer

java.lang.Object createRowBuffer()

Creates an array of corresponding data type. The size of the array is the width of the band.

Returns:

an array of corresponding data type.

fetchRow

void fetchRow(int row,
              java.lang.Object rowBuffer)

Fills the rowBuffer Object with the row.

Parameters:

row -

rowBuffer -

putRow

void putRow(int row,
            java.lang.Object rowBuffer)

Fills the row with the rowBuffer

Parameters:

row -

rowBuffer -

isPaginated

boolean isPaginated()

Returns:

true if is paginated

isReadOnly

boolean isReadOnly()

Returns:

If supports writing or not

getBandInfo

BandInfo getBandInfo()

Gets information about the specified band. If band does not have information, it will return null

Parameters:

band - The specified band

Returns:

Returns information about specified band.