org.gvsig.raster.lib.buffer.api

Interface BufferManager

All Known Implementing Classes:

DefaultBufferManager

public interface BufferManager

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_BYTE
static int	TYPE_DOUBLE
static int	TYPE_FLOAT
static int	TYPE_INT
static int	TYPE_SHORT
static int	TYPE_UNDEFINED
static int	TYPE_USHORT

Method Summary

Modifier and Type	Method and Description
java.lang.Object	coerce(int dataType, java.lang.Object value)
BandPageManager	createAwtRasterBandPageManager(java.awt.image.Raster img, int band)
java.util.List<PageManager>	createAwtRasterBandPageManagerList(java.awt.image.Raster img)
Band	createBand(int dataType, int rows, int columns, NoData noData, PageManager pageManager) Creates a Band.
BandInfo	createBandInfo(int band, java.lang.String name, java.lang.String description, int dataType, java.util.List<java.util.Map.Entry<java.lang.Object,java.lang.Object>> values) Creates BandInfo with information about one band.
Buffer	createBuffer(Buffer buffer, boolean paginated) Creates a buffer from another buffer.
Buffer	createBuffer(int rows, int columns, int[] bandDataTypes, IProjection projection) Creates a memory buffer.
Buffer	createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNodata, IProjection projection) Creates a memory buffer.
Buffer	createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNodata, IProjection projection, Envelope envelope) Creates a memory buffer.
Buffer	createBuffer(int rows, int columns, int[] bandDataTypes, NoData[] bandNoData, IProjection projection, Envelope envelope, java.util.List<PageManager> pageManagers) Creates a buffer.
BufferDimensions	createBufferDimensions(int rows, int columns, Envelope envelope)
Buffer	createBufferFromAwtRaster(java.awt.image.Raster raster, IProjection projection, Envelope envelope)
Band	createClippedBand(Buffer buffer, Band band) Creates a clipping of a band.
Buffer	createClippedBuffer(Buffer buffer, Envelope envelope) Creates a buffer from clipping of a buffer.
Band	createConvertedTypeBand(Buffer buffer, Band band, int type) Create one band from another by changing the type.
Buffer	createConvertedTypeBuffer(Buffer buffer, int type) Create one buffer from another by changing the type.
Kernel	createKernel(double[][] k)
Kernel	createKernel(double[][] k, double divisor)
NoData	createNoData(java.lang.Number value, java.lang.Number defaultValue) Creates a NoData object.
java.util.List<Buffer>	createOneBufferPerBand(Buffer buffer, boolean paginated)
Buffer	createRGBABuffer(java.awt.image.BufferedImage img, IProjection projection, Envelope envelope) Creates a forced RGBA Buffer from a BufferedImage
Buffer	createRGBBuffer(java.awt.image.BufferedImage img, IProjection projection, Envelope envelope) Creates a forced RGB Buffer from a BufferedImage
PageManager	createSimpleBandPageManager(java.io.File file, int rows, int columns, int dataType)
java.util.List<PageManager>	createSimpleBandPageManagerList(java.io.File[] files, int rows, int columns, int[] dataType)
int	getBufferTypeFromAwtRaster(java.awt.image.Raster raster)
java.lang.String	getBufferTypeName(int dataType)
int	getDataTypeSize(int dataType)
java.io.File	getLastFolderUsedToSaveRaster()
java.lang.String	getTypeName(int type) Return type's name
void	setLastFolderUsedToSaveRaster(java.io.File folder)

Field Detail

TYPE_UNDEFINED

static final int TYPE_UNDEFINED

See Also:

Constant Field Values

TYPE_BYTE

static final int TYPE_BYTE

See Also:

Constant Field Values

TYPE_USHORT

static final int TYPE_USHORT

See Also:

Constant Field Values

TYPE_SHORT

static final int TYPE_SHORT

See Also:

Constant Field Values

TYPE_INT

static final int TYPE_INT

See Also:

Constant Field Values

TYPE_FLOAT

static final int TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DOUBLE

static final int TYPE_DOUBLE

See Also:

Constant Field Values

Method Detail

createNoData

NoData createNoData(java.lang.Number value,
                    java.lang.Number defaultValue)

Creates a NoData object.

Parameters:

value -

defaultValue -

Returns:

NoData

createBandInfo

BandInfo createBandInfo(int band,
                        java.lang.String name,
                        java.lang.String description,
                        int dataType,
                        java.util.List<java.util.Map.Entry<java.lang.Object,java.lang.Object>> values)

Creates BandInfo with information about one band.

Parameters:

band - Band of this BandInfo

name - Band name

description - Description of band

dataType - Data type of band. See BufferManager to check types.

values - A key-value map with information properties about band

Returns:

BandInfo

createBand

Band createBand(int dataType,
                int rows,
                int columns,
                NoData noData,
                PageManager pageManager)
         throws BandException

Creates a Band. If PageManager is null, the band will be in memory, otherwise, the band will be paginated using page manager.

Parameters:

dataType - Type of band. Check BufferManager to see what types are available

rows - Band rows

columns - Band columns

noData - NoData of band. If It is null, a undefined NoData will be set.

pageManager - Page manager to paginate band. It page manager is null, band will be in memory.

Returns:

Band A empty band.

Throws:

BandException - If there are problems creating the band.

See Also:

createNoData(Number, Number), BufferManager#createBandInfo(String, String, List), createSimpleBandPageManager(File, int, int, int)

createBuffer

Buffer createBuffer(int rows,
                    int columns,
                    int[] bandDataTypes,
                    IProjection projection)
             throws BufferException

Creates a memory buffer.

Parameters:

rows - Rows of buffer. All buffer bands will have the same rows as buffer.

columns - Columns of buffer. All buffer bands will have the same columns as buffer.

bandDataTypes - Types of buffer bands, see BufferManager to get types. The length of array indicates number of buffer bands.

projection - Projection of buffer.

Returns:

Buffer

Throws:

BufferException - If there is any problem creating buffer.

createBuffer

Buffer createBuffer(int rows,
                    int columns,
                    int[] bandDataTypes,
                    NoData[] bandNodata,
                    IProjection projection)
             throws BufferException

Creates a memory buffer.

Parameters:

rows - Rows of buffer. All buffer bands will have the same rows as buffer.

columns - Columns of buffer. All buffer bands will have the same columns as buffer.

bandDataTypes - Types of buffer bands, see BufferManager to get types. The length of array indicates number of buffer bands.

bandNodata - NoData of each band. It can be null. If there are bands without NoData object, a undefined NoData will be set.

projection - Projection of buffer.

Returns:

Buffer

Throws:

BufferException - If there is any problem creating buffer.

createBuffer

Buffer createBuffer(int rows,
                    int columns,
                    int[] bandDataTypes,
                    NoData[] bandNodata,
                    IProjection projection,
                    Envelope envelope)
             throws BufferException

Creates a memory buffer.

Parameters:

rows - Rows of buffer. All buffer bands will have the same rows as buffer.

columns - Columns of buffer. All buffer bands will have the same columns as buffer.

bandDataTypes - Types of buffer bands, see BufferManager to get types. The length of array indicates number of buffer bands.

bandNodata - NoData of each band. If there are bands without NoData object, a undefined NoData will be set. It can be null.

projection - Projection of buffer.

envelope - Envelope of data. It can be null.

Returns:

Buffer

Throws:

BufferException - If there is any problem creating buffer.

createBuffer

Buffer createBuffer(int rows,
                    int columns,
                    int[] bandDataTypes,
                    NoData[] bandNoData,
                    IProjection projection,
                    Envelope envelope,
                    java.util.List<PageManager> pageManagers)
             throws BufferException

Creates a buffer. Buffer bands will be paginated using BandPageManager.

Parameters:

rows - Rows of buffer. All buffer bands will have the same rows as buffer.

columns - Columns of buffer. All buffer bands will have the same columns as buffer.

bandDataTypes - Types of buffer bands, see BufferManager to get types. The length of array indicates number of buffer bands.

bandNoData - NoData of each band. If there are bands without NoData object, a undefined NoData will be set. It can be null.

projection - Projection of buffer.

envelope - Envelope of data. It can be null.

pageManagers - Page manager list to paginate data bands. If there are bands without page manager, they will be loaded at memory.

Returns:

Buffer

Throws:

BufferException - If there is any problem creating buffer.

createBuffer

Buffer createBuffer(Buffer buffer,
                    boolean paginated)
             throws BufferException

Creates a buffer from another buffer. If paginated parameter is false the buffer bands will be in memory. If paginated parameter is true the buffer bands will be paginated using a simple band page manager.

Parameters:

buffer -

paginated -

Returns:

Buffer

Throws:

BufferException

createConvertedTypeBuffer

Buffer createConvertedTypeBuffer(Buffer buffer,
                                 int type)
                          throws BufferException

Create one buffer from another by changing the type. The returned buffer will be like a view of the original buffer. It not reserve additional memory.

Parameters:

buffer -

type -

Returns:

a converted type buffer

Throws:

BufferException

createClippedBuffer

Buffer createClippedBuffer(Buffer buffer,
                           Envelope envelope)
                    throws BufferException

Creates a buffer from clipping of a buffer. The returned clipping will be like a view of the original buffer. It not reserve additional memory. It will only be a walkway to access an area of the buffer.

Parameters:

buffer -

envelope -

Returns:

a clip buffer

Throws:

BufferException

createSimpleBandPageManager

PageManager createSimpleBandPageManager(java.io.File file,
                                        int rows,
                                        int columns,
                                        int dataType)
                                 throws java.io.IOException

Parameters:

file -

rows -

columns -

dataType -

Returns:

BandPageManager

Throws:

java.io.IOException

createSimpleBandPageManagerList

java.util.List<PageManager> createSimpleBandPageManagerList(java.io.File[] files,
                                                            int rows,
                                                            int columns,
                                                            int[] dataType)
                                                     throws java.io.IOException

Parameters:

files -

rows -

columns -

dataType -

Returns:

A list of page managers

Throws:

java.io.IOException

getDataTypeSize

int getDataTypeSize(int dataType)

Parameters:

dataType - Data tpye

Returns:

Data type size in bytes

createClippedBand

Band createClippedBand(Buffer buffer,
                       Band band)
                throws BandException

Creates a clipping of a band. The returned clipping will be like a view of the original band. It not reserve additional memory. It will only be a walkway to access an area of the band.

Parameters:

buffer -

band -

Returns:

Band

Throws:

BandException

createConvertedTypeBand

Band createConvertedTypeBand(Buffer buffer,
                             Band band,
                             int type)
                      throws BandException

Create one band from another by changing the type. The returned clipping will be like a view of the original band. It not reserve additional memory.

Parameters:

buffer -

band -

type -

Returns:

Band

Throws:

BandException

createRGBABuffer

Buffer createRGBABuffer(java.awt.image.BufferedImage img,
                        IProjection projection,
                        Envelope envelope)
                 throws BufferException

Creates a forced RGBA Buffer from a BufferedImage

Parameters:

img -

projection -

envelope -

Returns:

Buffer

Throws:

BufferException

createRGBBuffer

Buffer createRGBBuffer(java.awt.image.BufferedImage img,
                       IProjection projection,
                       Envelope envelope)
                throws BufferException

Creates a forced RGB Buffer from a BufferedImage

Parameters:

img -

projection -

envelope -

Returns:

Buffer

Throws:

BufferException

getTypeName

java.lang.String getTypeName(int type)

Return type's name

Parameters:

type -

Returns:

getBufferTypeName

java.lang.String getBufferTypeName(int dataType)

Parameters:

dataType -

Returns:

coerce

java.lang.Object coerce(int dataType,
                        java.lang.Object value)
                 throws CoercionException

Throws:

CoercionException

createOneBufferPerBand

java.util.List<Buffer> createOneBufferPerBand(Buffer buffer,
                                              boolean paginated)
                                       throws BufferException

Throws:

BufferException

createBufferDimensions

BufferDimensions createBufferDimensions(int rows,
                                        int columns,
                                        Envelope envelope)

Parameters:

rows -

columns -

envelope -

Returns:

setLastFolderUsedToSaveRaster

void setLastFolderUsedToSaveRaster(java.io.File folder)

Parameters:

folder -

getLastFolderUsedToSaveRaster

java.io.File getLastFolderUsedToSaveRaster()

Returns:

createKernel

Kernel createKernel(double[][] k)

createKernel

Kernel createKernel(double[][] k,
                    double divisor)

createAwtRasterBandPageManagerList

java.util.List<PageManager> createAwtRasterBandPageManagerList(java.awt.image.Raster img)
                                                        throws java.io.IOException

Parameters:

img -

Returns:

Throws:

java.io.IOException

createAwtRasterBandPageManager

BandPageManager createAwtRasterBandPageManager(java.awt.image.Raster img,
                                               int band)

Parameters:

img -

band -

Returns:

getBufferTypeFromAwtRaster

int getBufferTypeFromAwtRaster(java.awt.image.Raster raster)

Parameters:

raster -

Returns:

createBufferFromAwtRaster

Buffer createBufferFromAwtRaster(java.awt.image.Raster raster,
                                 IProjection projection,
                                 Envelope envelope)
                          throws java.io.IOException,
                                 BufferException

Parameters:

raster -

projection -

envelope -

Returns:

Throws:

java.io.IOException

BufferException