A raster (stored in memory and eventually swapped to disk) where it is possible to dynamically add lines/columns/bands. More...

#include <ExpansibleRaster.h>

Inheritance diagram for te::mem::ExpansibleRaster:

Public Member Functions
bool	addBottomBands (const unsigned int number)
	New bands will be added at the bottom of the raster (after de the last band). More...

bool	addBottomLines (const unsigned int number)
	New lines will be added at the bottom of the raster (after de the last line). More...

bool	addLeftColumns (const unsigned int number)
	New columns will be added at the left of the raster (before the first column). More...

bool	addRightColumns (const unsigned int number)
	New columns will be added at the right of the raster (after the last column). More...

bool	addTopBands (const unsigned int number)
	New bands will be added at the top of the raster (before the first band). More...

bool	addTopLines (const unsigned int number)
	New lines will be added at the top of the raster (before the first line). More...

Raster &	callOperator (std::complex< double >(*f)(std::complex< double >, std::complex< double >), const Raster &rhs)
	It calls a parameter function f to apply in all pixels from two rasters, e.g. pixel = f(lhs, rhs);. More...

te::dt::AbstractData *	clone () const
	It returns a clone of this object. More...

bool	createMultiResolution (const unsigned int levels, const te::rst::InterpolationMethod interpMethod)
	Create a sub-sampled multi-resolution pyramid. More...

	ExpansibleRaster ()

	ExpansibleRaster (const unsigned char maxMemPercentUsed, te::rst::Grid grid, const std::vector< te::rst::BandProperty > bandsProperties)
	Constructor. More...

	ExpansibleRaster (te::rst::Grid grid, const std::vector< te::rst::BandProperty > bandsProperties, const unsigned int maxNumberOfRAMBlocks)
	Constructor. More...

te::common::AccessPolicy	getAccessPolicy () const
	Returns the raster access policy. More...

const te::rst::Band *	getBand (std::size_t i) const
	Returns the raster i-th band. More...

te::rst::Band *	getBand (std::size_t i)
	Returns the raster i-th band. More...

int	getBandDataType (std::size_t i) const
	Returns the data type in a particular band (or dimension). More...

te::gm::Envelope *	getExtent ()
	Returns the geographic extension of the raster data. More...

const te::gm::Envelope *	getExtent () const
	Returns the geographic extension of the raster data. More...

te::gm::Envelope *	getExtent (int srid, te::gm::Envelope *roi=0) const
	Returns the geographic extension of the raster data, in a given SRS (distinct from its original one). More...

Grid *	getGrid ()
	It returns the raster grid. More...

const Grid *	getGrid () const
	It returns the raster grid. More...

std::map< std::string, std::string >	getInfo () const
	It returns additional information about the raster. More...

virtual void	getIValue (unsigned int c, unsigned int r, double &value, std::size_t b=0) const
	Returns the imaginary attribute value in a complex band of a cell. More...

te::rst::Raster *	getMultiResLevel (const unsigned int level) const
	Returns the required level of a multi-resolution pyramid or NULL if that level does not exists. More...

unsigned int	getMultiResLevelsCount () const
	Returns the current number of multi-resolution pyramid levels. More...

const std::string &	getName () const
	Returns the raster name. More...

std::size_t	getNumberOfBands () const
	Returns the number of bands (dimension of cells attribute values) in the raster. More...

unsigned int	getNumberOfColumns () const
	Returns the raster number of columns. More...

unsigned int	getNumberOfRows () const
	Returns the raster number of rows. More...

Grid *	getResampledGrid (int scale) const
	Return the raster grid for a specific scale. More...

double	getResolutionX () const
	Returns the raster horizontal (x-axis) resolution. More...

double	getResolutionY () const
	Returns the raster vertical (y-axis) resolution. More...

int	getSRID () const
	Returns the raster spatial reference system identifier. More...

int	getTypeCode () const
	It returns the data type code associated to the data value. More...

virtual void	getValue (unsigned int c, unsigned int r, double &value, std::size_t b=0) const
	Returns the attribute value of a band of a cell. More...

virtual void	getValue (unsigned int c, unsigned int r, std::complex< double > &value, std::size_t b=0) const
	Returns the imaginary attribute value in a complex band of a cell. More...

virtual void	getValues (unsigned int c, unsigned int r, std::vector< double > &values) const
	Returns the imaginary attribute values in all complex bands of a cell. More...

virtual void	getValues (unsigned int c, unsigned int r, std::vector< std::complex< double > > &values) const
	Returns the imaginary attribute values in all complex bands of a cell. More...

void	open (const std::map< std::string, std::string > &rinfo, te::common::AccessPolicy p=te::common::RAccess)
	Opens a raster. More...

virtual Raster &	operator*= (Raster &rhs)
	It returns the raster product (pixel by pixel). More...

virtual Raster &	operator*= (std::complex< double > &cvalue)
	It returns the product of a constant value to all pixels in the raster. More...

virtual Raster &	operator+= (Raster &rhs)
	It returns the raster sum (pixel by pixel). More...

virtual Raster &	operator+= (std::complex< double > &cvalue)
	It returns the sum of a constant value to all pixels in the raster. More...

virtual Raster &	operator-= (Raster &rhs)
	It returns the raster subtraction (pixel by pixel). More...

virtual Raster &	operator-= (std::complex< double > &cvalue)
	It returns the difference from all pixels in the raster to a constant value (pixels - constant). More...

virtual Raster &	operator/= (Raster &rhs)
	It returns the raster division (pixel by pixel). More...

virtual Raster &	operator/= (std::complex< double > &cvalue)
	It returns the division of all pixels in the raster by a constant value (pixels / constant). More...

const te::rst::Band &	operator[] (std::size_t i) const
	Access band in i position. More...

te::rst::Band &	operator[] (std::size_t i)
	Access band in i position. More...

virtual void	rasterize (std::vector< te::gm::Geometry * > g, std::vector< double > vp, std::size_t b=0)
	Rasterizes a given vector of geometries. More...

bool	removeMultiResolution ()
	Remove/Destroy a sub-sampled multi-resolution pyramid, if there is one. More...

virtual Raster *	resample (int method, unsigned int drow, unsigned int dcolumn, unsigned int height, unsigned int width, unsigned int newheight, unsigned int newwidth, const std::map< std::string, std::string > &rinfo) const
	Resample a subset of the raster, given a box. More...

virtual Raster *	resample (int method, int scale, const std::map< std::string, std::string > &rinfo) const
	Resample raster. More...

void	setAccessPolicy (te::common::AccessPolicy p)
	Sets the raster access policy. More...

virtual void	setIValue (unsigned int c, unsigned int r, const double value, std::size_t b=0)
	Sets the imaginary attribute value in a complex band of a cell. More...

void	setName (const std::string name)
	Sets the raster name. More...

virtual void	setValue (unsigned int c, unsigned int r, const double value, std::size_t b=0)
	Sets the attribute value in a band of a cell. More...

virtual void	setValue (unsigned int c, unsigned int r, const std::complex< double > &value, std::size_t b=0)
	Sets the imaginary attribute value in a complex band of a cell. More...

virtual void	setValues (unsigned int c, unsigned int r, const std::vector< double > &values)
	Sets the imaginary attribute values in all complex bands of a cell. More...

virtual void	setValues (unsigned int c, unsigned int r, const std::vector< std::complex< double > > &values)
	Sets the imaginary attribute values in all complex bands of a cell. More...

std::string	toString (void) const
	It returns the data value in a string notation. More...

virtual Raster *	transform (int srid, const std::map< std::string, std::string > &rinfo, int m=1) const
	Reprojects this raster to a distinct SRS. This method reprojects this raster to a distinct SRS. The output resolution is calculated in order to maintain the same number of pixels as in this raster. More...

virtual Raster *	transform (int srid, double llx, double lly, double urx, double ury, const std::map< std::string, std::string > &rinfo, int m=1) const
	Reprojects a squared portion of this raster to a distinct SRS. This method reprojects a squared portion of this raster to a distinct SRS. The output resolution is calculated in order to maintain the same number of pixels as in the desired portion of this raster. More...

virtual Raster *	transform (int srid, double llx, double lly, double urx, double ury, double resx, double resy, const std::map< std::string, std::string > &rinfo, int m=1) const
	Reprojects a squared portion of this raster to another SRS with a desired resolution. More...

virtual Raster *	trim (const te::gm::Envelope *env, const std::map< std::string, std::string > &rinfo) const
	Subsetting operation for trimming (cropping) the raster. More...

virtual void	vectorize (std::vector< te::gm::Geometry * > &g, std::size_t b, unsigned int mp=0)
	Vectorizes a given raster band, using GDALPolygonize function. More...

	~ExpansibleRaster ()

Protected Member Functions
double	applyScale (int i, const double &v) const
	Scales a value according to a specific resampling scale. More...

void	dummyFillAllBlocks ()
	Fill all blocks with dummy values. More...

void	dummyFillBlocks (const std::vector< ExpansibleBandBlocksManager::BlockIndex3D > &blocksCoords)
	Fill the required blocks with dummy values. More...

	ExpansibleRaster (ExpansibleRaster &rhs)
	Constructor from other expansible raster instance. More...

	ExpansibleRaster (const te::rst::Raster &rhs)
	Constructor from other expansible raster instance. More...

void	free ()
	Free all allocated internal resources and go back to the initial state. More...

Protected Attributes
std::vector< ExpansibleBand * >	m_bands
	Internal raster bands. More...

boost::shared_ptr< ExpansibleBandBlocksManager >	m_blocksManagerPtr
	Internal blocks manager. More...

Grid *	m_grid
	The spatial support for raster data. More...

std::vector< boost::shared_ptr< ExpansibleRaster > >	m_multiResRasters
	Pointer to Multi-resolution versions of this raster instance. More...

std::string	m_name
	The raster name. More...

te::common::AccessPolicy	m_policy
	The access policy, can be te::common::{NoAccess, RAccess, RWAccess, WAccess}. More...

Private Member Functions
	ExpansibleRaster (te::rst::Grid *grid, te::common::AccessPolicy p=te::common::RAccess)

Detailed Description

A raster (stored in memory and eventually swapped to disk) where it is possible to dynamically add lines/columns/bands.

Note: The first band blocking scheme will be taken as reference for the other bands.; Adding lines/columns may add extra lines/columns to correctly fit the internal blocking structure.; The geographic limits will be automatically adjust following the requested expansion.

Definition at line 61 of file ExpansibleRaster.h.

Constructor & Destructor Documentation

te::mem::ExpansibleRaster::ExpansibleRaster ( )

te::mem::ExpansibleRaster::ExpansibleRaster	(	const unsigned char	maxMemPercentUsed,
		te::rst::Grid *	grid,
		const std::vector< te::rst::BandProperty * >	bandsProperties
	)

Constructor.

Parameters

maxMemPercentUsed	The maximum free memory percentual to use valid range: [1:100].
grid	The grid definition. The Raster will take its ownership.
bandsProperties	The bands propeties (the raster will take their ownership);

te::mem::ExpansibleRaster::ExpansibleRaster	(	te::rst::Grid *	grid,
		const std::vector< te::rst::BandProperty * >	bandsProperties,
		const unsigned int	maxNumberOfRAMBlocks
	)

Constructor.

Parameters

grid	The grid definition. The Raster will take its ownership.
bandsProperties	The bands propeties (the raster will take their ownership);
maxNumberOfRAMBlocks	The maximum number of RAM blocks.

te::mem::ExpansibleRaster::~ExpansibleRaster ( )

te::mem::ExpansibleRaster::ExpansibleRaster ( ExpansibleRaster & rhs )

protected

Constructor from other expansible raster instance.

Parameters

other The other expansible raster instance.

Note: Both instances will share the same blocks manager instance.

te::mem::ExpansibleRaster::ExpansibleRaster ( const te::rst::Raster & rhs )

protected

Constructor from other expansible raster instance.

Parameters

other The other expansible raster instance.

Note: Both instances will share the same blocks manager instance.

te::mem::ExpansibleRaster::ExpansibleRaster	(	te::rst::Grid *	grid,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

private

Member Function Documentation

bool te::mem::ExpansibleRaster::addBottomBands ( const unsigned int number )

New bands will be added at the bottom of the raster (after de the last band).

Parameters

number The number of bands to add.

Returns: true if OK, false on errors.

bool te::mem::ExpansibleRaster::addBottomLines ( const unsigned int number )

New lines will be added at the bottom of the raster (after de the last line).

Parameters

number The number of lines to add.

Returns: true if OK, false on errors.

bool te::mem::ExpansibleRaster::addLeftColumns ( const unsigned int number )

New columns will be added at the left of the raster (before the first column).

Parameters

number The number of columns to add.

Returns: true if OK, false on errors.

bool te::mem::ExpansibleRaster::addRightColumns ( const unsigned int number )

New columns will be added at the right of the raster (after the last column).

Parameters

number The number of columns to add.

Returns: true if OK, false on errors.

bool te::mem::ExpansibleRaster::addTopBands ( const unsigned int number )

New bands will be added at the top of the raster (before the first band).

Parameters

number The number of bands to add.

Returns: true if OK, false on errors.

bool te::mem::ExpansibleRaster::addTopLines ( const unsigned int number )

New lines will be added at the top of the raster (before the first line).

Parameters

number The number of lines to add.

Returns: true if OK, false on errors.

double te::rst::Raster::applyScale	(	int	i,
		const double &	v
	)		const

protectedinherited

Scales a value according to a specific resampling scale.

Parameters

i	The scale to apply.
v	The value to be scaled.

Returns: The scaled value.

Raster& te::rst::Raster::callOperator	(	std::complex< double >(*)(std::complex< double >, std::complex< double >)	f,
		const Raster &	rhs
	)

inherited

It calls a parameter function f to apply in all pixels from two rasters, e.g. pixel = f(lhs, rhs);.

Parameters

(*f)	a function with the signature complex<double>(*f)(complex<double>, complex<double>), const Raster& rhs)
rhs	The rhs raster to apply the function.

Returns: The resultant raster.

te::dt::AbstractData* te::mem::ExpansibleRaster::clone ( ) const

virtual

It returns a clone of this object.

Returns: A clone of this object.

Implements te::dt::AbstractData.

bool te::mem::ExpansibleRaster::createMultiResolution	(	const unsigned int	levels,
		const te::rst::InterpolationMethod	interpMethod
	)

virtual

Create a sub-sampled multi-resolution pyramid.

Parameters

levels	The number of pyramid levels to generate.
interpMethod	The used interpolation method.

Returns: true if OK, false if errors ocurred.

Implements te::rst::Raster.

void te::mem::ExpansibleRaster::dummyFillAllBlocks ( )

protected

Fill all blocks with dummy values.

void te::mem::ExpansibleRaster::dummyFillBlocks ( const std::vector< ExpansibleBandBlocksManager::BlockIndex3D > & blocksCoords )

protected

Fill the required blocks with dummy values.

Parameters

blocksCoords The blocks coords.

void te::mem::ExpansibleRaster::free ( )

protected

Free all allocated internal resources and go back to the initial state.

te::common::AccessPolicy te::rst::Raster::getAccessPolicy ( ) const

inherited

Returns the raster access policy.

const te::rst::Band* te::mem::ExpansibleRaster::getBand ( std::size_t i ) const

inlinevirtual

Returns the raster i-th band.

Parameters

i	The band index.

Warning: The caller is reponsible for providing a valid band index.

Implements te::rst::Raster.

Definition at line 108 of file ExpansibleRaster.h.

te::rst::Band* te::mem::ExpansibleRaster::getBand ( std::size_t i )

inlinevirtual

Returns the raster i-th band.

Parameters

i	The band index.

Warning: The caller is reponsible for providing a valid band index.

Implements te::rst::Raster.

Definition at line 114 of file ExpansibleRaster.h.

int te::mem::ExpansibleRaster::getBandDataType ( std::size_t i ) const

inlinevirtual

Returns the data type in a particular band (or dimension).

Note: The data types are listed in terralib/datatype/DataTypes.h

Parameters

i	The desired band.

Returns: The data type in a particular band (or dimension).

Implements te::rst::Raster.

Definition at line 102 of file ExpansibleRaster.h.

te::gm::Envelope* te::rst::Raster::getExtent ( )

inherited

Returns the geographic extension of the raster data.

Referenced by te::rst::LineIterator< T >::LineIterator(), and te::rst::PointSetIterator< T >::PointSetIterator().

const te::gm::Envelope* te::rst::Raster::getExtent ( ) const

inherited

Returns the geographic extension of the raster data.

te::gm::Envelope* te::rst::Raster::getExtent	(	int	srid,
		te::gm::Envelope *	roi = `0`
	)		const

inherited

Returns the geographic extension of the raster data, in a given SRS (distinct from its original one).

Parameters

srid	The target SRS id.
roi	Pointer to a region of interest. If NULL the original extenstion will be considered.

Returns: A pointer the raster extension in a given SRS or NULL if it fails.

Note: The caller will take the ownership of the returned pointer.

Grid* te::rst::Raster::getGrid ( )

inherited

It returns the raster grid.

Referenced by te::rst::LineIterator< T >::LineIterator(), te::rst::PointSetIterator< T >::PointSetIterator(), and te::rst::PolygonIterator< T >::PolygonIterator().

const Grid* te::rst::Raster::getGrid ( ) const

inherited

It returns the raster grid.

std::map<std::string, std::string> te::mem::ExpansibleRaster::getInfo ( ) const

virtual

It returns additional information about the raster.

The return of thi smethod is driver dependent.

Returns: Additional information about the raster.

Implements te::rst::Raster.

virtual void te::rst::Raster::getIValue	(	unsigned int	c,
		unsigned int	r,
		double &	value,
		std::size_t	b = `0`
	)		const

virtualinherited

Returns the imaginary attribute value in a complex band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The attribute value to be assigned.
b	A particular band of the cell attribute. Default value 0.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be read.

te::rst::Raster* te::mem::ExpansibleRaster::getMultiResLevel ( const unsigned int level ) const

virtual

Returns the required level of a multi-resolution pyramid or NULL if that level does not exists.

Parameters

level Level of a multi-resolution pyramid.

Returns: Returns the required level of a multi-resolution pyramid or NULL if that level does not exists.

Note: The caller must take the ownership of the returned pointer.

Implements te::rst::Raster.

unsigned int te::mem::ExpansibleRaster::getMultiResLevelsCount ( ) const

virtual

Returns the current number of multi-resolution pyramid levels.

Returns: Returns the current number of multi-resolution pyramid levels.

Implements te::rst::Raster.

const std::string& te::rst::Raster::getName ( ) const

inherited

Returns the raster name.

std::size_t te::mem::ExpansibleRaster::getNumberOfBands ( ) const

inlinevirtual

Returns the number of bands (dimension of cells attribute values) in the raster.

Implements te::rst::Raster.

Definition at line 97 of file ExpansibleRaster.h.

unsigned int te::rst::Raster::getNumberOfColumns ( ) const

inherited

Returns the raster number of columns.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), te::rst::BandIteratorWindow< T >::BandIteratorWindow(), and te::rst::BandIteratorWithMask< T >::BandIteratorWithMask().

unsigned int te::rst::Raster::getNumberOfRows ( ) const

inherited

Returns the raster number of rows.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), te::rst::BandIteratorWindow< T >::BandIteratorWindow(), and te::rst::BandIteratorWithMask< T >::BandIteratorWithMask().

Grid* te::rst::Raster::getResampledGrid ( int scale ) const

inherited

Return the raster grid for a specific scale.

Parameters

scale The desired sacale of interpolation (use - to shrink or + to enlarge).

Returns: The raster grid.

Note: The caller will take the ownership of the returned pointer.

double te::rst::Raster::getResolutionX ( ) const

inherited

Returns the raster horizontal (x-axis) resolution.

Referenced by te::rst::LineIterator< T >::LineIterator().

double te::rst::Raster::getResolutionY ( ) const

inherited

Returns the raster vertical (y-axis) resolution.

Referenced by te::rst::LineIterator< T >::LineIterator().

int te::rst::Raster::getSRID ( ) const

inherited

Returns the raster spatial reference system identifier.

Referenced by te::rst::LineIterator< T >::LineIterator(), te::rst::PointSetIterator< T >::PointSetIterator(), and te::rst::PolygonIterator< T >::PolygonIterator().

int te::rst::Raster::getTypeCode ( ) const

inlinevirtualinherited

It returns the data type code associated to the data value.

Returns: The data type code associated to the data value.

Implements te::dt::AbstractData.

Definition at line 362 of file Raster.h.

References te::dt::RASTER_TYPE.

virtual void te::rst::Raster::getValue	(	unsigned int	c,
		unsigned int	r,
		double &	value,
		std::size_t	b = `0`
	)		const

virtualinherited

Returns the attribute value of a band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	To return the attribute value.
b	A particular band of the cell attribute.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be read.

virtual void te::rst::Raster::getValue	(	unsigned int	c,
		unsigned int	r,
		std::complex< double > &	value,
		std::size_t	b = `0`
	)		const

virtualinherited

Returns the imaginary attribute value in a complex band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The complex attribute value to be assigned (real, imaginary).
b	A particular band of the cell attribute. Default value 0.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be read.

virtual void te::rst::Raster::getValues	(	unsigned int	c,
		unsigned int	r,
		std::vector< double > &	values
	)		const

virtualinherited

Returns the imaginary attribute values in all complex bands of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
values	A vector of attribute values to be assigned (not complex values).

Warning: The caller is responsible for providing correct values for the range [c x r].

Exceptions

Exception Subclasses may throw an exception if the data value can not be read.

virtual void te::rst::Raster::getValues	(	unsigned int	c,
		unsigned int	r,
		std::vector< std::complex< double > > &	values
	)		const

virtualinherited

Returns the imaginary attribute values in all complex bands of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
values	A vector of complex attribute values to be assigned (real, imaginary).

Warning: The caller is responsible for providing correct values for the range [c x r].

Exceptions

Exception Subclasses may throw an exception if the data value can not be read.

void te::mem::ExpansibleRaster::open	(	const std::map< std::string, std::string > &	rinfo,
		te::common::AccessPolicy	p = `te::common::RAccess`
	)

virtual

Opens a raster.

Parameters

rinfo	The information needed by each driver to open the raster.
p	Access Policy.

Implements te::rst::Raster.

virtual Raster& te::rst::Raster::operator*= ( Raster & rhs )

virtualinherited

It returns the raster product (pixel by pixel).

Parameters

rhs	The raster to be multiplied, right-hand side.

Note: Both rasters must have the same properties, #bands, #columns, #rows, and data type.; The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster product.

virtual Raster& te::rst::Raster::operator*= ( std::complex< double > & cvalue )

virtualinherited

It returns the product of a constant value to all pixels in the raster.

Parameters

cvalue The constant value to be multiplied.

Note: The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster product.

virtual Raster& te::rst::Raster::operator+= ( Raster & rhs )

virtualinherited

It returns the raster sum (pixel by pixel).

Parameters

rhs	The raster to be added, right-hand side.

Note: Both rasters must have the same properties, #bands, #columns, #rows, and data type.; The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster sum.

virtual Raster& te::rst::Raster::operator+= ( std::complex< double > & cvalue )

virtualinherited

It returns the sum of a constant value to all pixels in the raster.

Parameters

cvalue The constant value to be added.

Note: The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster sum.

virtual Raster& te::rst::Raster::operator-= ( Raster & rhs )

virtualinherited

It returns the raster subtraction (pixel by pixel).

Parameters

rhs	The raster to be subtracted, right-hand side.

Note: Both rasters must have the same properties, #bands, #columns, #rows, and data type.; The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster subtraction.

virtual Raster& te::rst::Raster::operator-= ( std::complex< double > & cvalue )

virtualinherited

It returns the difference from all pixels in the raster to a constant value (pixels - constant).

Parameters

cvalue The constant value to be subtracted.

Note: The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster difference.

virtual Raster& te::rst::Raster::operator/= ( Raster & rhs )

virtualinherited

It returns the raster division (pixel by pixel).

Parameters

rhs	The raster to be divided, right-hand side.

Note: Both rasters must have the same properties, #bands, #columns, #rows, and data type.; The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster division.

virtual Raster& te::rst::Raster::operator/= ( std::complex< double > & cvalue )

virtualinherited

It returns the division of all pixels in the raster by a constant value (pixels / constant).

Parameters

cvalue The constant value to be divided.

Note: The caller is responsible to guarantee that resultant values will not exceed the range of the data type.

Returns: The raster division.

const te::rst::Band& te::mem::ExpansibleRaster::operator[] ( std::size_t i ) const

inlinevirtual

Access band in i position.

Parameters

i	The band index.

Warning: The caller is reponsible for providing a valid band index.

Returns: A reference to the i-th band.

Implements te::rst::Raster.

Definition at line 120 of file ExpansibleRaster.h.

te::rst::Band& te::mem::ExpansibleRaster::operator[] ( std::size_t i )

inlinevirtual

Access band in i position.

Parameters

i	The band index.

Warning: The caller is reponsible for providing a valid band index.

Returns: A reference to the i-th band.

Implements te::rst::Raster.

Definition at line 126 of file ExpansibleRaster.h.

virtual void te::rst::Raster::rasterize	(	std::vector< te::gm::Geometry * >	g,
		std::vector< double >	vp,
		std::size_t	b = `0`
	)

virtualinherited

Rasterizes a given vector of geometries.

Parameters

g	A vector of geometries to be rasterized.
vp	A vector of pixel values for each geometry. Can have the same size of the vector of geometries, or be null.
b	The band index to rasterize.

bool te::mem::ExpansibleRaster::removeMultiResolution ( )

virtual

Remove/Destroy a sub-sampled multi-resolution pyramid, if there is one.

Returns: true if OK, false if errors ocurred.

Implements te::rst::Raster.

virtual Raster* te::rst::Raster::resample	(	int	method,
		unsigned int	drow,
		unsigned int	dcolumn,
		unsigned int	height,
		unsigned int	width,
		unsigned int	newheight,
		unsigned int	newwidth,
		const std::map< std::string, std::string > &	rinfo
	)		const

virtualinherited

Resample a subset of the raster, given a box.

Parameters

method The method of interpolation.

See also: te::rst::Interpolator

Parameters

drow	The starting row to make a subset of the image.
dcolumn	The starting column to make a subset of the image.
height	The height of the subset.
width	The width of the subset.
newheight	The resampled height of the new raster.
newwidth	The resampled width of the new raster.
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).

Returns: A pointer to the resampled raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

Warning: A scale of 0 is not allowed. Use 1, 2, 3, or -1, -2, 3...

virtual Raster* te::rst::Raster::resample	(	int	method,
		int	scale,
		const std::map< std::string, std::string > &	rinfo
	)		const

virtualinherited

Resample raster.

Parameters

method	The method of interpolation.
scale	The scale of interpolation (use - to shrink or + to enlarge).
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).

Returns: A pointer to the resampled raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

Warning: A scale of 0 is not allowed. Use 1, 2, 3, or -1, -2, 3...

Reimplemented in te::gdal::Raster.

void te::rst::Raster::setAccessPolicy ( te::common::AccessPolicy p )

inherited

Sets the raster access policy.

Parameters

p	The new raster access policy.

virtual void te::rst::Raster::setIValue	(	unsigned int	c,
		unsigned int	r,
		const double	value,
		std::size_t	b = `0`
	)

virtualinherited

Sets the imaginary attribute value in a complex band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The attribute value to be assigned.
b	A particular band of the cell attribute. Default value 0.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be write.

void te::rst::Raster::setName ( const std::string name )

inherited

Sets the raster name.

Parameters

name	The new raster name.

virtual void te::rst::Raster::setValue	(	unsigned int	c,
		unsigned int	r,
		const double	value,
		std::size_t	b = `0`
	)

virtualinherited

Sets the attribute value in a band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The attribute value to be assigned.
b	A particular band of the cell attribute.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be write.

virtual void te::rst::Raster::setValue	(	unsigned int	c,
		unsigned int	r,
		const std::complex< double > &	value,
		std::size_t	b = `0`
	)

virtualinherited

Sets the imaginary attribute value in a complex band of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The complex attribute value to be assigned (real, imaginary).
b	A particular band of the cell attribute. Default value 0.

Warning: The caller is responsible for providing correct values for the range [c x r x b].

Exceptions

Exception Subclasses may throw an exception if the data value can not be write.

virtual void te::rst::Raster::setValues	(	unsigned int	c,
		unsigned int	r,
		const std::vector< double > &	values
	)

virtualinherited

Sets the imaginary attribute values in all complex bands of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
values	A vector of attribute values to be assigned (not complex values).

Warning: The caller is responsible for providing correct values for the range [c x r].

Exceptions

Exception Subclasses may throw an exception if the data value can not be write.

virtual void te::rst::Raster::setValues	(	unsigned int	c,
		unsigned int	r,
		const std::vector< std::complex< double > > &	values
	)

virtualinherited

Sets the imaginary attribute values in all complex bands of a cell.

Parameters

c	The column location of the cell.
r	The row location of the cell.
values	A vector of complex attribute values to be assigned (real, imaginary).

Warning: The caller is responsible for providing correct values for the range [c x r].

Exceptions

Exception Subclasses may throw an exception if the data value can not be write.

std::string te::rst::Raster::toString ( void ) const

virtualinherited

It returns the data value in a string notation.

Returns: The data value in a string notation.

Implements te::dt::AbstractData.

virtual Raster* te::rst::Raster::transform	(	int	srid,
		const std::map< std::string, std::string > &	rinfo,
		int	m = `1`
	)		const

virtualinherited

Reprojects this raster to a distinct SRS. This method reprojects this raster to a distinct SRS. The output resolution is calculated in order to maintain the same number of pixels as in this raster.

Parameters

srid	The target SRS identifier.
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).
m	The method of interpolation to apply (default 1 = nearest neighbor).

See also: te::rst::Interpolator

Returns: A pointer to the reprojected raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

virtual Raster* te::rst::Raster::transform	(	int	srid,
		double	llx,
		double	lly,
		double	urx,
		double	ury,
		const std::map< std::string, std::string > &	rinfo,
		int	m = `1`
	)		const

virtualinherited

Reprojects a squared portion of this raster to a distinct SRS. This method reprojects a squared portion of this raster to a distinct SRS. The output resolution is calculated in order to maintain the same number of pixels as in the desired portion of this raster.

Parameters

srid	The target SRS identifier.
llx	Lower-left X-coordinate of the portion to be reprojected (in the original SRS).
lly	Lower-left Y-coordinate of the portion to be reprojected (in the original SRS).
urx	Upper-Right X-coordinate of the portion to be reprojected (in the original SRS).
url	Upper-Right Y-coordinate of the portion to be reprojected (in the original SRS).
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).
m	The method of interpolation to apply (default 1 = nearest neighbor).

See also: te::rst::Interpolator

Returns: A pointer to the reprojected raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

virtual Raster* te::rst::Raster::transform	(	int	srid,
		double	llx,
		double	lly,
		double	urx,
		double	ury,
		double	resx,
		double	resy,
		const std::map< std::string, std::string > &	rinfo,
		int	m = `1`
	)		const

virtualinherited

Reprojects a squared portion of this raster to another SRS with a desired resolution.

This method reprojects a squared portion of this raster to another SRS. The number of pixels in the output will be calculated according to the portion being reprojected and the asked resolution.

Parameters

srid	The SRS id of the target SRS.
llx	Lower-left X-coordinate of the portion to be reprojected (in the original SRS).
lly	Lower-left Y-coordinate of the portion to be reprojected (in the original SRS).
urx	Upper-Right X-coordinate of the portion to be reprojected (in the original SRS).
url	Upper-Right Y-coordinate of the portion to be reprojected (in the original SRS).
resx	The output x resolution (in units of the target SRS).
resx	The output y resolution (in units of the target SRS).
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).
m	The method of interpolation to apply (default 1 = nearest neighbor).

See also: te::rst::Interpolator

Returns: A pointer to the reprojected raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

Reimplemented in te::gdal::Raster.

virtual Raster* te::rst::Raster::trim	(	const te::gm::Envelope *	env,
		const std::map< std::string, std::string > &	rinfo
	)		const

virtualinherited

Subsetting operation for trimming (cropping) the raster.

Parameters

env	The envelope (inside original extent) to crop the raster.
rinfo	The parameters needed to build the output raster (see RasterFactory documentation).

Returns: A pointer to the trimmed raster if success and a null pointer otherwise.

Note: The caller will take the ownership of the returned pointer.

virtual void te::rst::Raster::vectorize	(	std::vector< te::gm::Geometry * > &	g,
		std::size_t	b,
		unsigned int	mp = `0`
	)

virtualinherited

Vectorizes a given raster band, using GDALPolygonize function.

Parameters

g	A reference to a vector of geometries. Will be filled with geometries found in band.
b	The band index to vectorize.

Note: The caller of this method must take the ownership of the returned geometries and must delete them when necessary.

Member Data Documentation

std::vector<ExpansibleBand*> te::mem::ExpansibleRaster::m_bands

protected

Internal raster bands.

Definition at line 198 of file ExpansibleRaster.h.

boost::shared_ptr< ExpansibleBandBlocksManager > te::mem::ExpansibleRaster::m_blocksManagerPtr

protected

Internal blocks manager.

Definition at line 200 of file ExpansibleRaster.h.

Grid* te::rst::Raster::m_grid

protectedinherited

The spatial support for raster data.

Definition at line 681 of file Raster.h.

std::vector< boost::shared_ptr< ExpansibleRaster > > te::mem::ExpansibleRaster::m_multiResRasters

protected

Pointer to Multi-resolution versions of this raster instance.

Definition at line 202 of file ExpansibleRaster.h.

std::string te::rst::Raster::m_name

protectedinherited

The raster name.

Definition at line 680 of file Raster.h.

te::common::AccessPolicy te::rst::Raster::m_policy

protectedinherited

The access policy, can be te::common::{NoAccess, RAccess, RWAccess, WAccess}.

Definition at line 682 of file Raster.h.

The documentation for this class was generated from the following file:

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/memory/ExpansibleRaster.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation