An abstract class for raster data strucutures. More...

#include <Raster.h>

Inheritance diagram for te::rst::Raster:

Public Member Functions
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...

virtual AbstractData *	clone () const =0
	It returns a clone of this object. More...

virtual bool	createMultiResolution (const unsigned int levels, const InterpolationMethod interpMethod)=0
	Create a sub-sampled multi-resolution pyramid. More...

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

virtual const Band *	getBand (std::size_t i) const =0
	Returns the raster i-th band. More...

virtual Band *	getBand (std::size_t i)=0
	Returns the raster i-th band. More...

virtual int	getBandDataType (std::size_t i) const =0
	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...

virtual std::map< std::string, std::string >	getInfo () const =0
	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...

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

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

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

virtual std::size_t	getNumberOfBands () const =0
	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...

virtual void	open (const std::map< std::string, std::string > &rinfo, te::common::AccessPolicy p=te::common::RAccess)=0
	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...

virtual Raster &	operator= (const Raster &rhs)
	Assignment operator. More...

virtual const Band &	operator[] (std::size_t i) const =0
	Access band in i position. More...

virtual Band &	operator[] (std::size_t i)=0
	Access band in i position. More...

	Raster ()
	Default constructor. More...

	Raster (Grid *grid, te::common::AccessPolicy p=te::common::RAccess)
	Constructor to create a raster from parameters. More...

	Raster (const Raster &rhs)
	Copy constructor. 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...

virtual bool	removeMultiResolution ()=0
	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...

virtual	~Raster ()
	Virtual destructor. More...

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

Protected Attributes
Grid *	m_grid
	The spatial support for raster data. 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...

Detailed Description

An abstract class for raster data strucutures.

A raster data structure represents a geograhical area divided into rows and columns, which form a regular grid structure of cells. Each cell contains location co-ordinates and one or more attribute values.

This interface should be implemented by drivers that provide the real access to raster data.

Definition at line 71 of file Raster.h.

Constructor & Destructor Documentation

te::rst::Raster::Raster ( )

Default constructor.

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

Constructor to create a raster from parameters.

Parameters

grid	The grid definition. The Raster will take its ownership.
p	Access Policy.

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

Copy constructor.

Parameters

rhs	The right-hand side Raster.

virtual te::rst::Raster::~Raster ( )

virtual

Virtual destructor.

Reimplemented in te::gdal::Raster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

Member Function Documentation

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

protected

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
	)

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.

virtual AbstractData* te::dt::AbstractData::clone ( ) const

pure virtualinherited

It returns a clone of this object.

Returns: A clone of this object.

Implemented in te::dt::ByteArray, te::dt::SimpleData< T *, typeCode >, te::dt::DatePeriod, te::dt::TimePeriod, te::dt::TimeDuration, te::dt::Date, te::dt::TimeInstant, te::dt::TimePeriodTZ, te::dt::OrdinalPeriod, te::dt::Array, te::idl::IdlRaster, te::gm::LineString, te::mem::ExpansibleRaster, te::gm::CircularString, te::dt::TimeInstantTZ, te::gm::PointKd, te::dt::DateDuration, te::gm::CompoundCurve, te::gm::LinearRing, te::gm::MultiPolygon, te::dt::CompositeData, te::gm::PointZM, te::mem::CachedRaster, te::gm::PointM, te::gm::PointZ, te::gm::Line, te::gm::Point, te::dt::OrdinalInstant, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gdal::Raster, te::gm::PolyhedralSurface, te::gm::Polygon, te::gm::MultiLineString, te::gm::MultiPoint, te::rst::SynchronizedRaster, te::gm::MultiSurface, te::dt::SimpleData< T, typeCode >, te::dt::SimpleData< boost::int64_t, INT64_TYPE >, te::gm::MultiCurve, te::rst::ProxyRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

Referenced by te::rst::PolygonIterator< T >::decompose(), and te::dt::new_clone().

virtual bool te::rst::Raster::createMultiResolution	(	const unsigned int	levels,
		const InterpolationMethod	interpMethod
	)

pure 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.

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::grib::Raster, te::rst::ProxyRaster, te::mem::Raster, and terralib4::Raster.

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

Returns the raster access policy.

virtual const Band* te::rst::Raster::getBand ( std::size_t i ) const

pure virtual

Returns the raster i-th band.

Parameters

i	The band index.

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

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::rst::ProxyRaster, te::idl::IdlRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

Referenced by te::rst::BandIteratorWithMask< T >::BandIteratorWithMask(), te::rst::RasterIterator< T >::end(), and te::rst::RasterIterator< T >::RasterIterator().

virtual Band* te::rst::Raster::getBand ( std::size_t i )

pure virtual

Returns the raster i-th band.

Parameters

i	The band index.

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

Implemented in te::mem::ExpansibleRaster, te::gdal::Raster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::rst::ProxyRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

virtual int te::rst::Raster::getBandDataType ( std::size_t i ) const

pure virtual

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).

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::rst::ProxyRaster, te::idl::IdlRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

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

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

Returns the geographic extension of the raster data.

te::gm::Envelope* te::rst::Raster::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).

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 ( )

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

It returns the raster grid.

virtual std::map<std::string, std::string> te::rst::Raster::getInfo ( ) const

pure virtual

It returns additional information about the raster.

The return of thi smethod is driver dependent.

Returns: Additional information about the raster.

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::rst::ProxyRaster, te::grib::Raster, te::idl::IdlRaster, te::mem::Raster, and terralib4::Raster.

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

virtual

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.

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

pure 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.

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::grib::Raster, te::rst::ProxyRaster, te::mem::Raster, and terralib4::Raster.

virtual unsigned int te::rst::Raster::getMultiResLevelsCount ( ) const

pure virtual

Returns the current number of multi-resolution pyramid levels.

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

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::grib::Raster, te::rst::ProxyRaster, te::mem::Raster, and terralib4::Raster.

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

Returns the raster name.

virtual std::size_t te::rst::Raster::getNumberOfBands ( ) const

pure virtual

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

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::rst::ProxyRaster, te::grib::Raster, te::idl::IdlRaster, te::mem::Raster, and terralib4::Raster.

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

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

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

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

Returns the raster horizontal (x-axis) resolution.

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

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

Returns the raster vertical (y-axis) resolution.

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

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

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

inlinevirtual

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

virtual

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

virtual

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

virtual

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

virtual

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.

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

pure virtual

Opens a raster.

Parameters

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

Implemented in te::rst::SynchronizedRaster, te::idl::IdlRaster, te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::ProxyRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

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

virtual

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 )

virtual

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 )

virtual

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 )

virtual

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 )

virtual

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 )

virtual

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 )

virtual

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 )

virtual

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.

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

virtual

Assignment operator.

Parameters

rhs	The right-hand-side copy that would be used to copy from.

Returns: A reference to this object.

virtual const Band& te::rst::Raster::operator[] ( std::size_t i ) const

pure virtual

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.

Implemented in te::mem::ExpansibleRaster, te::mem::CachedRaster, te::gdal::Raster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::rst::ProxyRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

virtual Band& te::rst::Raster::operator[] ( std::size_t i )

pure virtual

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.

Implemented in te::mem::ExpansibleRaster, te::mem::CachedRaster, te::gdal::Raster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::rst::ProxyRaster, te::grib::Raster, te::mem::Raster, and terralib4::Raster.

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

virtual

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.

virtual bool te::rst::Raster::removeMultiResolution ( )

pure virtual

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

Returns: true if OK, false if errors ocurred.

Implemented in te::gdal::Raster, te::mem::ExpansibleRaster, te::mem::CachedRaster, te::rst::SynchronizedRaster, te::idl::IdlRaster, te::grib::Raster, te::rst::ProxyRaster, te::mem::Raster, and terralib4::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

virtual

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

virtual

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 )

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`
	)

virtual

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 )

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`
	)

virtual

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`
	)

virtual

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
	)

virtual

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
	)

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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`
	)

virtual

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

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

protected

The spatial support for raster data.

Definition at line 681 of file Raster.h.

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

protected

The raster name.

Definition at line 680 of file Raster.h.

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

protected

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/raster/Raster.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation