org.gvsig.raster.lib.buffer.api

Interface Buffer

All Superinterfaces:

Disposable, java.lang.Iterable<Band>, Observable, Observer, StatisticsCapable, WeakReferencingObservable

All Known Subinterfaces:

RasterSet

All Known Implementing Classes:

AbstractBuffer, ClippedBuffer, ConvertedTypeBuffer, DefaultBuffer, DefaultRasterSet

public interface Buffer
extends StatisticsCapable, java.lang.Iterable<Band>, Observer, Disposable

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTERPOLATION_BicubicSpline
static int	INTERPOLATION_Bilinear
static int	INTERPOLATION_BSpline
static int	INTERPOLATION_InverseDistance
static int	INTERPOLATION_NearestNeighbour
static int	INTERPOLATION_Undefined

Method Summary

Modifier and Type	Method and Description
void	addBand(Band band) Adds a band
boolean	areAllBandsOfTheSameType()
Buffer	clip(Envelope envelope)
Buffer	convert(ICoordTrans ct, SimpleTaskStatus status) Converts buffer using specified coordinate transformation
Buffer	createInterpolated(int rows, int columns, int interpolationMode, SimpleTaskStatus status) Creates a interpolated buffer
Band	getBand(int pos) Gets the band in the "pos" position
Band.BandByte	getBandByte(int pos)
int	getBandCount()
Band.BandDouble	getBandDouble(int pos)
Band.BandFloat	getBandFloat(int pos)
Band.BandInt	getBandInt(int pos)
NoData[]	getBandNoData()
Band[]	getBands()
Band.BandShort	getBandShort(int pos)
BandInfo[]	getBandsInfo()
int[]	getBandTypes()
java.awt.image.BufferedImage	getBufferedImage()
int	getColumns()
BufferDimensions	getDimensions()
Envelope	getEnvelope()
double	getPixelSizeX() Deprecated. use getDimensions().getPixelSizeX()
double	getPixelSizeY() Deprecated. use getDimensions().getPixelSizeY()
IProjection	getProjection()
int	getRows()
boolean	isInside(int cellX, int cellY) Returns true if passed as parameter cell is inside of the buffer, else returns false.
boolean	isInside(Point point) Returns true if passed as parameter point is inside of the buffer, else returns false.
void	removeBand(int pos) Removes the band in the "pos" position
void	setBand(int pos, Band band) Sets a band in the "pos" position
void	switchBands(int[] positions) Switches the bands as indicated by the parameter
void	switchBands(int pos1, int pos2) Switches two bands

Methods inherited from interface org.gvsig.raster.lib.buffer.api.statistics.StatisticsCapable

getStatistics

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

addObserver, deleteObserver, deleteObservers

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

update

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

dispose

Field Detail

INTERPOLATION_Undefined

static final int INTERPOLATION_Undefined

See Also:

Constant Field Values

INTERPOLATION_NearestNeighbour

static final int INTERPOLATION_NearestNeighbour

See Also:

Constant Field Values

INTERPOLATION_Bilinear

static final int INTERPOLATION_Bilinear

See Also:

Constant Field Values

INTERPOLATION_InverseDistance

static final int INTERPOLATION_InverseDistance

See Also:

Constant Field Values

INTERPOLATION_BicubicSpline

static final int INTERPOLATION_BicubicSpline

See Also:

Constant Field Values

INTERPOLATION_BSpline

static final int INTERPOLATION_BSpline

See Also:

Constant Field Values

Method Detail

getBandCount

int getBandCount()

Returns:

Number of buffer bands

getBands

Band[] getBands()

Returns:

Bands of buffer

getBandsInfo

BandInfo[] getBandsInfo()

getColumns

int getColumns()

Returns:

the number of columns

getRows

int getRows()

Returns:

the number of rows

getEnvelope

Envelope getEnvelope()
              throws LocatorException,
                     CreateEnvelopeException

Returns:

Envelope of this buffer

Throws:

CreateEnvelopeException

LocatorException

getProjection

IProjection getProjection()

Returns:

Projection of buffer

isInside

boolean isInside(int cellX,
                 int cellY)

Returns true if passed as parameter cell is inside of the buffer, else returns false.

Parameters:

cellX - Cell's x position

cellY - Cell's y position

Returns:

true if cell is inside, false if it is outside

isInside

boolean isInside(Point point)

Returns true if passed as parameter point is inside of the buffer, else returns false.

Parameters:

point -

Returns:

true if point is inside of this

addBand

void addBand(Band band)

Adds a band

Parameters:

band -

setBand

void setBand(int pos,
             Band band)
      throws BandException

Sets a band in the "pos" position

Parameters:

pos -

band -

Throws:

BandException

removeBand

void removeBand(int pos)

Removes the band in the "pos" position

Parameters:

pos -

getBand

Band getBand(int pos)

Gets the band in the "pos" position

Parameters:

pos -

Returns:

return the band in the "pos" position

getBandByte

Band.BandByte getBandByte(int pos)

Parameters:

pos -

Returns:

return the band in the "pos" position if the band is of type byte

getBandShort

Band.BandShort getBandShort(int pos)

Parameters:

pos -

Returns:

return the band in the "pos" position if the band is of type short

getBandInt

Band.BandInt getBandInt(int pos)

Parameters:

pos -

Returns:

return the band in the"pos" position if the band is of type int

getBandFloat

Band.BandFloat getBandFloat(int pos)

Parameters:

pos -

Returns:

return the band in the "pos" position if the band is of type float

getBandDouble

Band.BandDouble getBandDouble(int pos)

Parameters:

pos -

Returns:

return the band in the "pos" position if the band is of type double

switchBands

void switchBands(int[] positions)

Switches the bands as indicated by the parameter

Parameters:

positions -

switchBands

void switchBands(int pos1,
                 int pos2)

Switches two bands

Parameters:

pos1 -

pos2 -

createInterpolated

Buffer createInterpolated(int rows,
                          int columns,
                          int interpolationMode,
                          SimpleTaskStatus status)
                   throws LocatorException,
                          BufferException

Creates a interpolated buffer

Parameters:

rows -

columns -

interpolationMode -

status -

Returns:

a interpolated Buffer according the interpolation mode

Throws:

BufferException

LocatorException

convert

Buffer convert(ICoordTrans ct,
               SimpleTaskStatus status)
        throws BufferException

Converts buffer using specified coordinate transformation

Parameters:

ct - Coordinate transformation to convert buffer

status -

Returns:

New converted buffer.

Throws:

BufferException - If there are problems converting buffer

getBandTypes

int[] getBandTypes()

Returns:

Gets band types of buffer bands

areAllBandsOfTheSameType

boolean areAllBandsOfTheSameType()

getBandNoData

NoData[] getBandNoData()

Returns:

Gets NoData object from buffer bands

clip

Buffer clip(Envelope envelope)
     throws BufferException

Parameters:

envelope -

Returns:

A clip of buffer

Throws:

BufferException

getPixelSizeX

double getPixelSizeX()

Deprecated. use getDimensions().getPixelSizeX()

Returns:

Returns X pixel of this buffer.

getPixelSizeY

double getPixelSizeY()

Deprecated. use getDimensions().getPixelSizeY()

Returns:

Returns Y pixel of this buffer.

getBufferedImage

java.awt.image.BufferedImage getBufferedImage()

Returns:

getDimensions

BufferDimensions getDimensions()

Returns: