te::gdal::Raster Class Reference

This class represents Raster data. More...

#include <Raster.h>

Inheritance diagram for te::gdal::Raster:
te::rst::Raster te::dt::AbstractData

Public Member Functions

RastercallOperator (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::AbstractDataclone () const
 It returns a clone of this object. More...
 
void create (te::rst::Grid *g, const std::vector< te::rst::BandProperty * > bands, const std::map< std::string, std::string > &rinfo, void *h, void(*deleter)(void *))
 
bool createMultiResolution (const unsigned int levels, const te::rst::InterpolationMethod interpMethod)
 Create a sub-sampled multi-resolution pyramid. More...
 
te::common::AccessPolicy getAccessPolicy () const
 Returns the raster access policy. More...
 
const te::rst::BandgetBand (std::size_t i) const
 Returns the raster i-th band. More...
 
te::rst::BandgetBand (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::EnvelopegetExtent ()
 Returns the geographic extension of the raster data. More...
 
const te::gm::EnvelopegetExtent () const
 Returns the geographic extension of the raster data. More...
 
te::gm::EnvelopegetExtent (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...
 
GDALDataset * getGDALDataset () const
 Returns the raster GDAL handler. 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::RastergetMultiResLevel (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 Rasteroperator*= (Raster &rhs)
 It returns the raster product (pixel by pixel). More...
 
virtual Rasteroperator*= (std::complex< double > &cvalue)
 It returns the product of a constant value to all pixels in the raster. More...
 
virtual Rasteroperator+= (Raster &rhs)
 It returns the raster sum (pixel by pixel). More...
 
virtual Rasteroperator+= (std::complex< double > &cvalue)
 It returns the sum of a constant value to all pixels in the raster. More...
 
virtual Rasteroperator-= (Raster &rhs)
 It returns the raster subtraction (pixel by pixel). More...
 
virtual Rasteroperator-= (std::complex< double > &cvalue)
 It returns the difference from all pixels in the raster to a constant value (pixels - constant). More...
 
virtual Rasteroperator/= (Raster &rhs)
 It returns the raster division (pixel by pixel). More...
 
virtual Rasteroperator/= (std::complex< double > &cvalue)
 It returns the division of all pixels in the raster by a constant value (pixels / constant). More...
 
Rasteroperator= (const Raster &rhs)
 
const te::rst::Bandoperator[] (std::size_t i) const
 Access band in i position. More...
 
te::rst::Bandoperator[] (std::size_t i)
 Access band in i position. More...
 
 Raster ()
 
 Raster (const std::string &rinfo, te::common::AccessPolicy p=te::common::RAccess)
 Constructor. More...
 
 Raster (te::rst::Grid *grid, const std::vector< te::rst::BandProperty * > &bprops, const std::map< std::string, std::string > &optParams, te::common::AccessPolicy p=te::common::RAccess)
 Constructor. More...
 
 Raster (const Raster &rhs)
 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...
 
bool removeMultiResolution ()
 Remove/Destroy a sub-sampled multi-resolution pyramid, if there is one. More...
 
te::rst::Rasterresample (int method, int scale, const std::map< std::string, std::string > &rinfo) const
 Resample raster. More...
 
virtual Rasterresample (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...
 
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...
 
te::rst::Rastertransform (int srid, double llx, double lly, double urx, double ury, double resx, double resy, const std::map< std::string, std::string > &rinfo, int m=0) const
 
void transform (te::rst::Raster *outRaster)
 
virtual Rastertransform (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 Rastertransform (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 Rastertrim (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...
 
 ~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...
 
 Raster (const unsigned int multiResolutionLevel, const std::string &uRI, const te::common::AccessPolicy &policy)
 Constructor. 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...
 

Private Attributes

std::vector< Band * > m_bands
 The vector of available bands in the raster. More...
 
void(* m_deleter )(void *)
 A pointer to a deleter function, if the buffer needs to be deleted by this object. More...
 
std::auto_ptr< DataSetUseCounterm_dsUseCounterPtr
 Dataset use counter pointer. More...
 
GDALDataset * m_gdataset
 Gdal data set handler. More...
 
std::string m_myURI
 This instance URI;. More...
 

Detailed Description

This class represents Raster data.

This class is a concrete implementation of a Raster using the GDAL library to access the data.

See also
te::rst::Raster

Definition at line 61 of file Raster.h.

Constructor & Destructor Documentation

te::gdal::Raster::Raster ( )
te::gdal::Raster::Raster ( const std::string &  rinfo,
te::common::AccessPolicy  p = te::common::RAccess 
)

Constructor.

Parameters
rinfoThe information needed to open the raster.
pAccess Policy.
te::gdal::Raster::Raster ( te::rst::Grid grid,
const std::vector< te::rst::BandProperty * > &  bprops,
const std::map< std::string, std::string > &  optParams,
te::common::AccessPolicy  p = te::common::RAccess 
)

Constructor.

Parameters
gridThe grid definition. The Raster will take its ownership.
bpropsA vector of band properties, one for each band. The Raster will take its ownership.
optparamsExtra information to create the raster. See GDAL documentation for more information. Parameters include NBANDS, BANDSTYPE, NCOLS, NROWS, RESX, RESY, SRID, ULX, ULY.
pAccess Policy.
te::gdal::Raster::Raster ( const Raster rhs)

Constructor.

Parameters
gdatasetA GDAL dataset handler.
pAccess Policy.
te::gdal::Raster::~Raster ( )
virtual

Virtual destructor.

Reimplemented from te::rst::Raster.

te::gdal::Raster::Raster ( const unsigned int  multiResolutionLevel,
const std::string &  uRI,
const te::common::AccessPolicy policy 
)
protected

Constructor.

Parameters
multiResolutionLevelLevel of a multi-resolution pyramid.
uRIThe raster URI.
policyThe raster access policy.

Member Function Documentation

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

Scales a value according to a specific resampling scale.

Parameters
iThe scale to apply.
vThe 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)
rhsThe rhs raster to apply the function.
Returns
The resultant raster.
te::dt::AbstractData* te::gdal::Raster::clone ( ) const
virtual

It returns a clone of this object.

Returns
A clone of this object.

Implements te::dt::AbstractData.

void te::gdal::Raster::create ( te::rst::Grid g,
const std::vector< te::rst::BandProperty * >  bands,
const std::map< std::string, std::string > &  rinfo,
void *  h,
void(*)(void *)  deleter 
)
Note
GDAL driver extended method.
bool te::gdal::Raster::createMultiResolution ( const unsigned int  levels,
const te::rst::InterpolationMethod  interpMethod 
)
virtual

Create a sub-sampled multi-resolution pyramid.

Parameters
levelsThe number of pyramid levels to generate.
interpMethodThe used interpolation method.
Returns
true if OK, false if errors ocurred.

Implements te::rst::Raster.

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

Returns the raster access policy.

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

Returns the raster i-th band.

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

Implements te::rst::Raster.

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

Returns the raster i-th band.

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

Implements te::rst::Raster.

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

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

Note
The data types are listed in terralib/datatype/DataTypes.h
Parameters
iThe desired band.
Returns
The data type in a particular band (or dimension).

Implements te::rst::Raster.

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
sridThe target SRS id.
roiPointer 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.
GDALDataset* te::gdal::Raster::getGDALDataset ( ) const

Returns the raster GDAL handler.

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

It returns the raster grid.

std::map<std::string, std::string> te::gdal::Raster::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
cThe column location of the cell.
rThe row location of the cell.
valueThe attribute value to be assigned.
bA 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
ExceptionSubclasses may throw an exception if the data value can not be read.
te::rst::Raster* te::gdal::Raster::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
levelLevel 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::gdal::Raster::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::gdal::Raster::getNumberOfBands ( ) const
virtual

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

Implements te::rst::Raster.

unsigned int te::rst::Raster::getNumberOfColumns ( ) const
inherited
unsigned int te::rst::Raster::getNumberOfRows ( ) const
inherited
Grid* te::rst::Raster::getResampledGrid ( int  scale) const
inherited

Return the raster grid for a specific scale.

Parameters
scaleThe 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
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
cThe column location of the cell.
rThe row location of the cell.
valueTo return the attribute value.
bA particular band of the cell attribute.
Warning
The caller is responsible for providing correct values for the range [c x r x b].
Exceptions
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valueThe complex attribute value to be assigned (real, imaginary).
bA 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
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valuesA 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
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valuesA 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
ExceptionSubclasses may throw an exception if the data value can not be read.
void te::gdal::Raster::open ( const std::map< std::string, std::string > &  rinfo,
te::common::AccessPolicy  p = te::common::RAccess 
)
virtual

Opens a raster.

Parameters
rinfoThe information needed by each driver to open the raster.
pAccess Policy.

Implements te::rst::Raster.

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

It returns the raster product (pixel by pixel).

Parameters
rhsThe 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
cvalueThe 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
rhsThe 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
cvalueThe 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
rhsThe 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
cvalueThe 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
rhsThe 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
cvalueThe 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.
Raster& te::gdal::Raster::operator= ( const Raster rhs)
const te::rst::Band& te::gdal::Raster::operator[] ( std::size_t  i) const
virtual

Access band in i position.

Parameters
iThe 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.

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

Access band in i position.

Parameters
iThe 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.

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
gA vector of geometries to be rasterized.
vpA vector of pixel values for each geometry. Can have the same size of the vector of geometries, or be null.
bThe band index to rasterize.
bool te::gdal::Raster::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.

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

Resample raster.

Parameters
methodThe method of interpolation.
scaleThe scale of interpolation (use - to shrink or + to enlarge).
rinfoThe 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 from 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
methodThe method of interpolation.
See also
te::rst::Interpolator
Parameters
drowThe starting row to make a subset of the image.
dcolumnThe starting column to make a subset of the image.
heightThe height of the subset.
widthThe width of the subset.
newheightThe resampled height of the new raster.
newwidthThe resampled width of the new raster.
rinfoThe 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...
void te::rst::Raster::setAccessPolicy ( te::common::AccessPolicy  p)
inherited

Sets the raster access policy.

Parameters
pThe 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
cThe column location of the cell.
rThe row location of the cell.
valueThe attribute value to be assigned.
bA 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
ExceptionSubclasses 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
nameThe 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
cThe column location of the cell.
rThe row location of the cell.
valueThe attribute value to be assigned.
bA particular band of the cell attribute.
Warning
The caller is responsible for providing correct values for the range [c x r x b].
Exceptions
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valueThe complex attribute value to be assigned (real, imaginary).
bA 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
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valuesA 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
ExceptionSubclasses 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
cThe column location of the cell.
rThe row location of the cell.
valuesA 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
ExceptionSubclasses 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.

te::rst::Raster* te::gdal::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 = 0 
) const
virtual
Note
When the parameter USE_TERRALIB_REPROJECTION = TRUE in rinfo, the default reprojection will be called. Otherwise this method will call the GDAL reprojection method. The rinfo must define a GDAL compatible raster. The parameter m (interpolation method) is not used in GDAL implementation.

Reimplemented from te::rst::Raster.

void te::gdal::Raster::transform ( te::rst::Raster outRaster)
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
sridThe target SRS identifier.
rinfoThe parameters needed to build the output raster (see RasterFactory documentation).
mThe 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
sridThe target SRS identifier.
llxLower-left X-coordinate of the portion to be reprojected (in the original SRS).
llyLower-left Y-coordinate of the portion to be reprojected (in the original SRS).
urxUpper-Right X-coordinate of the portion to be reprojected (in the original SRS).
urlUpper-Right Y-coordinate of the portion to be reprojected (in the original SRS).
rinfoThe parameters needed to build the output raster (see RasterFactory documentation).
mThe 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::trim ( const te::gm::Envelope env,
const std::map< std::string, std::string > &  rinfo 
) const
virtualinherited

Subsetting operation for trimming (cropping) the raster.

Parameters
envThe envelope (inside original extent) to crop the raster.
rinfoThe 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
gA reference to a vector of geometries. Will be filled with geometries found in band.
bThe 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<Band*> te::gdal::Raster::m_bands
private

The vector of available bands in the raster.

Definition at line 165 of file Raster.h.

void(* te::gdal::Raster::m_deleter) (void *)
private

A pointer to a deleter function, if the buffer needs to be deleted by this object.

Definition at line 166 of file Raster.h.

std::auto_ptr<DataSetUseCounter> te::gdal::Raster::m_dsUseCounterPtr
private

Dataset use counter pointer.

Definition at line 168 of file Raster.h.

GDALDataset* te::gdal::Raster::m_gdataset
private

Gdal data set handler.

Definition at line 164 of file Raster.h.

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

The spatial support for raster data.

Definition at line 681 of file Raster.h.

std::string te::gdal::Raster::m_myURI
private

This instance URI;.

Definition at line 167 of file Raster.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: