Extraction of attributes from Raster, Bands, and Polygons. More...

#include <RasterAttributes.h>

Inheritance diagram for te::rp::RasterAttributes:

Public Member Functions
bool	execute (AlgorithmOutputParameters &outputParams) throw (te::rp::Exception)
	Executes the algorithm using the supplied parameters. More...

std::vector< std::complex< double > >	getComplexValuesFromBand (const te::rst::Raster &raster, unsigned int band, const te::gm::Polygon &polygon)
	Returns the pixel values (real and imag) for the band, inside the polygon. More...

std::vector< std::vector< std::complex< double > > >	getComplexValuesFromRaster (const te::rst::Raster &raster, const te::gm::Polygon &polygon, std::vector< unsigned int > bands)
	Returns the pixel values (real and imag) for all the bands in raster, inside the polygon. More...

boost::numeric::ublas::matrix< double >	getCovarianceMatrix (const std::vector< std::vector< double > > &vpixels, const std::vector< double > &vmeans)
	Returns the covariance matrix between vectors of pixel values. More...

boost::numeric::ublas::matrix< double >	getGLCM (const te::rst::Raster &rin, unsigned int band, int dx, int dy)
	Computes the Gray-Level CoOccurrence Matrix (GLCM) from a raster band. More...

boost::numeric::ublas::matrix< double >	getGLCM (const te::rst::Raster &rin, unsigned int band, int dx, int dy, const te::gm::Polygon &polygon)
	Computes the Gray-Level CoOccurrence Matrix (GLCM) from a raster band, inside the polygon. More...

te::rp::Texture	getGLCMMetrics (boost::numeric::ublas::matrix< double > glcm)
	Compute texture metrics from GLCM matrix. More...

te::stat::NumericStatisticalSummary	getStatistics (std::vector< double > &pixels)
	Returns several statistics from a set of pixels. More...

std::vector< double >	getValuesFromBand (const te::rst::Raster &raster, unsigned int band, const te::gm::Polygon &polygon)
	Returns the pixel values for the band, inside the polygon. More...

std::vector< std::vector< double > >	getValuesFromRaster (const te::rst::Raster &raster, const te::gm::Polygon &polygon, std::vector< unsigned int > bands)
	Returns the pixel values for all the bands in raster, inside the polygon. More...

bool	initialize (const AlgorithmInputParameters &inputParams) throw (te::rp::Exception)
	Initialize the algorithm instance making it ready for execution. More...

bool	isInitialized () const
	Returns true if the algorithm instance is initialized and ready for execution. More...

	RasterAttributes ()
	Public constructor. More...

void	reset () throw (te::rp::Exception)
	Clear all internal allocated objects and reset the algorithm to its initial state. More...

	~RasterAttributes ()

Detailed Description

Extraction of attributes from Raster, Bands, and Polygons.

Definition at line 63 of file RasterAttributes.h.

Constructor & Destructor Documentation

te::rp::RasterAttributes::RasterAttributes ( )

Public constructor.

Definition at line 38 of file RasterAttributes.cpp.

te::rp::RasterAttributes::~RasterAttributes ( )

Definition at line 42 of file RasterAttributes.cpp.

Member Function Documentation

bool te::rp::RasterAttributes::execute	(	AlgorithmOutputParameters &	outputParams	)
throw	(	te::rp::Exception
	)

virtual

Executes the algorithm using the supplied parameters.

Parameters

outputParams Output parameters.

Returns: true if OK, false on errors.

Implements te::rp::Algorithm.

Definition at line 56 of file RasterAttributes.cpp.

std::vector< std::complex< double > > te::rp::RasterAttributes::getComplexValuesFromBand	(	const te::rst::Raster &	raster,
		unsigned int	band,
		const te::gm::Polygon &	polygon
	)

Returns the pixel values (real and imag) for the band, inside the polygon.

Parameters

raster	The input raster.
band	The position of the input band.
polygon	The input polygon.

Returns: The pixel values for the band, inside the polygon.

Warning: Band and polygon must fit.

Definition at line 65 of file RasterAttributes.cpp.

std::vector< std::vector< std::complex< double > > > te::rp::RasterAttributes::getComplexValuesFromRaster	(	const te::rst::Raster &	raster,
		const te::gm::Polygon &	polygon,
		std::vector< unsigned int >	bands
	)

Returns the pixel values (real and imag) for all the bands in raster, inside the polygon.

Parameters

raster	The input band.
polygon	The input polygon.
bands	Bands to be processed from the input raster.

Returns: A vector with the pixel values for all the bands in raster, inside the polygon, with values[band][pixel].

Warning: Bands and polygon must fit.

Definition at line 97 of file RasterAttributes.cpp.

boost::numeric::ublas::matrix< double > te::rp::RasterAttributes::getCovarianceMatrix	(	const std::vector< std::vector< double > > &	vpixels,
		const std::vector< double > &	vmeans
	)

Returns the covariance matrix between vectors of pixel values.

Parameters

vpixels	The vector of pixel vectors, with vpixels[band][pixel].
vmeans	The vector of pixels means, one mean per vector of pixels.

Returns: The covariance matrix between the vectors of pixel values.

Warning: All vectors sizes must fit.

Definition at line 152 of file RasterAttributes.cpp.

References te::common::TaskProgress::pulse(), and te::common::TaskProgress::UNDEFINED.

boost::numeric::ublas::matrix< double > te::rp::RasterAttributes::getGLCM	(	const te::rst::Raster &	rin,
		unsigned int	band,
		int	dx,
		int	dy
	)

Computes the Gray-Level CoOccurrence Matrix (GLCM) from a raster band.

Parameters

rin	The input raster.
band	The input band position.
dx	The displacement in x direction, to be considered as neighborhood, can be either + or -.
dy	The displacement in y direction, to be considered as neighborhood, can be either + or -.

Returns: The GLCM from the raster band.

Warning: The pixels from the input band will be considered of type unsigned int.

Definition at line 200 of file RasterAttributes.cpp.

References te::rst::Raster::getBand(), te::rst::Raster::getBandDataType(), te::rst::GetDataTypeRanges(), te::rst::Raster::getNumberOfBands(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), te::rst::Band::getProperty(), te::rst::Raster::getValue(), te::rst::BandProperty::m_noDataValue, te::common::TaskProgress::pulse(), and te::common::TaskProgress::UNDEFINED.

Referenced by te::attributefill::RasterToVector::getTexture().

boost::numeric::ublas::matrix< double > te::rp::RasterAttributes::getGLCM	(	const te::rst::Raster &	rin,
		unsigned int	band,
		int	dx,
		int	dy,
		const te::gm::Polygon &	polygon
	)

Computes the Gray-Level CoOccurrence Matrix (GLCM) from a raster band, inside the polygon.

Parameters

rin	The input raster.
band	The input band position.
dx	The displacement in x direction, to be considered as neighborhood, can be either + or -.
dy	The displacement in y direction, to be considered as neighborhood, can be either + or -.
polygon	The input polygon.

Returns: The GLCM from the raster band, inside the polygon.

Warning: The pixels from the input band will be considered of type unsigned int.

Definition at line 265 of file RasterAttributes.cpp.

References te::rst::CropRaster().

te::rp::Texture te::rp::RasterAttributes::getGLCMMetrics ( boost::numeric::ublas::matrix< double > glcm )

Compute texture metrics from GLCM matrix.

Parameters

glcm	The input GLCM matrix.

Returns: The Texture structure will all available metrics computed.

Definition at line 276 of file RasterAttributes.cpp.

References te::rp::Texture::m_contrast, te::rp::Texture::m_dissimilarity, te::rp::Texture::m_energy, te::rp::Texture::m_entropy, te::rp::Texture::m_homogeneity, te::common::TaskProgress::pulse(), and te::common::TaskProgress::UNDEFINED.

Referenced by te::attributefill::RasterToVector::getTexture().

te::stat::NumericStatisticalSummary te::rp::RasterAttributes::getStatistics ( std::vector< double > & pixels )

Returns several statistics from a set of pixels.

Parameters

pixels A vector of pixel values.

Returns: A series of statistics (

See also: te::stat::NumericStatisticalSummary).

Definition at line 142 of file RasterAttributes.cpp.

References te::stat::GetNumericStatisticalSummary().

Referenced by te::attributefill::RasterToVector::run().

std::vector< double > te::rp::RasterAttributes::getValuesFromBand	(	const te::rst::Raster &	raster,
		unsigned int	band,
		const te::gm::Polygon &	polygon
	)

Returns the pixel values for the band, inside the polygon.

Parameters

raster	The input raster.
band	The position of the input band.
polygon	The input polygon.

Returns: The pixel values for the band, inside the polygon.

Warning: Band and polygon must fit.

Definition at line 76 of file RasterAttributes.cpp.

References te::rst::PolygonIterator< T >::begin(), te::rst::PolygonIterator< T >::end(), and te::rst::Raster::getNumberOfBands().

std::vector< std::vector< double > > te::rp::RasterAttributes::getValuesFromRaster	(	const te::rst::Raster &	raster,
		const te::gm::Polygon &	polygon,
		std::vector< unsigned int >	bands
	)

Returns the pixel values for all the bands in raster, inside the polygon.

Parameters

raster	The input band.
polygon	The input polygon.
bands	Bands to be processed from the input raster.

Returns: A vector with the pixel values for all the bands in raster, inside the polygon, with values[band][pixel].

Warning: Bands and polygon must fit.

Definition at line 114 of file RasterAttributes.cpp.

References te::rst::PolygonIterator< T >::begin(), te::rst::PolygonIterator< T >::end(), te::rst::PolygonIterator< T >::getColumn(), te::rst::Raster::getNumberOfBands(), te::rst::PolygonIterator< T >::getRow(), and te::rst::Raster::getValue().

Referenced by te::attributefill::RasterToVector::run().

bool te::rp::RasterAttributes::initialize	(	const AlgorithmInputParameters &	inputParams	)
throw	(	te::rp::Exception
	)

virtual

Initialize the algorithm instance making it ready for execution.

Parameters

inputParams Input parameters.

Returns: true if OK, false on errors.

Note: A return error string can be obtained via te::rp::Module::getLastLogStr()

Implements te::rp::Algorithm.

Definition at line 46 of file RasterAttributes.cpp.

bool te::rp::RasterAttributes::isInitialized ( ) const

virtual

Returns true if the algorithm instance is initialized and ready for execution.

Returns: true if the algorithm instance is initialized and ready for execution.

Implements te::rp::Algorithm.

Definition at line 51 of file RasterAttributes.cpp.

void te::rp::RasterAttributes::reset	(		)
throw	(	te::rp::Exception
	)

virtual

Clear all internal allocated objects and reset the algorithm to its initial state.

Implements te::rp::Algorithm.

Definition at line 61 of file RasterAttributes.cpp.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/rp/RasterAttributes.h
/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/rp/RasterAttributes.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation