A raster band description. More...

#include <Band.h>

Inheritance diagram for te::rst::Band:

Public Member Functions
	Band (BandProperty *p, std::size_t idx)
	Constructor. More...

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

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

virtual int	getBlockSize () const
	It returns the number of bytes ocuppied by a data block. More...

virtual std::map< double, unsigned >	getHistogramI (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0, unsigned int b=0) const
	It computes and returns the histogram occurring values (imaginary part) in a window of the band. More...

virtual std::map< double, unsigned >	getHistogramR (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0, unsigned int b=0) const
	It computes and returns the histogram occurring values (real part) in a window of the band. More...

virtual void	getHistogramR (const unsigned int rowStart, const unsigned int colStart, const unsigned int finalRow, const unsigned int finalCol, const unsigned int histoBins, const unsigned int sampleStep, std::map< double, unsigned > &histogram) const
	It computes and returns the histogram occurring values (real part) in a window of the band. More...

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

virtual std::complex< double >	getMaxValue (bool readall=false, unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const
	It computes and returns the maximum occurring value in a window of the band. More...

virtual std::complex< double >	getMeanValue (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const
	It computes and returns the mean of the occurring values in a window of the band. More...

virtual std::complex< double >	getMinValue (bool readall=false, unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const
	It computes and returns the minimum occurring value in a window of the band. More...

std::complex< double >	getOffsetValue () const
	It returns the offset values (real and imaginary) to be applied to the band. More...

BandProperty *	getProperty ()
	Returns the band property. More...

const BandProperty *	getProperty () const
	Returns the band property. More...

virtual Raster *	getRaster () const =0
	Returns the associated raster. More...

std::complex< double >	getScaleValue () const
	It returns the scale values (real and imaginary) to be applied to the band. More...

virtual std::complex< double >	getStdValue (unsigned int rs=0, unsigned int cs=0, unsigned int rf=0, unsigned int cf=0) const
	It computes and returns the standard deviation of the occurring values in a window of the band. More...

virtual void	getValue (unsigned int c, unsigned int r, double &value) const =0
	Returns the cell attribute value. More...

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

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

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

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

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

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

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

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

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

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

virtual void	read (int x, int y, void *buffer) const =0
	It reads a data block to the specified buffer. More...

virtual void *	read (int x, int y)=0
	It reads and returns a data block. More...

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

void	setOffsetValue (const std::complex< double > o)
	Sets the offset values (real and imaginary) to be applied to the band. More...

void	setScaleValue (const std::complex< double > s)
	Sets the scale values (real and imaginary) to be applied to the band. More...

virtual void	setValue (unsigned int c, unsigned int r, const double value)=0
	Sets the cell attribute value. More...

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

virtual void	write (int x, int y, void *buffer)=0
	It writes a data block from the specified buffer. More...

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

Protected Member Functions
	Band (const Band &rhs)
	Copy constructor. More...

Protected Attributes
std::size_t	m_idx
	The band index. More...

BandProperty *	m_property
	The band information. More...

Detailed Description

A raster band description.

The raster band describes how to interpret (and use) values that can be associated to each element of a raster, in one given dimension (e.g. a band of multi-hiperspectral remote sensing image). Each instance of this class refers to a particular dimension. This implementation defines a set of information commonly used to describe any raster.

See also: Raster, BandProperty

Definition at line 63 of file src/terralib/raster/Band.h.

Constructor & Destructor Documentation

te::rst::Band::Band	(	BandProperty *	p,
		std::size_t	idx
	)

Constructor.

Parameters

p	The band property. The Band will take its ownership.
idx	The band index.

Warning: The class takes the ownership of the passed pointer. Do not pass a null pointer.

Definition at line 37 of file src/terralib/raster/Band.cpp.

te::rst::Band::~Band ( )

virtual

Virtual destructor.

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

Definition at line 43 of file src/terralib/raster/Band.cpp.

References m_property.

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

protected

Copy constructor.

Parameters

rhs	The right-hand-side copy used to copy from.

Definition at line 790 of file src/terralib/raster/Band.cpp.

References m_property.

Member Function Documentation

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

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

Parameters

(*f)	a function with the signature complex<double>(*f)(complex<double>, complex<double>)
rhs	The rhs band to apply the function.

Returns: The resultant band.

Definition at line 585 of file src/terralib/raster/Band.cpp.

References te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getProperty(), getRaster(), getValue(), te::rst::BandProperty::m_blkh, te::rst::BandProperty::m_blkw, te::rst::BandProperty::m_nblocksx, te::rst::BandProperty::m_nblocksy, te::rst::BandProperty::m_noDataValue, te::common::RWAccess, setValue(), and te::common::WAccess.

Referenced by operator*=(), operator+=(), operator-=(), and operator/=().

te::rst::Band & te::rst::Band::callOperator	(	std::complex< double >(*)(std::complex< double >, std::complex< double >)	f,
		std::complex< double > &	cvalue
	)

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

Parameters

(*f)	a function with the signature complex<double>(*f)(complex<double>, complex<double>)
cvalue	The constant value that will work with the generic function.

Returns: The resultant band.

Definition at line 655 of file src/terralib/raster/Band.cpp.

References te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getProperty(), getRaster(), getValue(), te::rst::BandProperty::m_blkh, te::rst::BandProperty::m_blkw, te::rst::BandProperty::m_nblocksx, te::rst::BandProperty::m_nblocksy, te::rst::BandProperty::m_noDataValue, te::common::RWAccess, setValue(), and te::common::WAccess.

int te::rst::Band::getBlockSize ( ) const

virtual

It returns the number of bytes ocuppied by a data block.

Reimplemented in te::mem::Band.

Definition at line 777 of file src/terralib/raster/Band.cpp.

References te::rst::GetPixelSize(), te::rst::BandProperty::getType(), te::rst::BandProperty::m_blkh, te::rst::BandProperty::m_blkw, and m_property.

Referenced by te::rst::AbstractBandIterator< T >::AbstractBandIterator(), te::gdal::Band::Band(), te::rst::BandIteratorWindow< T >::BandIteratorWindow(), te::rp::Blender::blendIntoRaster1(), te::mem::CachedBand::CachedBand(), te::rst::Copy(), te::rp::Segmenter::execute(), te::rp::GetCovarianceValueThread(), te::rp::GetMeanValueThread(), te::rp::GetStdDevValueThread(), te::rst::SynchronizedBandBlocksManager::initialize(), te::mem::CachedBandBlocksManager::initialize(), te::gdal::Band::operator=(), te::rst::BandIteratorWindow< T >::operator=(), te::grib::Band::read(), te::rp::Contrast::remapBandLevels(), te::rp::RemapValuesThread(), te::rst::SynchronizedBand::SynchronizedBand(), te::mem::TiledBand::TiledBand(), and te::grib::Band::write().

std::map< double, unsigned > te::rst::Band::getHistogramI	(	unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`,
		unsigned int	b = `0`
	)		const

virtual

It computes and returns the histogram occurring values (imaginary part) in a window of the band.

Parameters

rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.
b	The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The histogram of the occurring values (imaginary part) in the window.

Definition at line 481 of file src/terralib/raster/Band.cpp.

References getIValue(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), and getRaster().

Referenced by te::rst::RasterSummaryManager::get().

std::map< double, unsigned > te::rst::Band::getHistogramR	(	unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`,
		unsigned int	b = `0`
	)		const

virtual

It computes and returns the histogram occurring values (real part) in a window of the band.

Parameters

rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.
b	The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The histogram of the occurring values (real part) in the window.

Definition at line 270 of file src/terralib/raster/Band.cpp.

Referenced by te::rst::RasterSummaryManager::get().

void te::rst::Band::getHistogramR	(	const unsigned int	rowStart,
		const unsigned int	colStart,
		const unsigned int	finalRow,
		const unsigned int	finalCol,
		const unsigned int	histoBins,
		const unsigned int	sampleStep,
		std::map< double, unsigned > &	histogram
	)		const

virtual

It computes and returns the histogram occurring values (real part) in a window of the band.

Parameters

rowStart	The starting row.
colStart	The starting column.
finalRow	The final row.
finalCol	The final column.
histoBins	The number of bins (intervals from minimum pixel to maximum). When b = 0, the histogram will be divided according to all pixel values.
sampleStep	The row/column step used when reading pixels (to read all pixels sampleStep=1, to read half of pixels use sampleStep=2 );
histogram	The generated histogram.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The histogram of the occurring values (real part) in the window.

Definition at line 277 of file src/terralib/raster/Band.cpp.

References te::dt::DOUBLE_TYPE, te::dt::FLOAT_TYPE, te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getRaster(), getValue(), te::rst::BandProperty::m_blkh, te::rst::BandProperty::m_blkw, te::rst::BandProperty::m_nblocksx, te::rst::BandProperty::m_nblocksy, te::rst::BandProperty::m_noDataValue, m_property, te::rst::BandProperty::m_type, and pixelValue.

virtual void te::rst::Band::getIValue	(	unsigned int	c,
		unsigned int	r,
		double &	value
	)		const

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

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.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

Referenced by getHistogramI(), te::rst::Raster::getIValue(), and getValue().

std::complex< double > te::rst::Band::getMaxValue	(	bool	readall = `false`,
		unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`
	)		const

virtual

It computes and returns the maximum occurring value in a window of the band.

Parameters

readall	Force the reading the entire image (can be slow). If false, will read up to 1000 pixels of the image, equally spaced.
rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The maximum occurring value in the window, real and imaginary (if present).

Reimplemented in te::gdal::Band.

Definition at line 144 of file src/terralib/raster/Band.cpp.

References te::rst::PointSetIterator< T >::begin(), te::rst::PointSetIterator< T >::end(), te::rst::PointSetIterator< T >::getColumn(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getProperty(), te::rst::GetRandomPointsInRaster(), getRaster(), te::rst::PointSetIterator< T >::getRow(), getValue(), and te::rst::BandProperty::m_noDataValue.

Referenced by ArithmeticWithRaster(), BOOST_AUTO_TEST_SUITE(), te::rst::RasterSummaryManager::get(), te::gdal::Band::getMaxValue(), Texture(), and te::rst::Raster::toString().

std::complex< double > te::rst::Band::getMeanValue	(	unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`
	)		const

virtual

It computes and returns the mean of the occurring values in a window of the band.

Parameters

rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The mean of the occurring values in the window, real and imaginary (if present).

Reimplemented in te::gdal::Band.

Definition at line 241 of file src/terralib/raster/Band.cpp.

References te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getRaster(), and getValue().

Referenced by te::rst::RasterSummaryManager::get(), te::gdal::Band::getMeanValue(), getStdValue(), and te::rst::Raster::toString().

std::complex< double > te::rst::Band::getMinValue	(	bool	readall = `false`,
		unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`
	)		const

virtual

It computes and returns the minimum occurring value in a window of the band.

Parameters

readall	Force the reading the entire image (can be slow). If false, will read up to 1000 pixels of the image, equally spaced.
rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.

Note: This method without parameters will compute for the entire image.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf x b].

Returns: The minimum occurring value in the window, real and imaginary (if present).

Reimplemented in te::gdal::Band.

Definition at line 82 of file src/terralib/raster/Band.cpp.

References te::rst::PointSetIterator< T >::begin(), te::rst::PointSetIterator< T >::end(), te::rst::PointSetIterator< T >::getColumn(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getProperty(), te::rst::GetRandomPointsInRaster(), getRaster(), te::rst::PointSetIterator< T >::getRow(), getValue(), and te::rst::BandProperty::m_noDataValue.

Referenced by ArithmeticWithRaster(), BOOST_AUTO_TEST_SUITE(), te::rst::RasterSummaryManager::get(), te::gdal::Band::getMinValue(), Texture(), and te::rst::Raster::toString().

std::complex< double > te::rst::Band::getOffsetValue ( ) const

It returns the offset values (real and imaginary) to be applied to the band.

Definition at line 565 of file src/terralib/raster/Band.cpp.

References m_property, and te::rst::BandProperty::m_valuesOffset.

Referenced by te::rst::Raster::toString().

te::rst::BandProperty * te::rst::Band::getProperty ( )

Returns the band property.

Definition at line 575 of file src/terralib/raster/Band.cpp.

References m_property.

const te::rst::BandProperty * te::rst::Band::getProperty ( ) const

Returns the band property.

Definition at line 580 of file src/terralib/raster/Band.cpp.

References m_property.

virtual Raster* te::rst::Band::getRaster ( ) const

pure virtual

std::complex< double > te::rst::Band::getScaleValue ( ) const

It returns the scale values (real and imaginary) to be applied to the band.

Definition at line 555 of file src/terralib/raster/Band.cpp.

References m_property, and te::rst::BandProperty::m_valuesScale.

Referenced by te::rst::Raster::toString().

std::complex< double > te::rst::Band::getStdValue	(	unsigned int	rs = `0`,
		unsigned int	cs = `0`,
		unsigned int	rf = `0`,
		unsigned int	cf = `0`
	)		const

virtual

It computes and returns the standard deviation of the occurring values in a window of the band.

Parameters

rs	The starting row.
cs	The starting column.
rf	The final row.
cf	The final column.

Note: This method without parameters will compute for the entire raster band.

Warning: The caller is responsible for providing correct values for the range [rs, cs x rf, cf].

Returns: The standard deviation of the occurring values in the window, real and imaginary (if present).

Reimplemented in te::gdal::Band.

Definition at line 206 of file src/terralib/raster/Band.cpp.

References getMeanValue(), te::rst::Raster::getNumberOfColumns(), te::rst::Raster::getNumberOfRows(), getRaster(), and getValue().

Referenced by te::rst::RasterSummaryManager::get(), te::gdal::Band::getStdValue(), and te::rst::Raster::toString().

virtual void te::rst::Band::getValue	(	unsigned int	c,
		unsigned int	r,
		double &	value
	)		const

pure virtual

Returns the cell attribute value.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	To return the attribute value.

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.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

Referenced by te::rp::GeoMosaic::calcBandStatistics(), te::rp::TiePointsMosaic::calcBandStatistics(), te::rp::SequenceMosaic::calcBandStatistics(), callOperator(), te::rp::ConvertHLS2RGB(), te::rp::ConvertIHS2RGB(), te::rp::ConvertRGB2HLS(), te::rp::ConvertRGB2IHS(), te::rst::Copy(), Copy2DiskRaster(), te::rp::Copy2DiskRaster(), te::rp::SequenceMosaic::createDiskRasterCopy(), te::rp::SequenceMosaic::createRasterDataSet(), te::rp::DecomposeBands(), te::rp::DirectWaveletAtrous(), te::rp::ArithmeticOperations::execBinaryOperatorRasterXRaster(), te::rp::ArithmeticOperations::execBinaryOperatorRasterXReal(), te::rp::Contrast::execSetMeanAndStdContrast(), te::rp::ArithmeticOperations::execUnaryOperatorRaster(), te::rp::ClassifierKMeansStrategy::execute(), te::rp::PostClassification::execute(), te::rp::GeoMosaic::execute(), te::rp::TiePointsMosaic::execute(), te::rp::SequenceMosaic::execute(), te::rp::Classifier::execute(), te::rp::Segmenter::execute(), exportRastertoGPKG(), te::rp::CloudDetection::generateSumRasters(), te::rp::GetCovarianceValue(), getHistogramR(), getMaxValue(), getMeanValue(), getMinValue(), te::attributefill::RasterToVector::getPixelDistinct(), te::rp::IHSFusion::getRGBRange(), getStdValue(), te::gdal::Band::getValue(), getValue(), te::rst::Raster::getValue(), te::rst::Raster::getValues(), te::rp::Skeleton::loadData(), te::rp::TiePointsLocatorStrategy::loadRasterData(), te::rp::Filter::MeanFilter(), te::rp::Filter::ModeFilter(), te::qt::plugins::terramobile::NormalizeRaster(), te::rp::RasterSlicing(), te::rp::Contrast::remapBandLevels(), te::rp::Filter::RobertsFilter(), te::rp::PostClassification::runPostClassification(), te::rp::PCAFusion::swapBandByHighResRaster(), te::rp::IHSFusion::swapIntensity(), te::rp::Filter::UpdateConvBuffer(), and te::rp::Filter::UserDefinedFilter().

void te::rst::Band::getValue	(	unsigned int	c,
		unsigned int	r,
		std::complex< double > &	value
	)		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).

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.

Reimplemented in te::gdal::Band.

Definition at line 62 of file src/terralib/raster/Band.cpp.

References getIValue(), and getValue().

te::rst::Band & te::rst::Band::operator*= ( Band & rhs )

virtual

It returns the band product (pixel by pixel).

Parameters

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

Note: Both bands must have the same properties, #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 band product.

Definition at line 762 of file src/terralib/raster/Band.cpp.

References callOperator(), and times().

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

virtual

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

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 band product.

Definition at line 757 of file src/terralib/raster/Band.cpp.

References callOperator(), and times().

te::rst::Band & te::rst::Band::operator+= ( Band & rhs )

virtual

It returns the band sum (pixel by pixel).

Parameters

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

Note: Both bands must have the same properties, #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 band sum.

Definition at line 737 of file src/terralib/raster/Band.cpp.

References callOperator(), and plus().

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

virtual

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

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 band sum.

Definition at line 742 of file src/terralib/raster/Band.cpp.

References callOperator(), and plus().

te::rst::Band & te::rst::Band::operator-= ( Band & rhs )

virtual

It returns the band subtraction (pixel by pixel).

Parameters

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

Note: Both bands must have the same properties, #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 band subtraction.

Definition at line 747 of file src/terralib/raster/Band.cpp.

References callOperator(), and minus().

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

virtual

It returns the difference from all pixels in the band to a constant value (pixel - 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 band difference.

Definition at line 752 of file src/terralib/raster/Band.cpp.

References callOperator(), and minus().

te::rst::Band & te::rst::Band::operator/= ( Band & rhs )

virtual

It returns the band division (pixel by pixel).

Parameters

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

Note: Both bands must have the same properties, #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 band division.

Definition at line 767 of file src/terralib/raster/Band.cpp.

References callOperator(), and divide().

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

virtual

It returns the division of all pixels in the band by a constant value (pixel / 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 band division.

Definition at line 772 of file src/terralib/raster/Band.cpp.

References callOperator(), and divide().

te::rst::Band & te::rst::Band::operator= ( const Band & rhs )

virtual

Assignment operator.

Parameters

rhs	The right-hand-side copy used to copy from.

Returns: A reference to this object.

Definition at line 48 of file src/terralib/raster/Band.cpp.

References m_idx, and m_property.

Referenced by te::mem::TiledBand::operator=(), te::mem::Band::operator=(), and te::gdal::Band::operator=().

virtual void te::rst::Band::read	(	int	x,
		int	y,
		void *	buffer
	)		const

pure virtual

It reads a data block to the specified buffer.

Parameters

x	The block-id in x (or x-offset).
y	The block-id in y (or y-offset).
buffer	The buffer to be used to read from the band.

Note: The upper-left corner is (0, 0).

Warning: The buffer must have been previously allocated and must have enough capacity.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

Referenced by te::rst::RasterSynchronizer::acquireBlock(), te::mem::ExpansibleRaster::clone(), te::rst::Copy(), modis_dataset::impl::extract_block_data(), te::mem::CachedBandBlocksManager::getBlockPointer(), te::rp::GetCovarianceValueThread(), te::rp::GetMeanValueThread(), te::rp::GetStdDevValueThread(), te::rp::Contrast::remapBandLevels(), te::rp::RemapValuesThread(), te::rst::BandIterator< T >::replaceBlock(), te::rst::ConstBandIterator< T >::replaceBlock(), te::rst::BandIteratorWindow< T >::replaceBlocks(), and te::mem::CachedBandBlocksManager::threadEntry().

virtual void* te::rst::Band::read	(	int	x,
		int	y
	)

pure virtual

It reads and returns a data block.

Parameters

x	The block-id in x (or x-offset).
y	The block-id in y (or y-offset).

Note: The upper-left corner is (0, 0).

Returns: The specified data block.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

virtual void te::rst::Band::setIValue	(	unsigned int	c,
		unsigned int	r,
		const double	value
	)

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

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.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

Referenced by te::rst::Raster::setIValue(), and setValue().

void te::rst::Band::setOffsetValue ( const std::complex< double > o )

Sets the offset values (real and imaginary) to be applied to the band.

Parameters

o	The new offset.

Definition at line 570 of file src/terralib/raster/Band.cpp.

References m_property, and te::rst::BandProperty::m_valuesOffset.

void te::rst::Band::setScaleValue ( const std::complex< double > s )

Sets the scale values (real and imaginary) to be applied to the band.

Parameters

s	The new scale.

Definition at line 560 of file src/terralib/raster/Band.cpp.

References m_property, and te::rst::BandProperty::m_valuesScale.

virtual void te::rst::Band::setValue	(	unsigned int	c,
		unsigned int	r,
		const double	value
	)

pure virtual

Sets the cell attribute value.

Parameters

c	The column location of the cell.
r	The row location of the cell.
value	The attribute value to be assigned.

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.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

void te::rst::Band::setValue	(	unsigned int	c,
		unsigned int	r,
		const std::complex< double > &	value
	)

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

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.

Reimplemented in te::gdal::Band.

Definition at line 75 of file src/terralib/raster/Band.cpp.

References setIValue(), and setValue().

virtual void te::rst::Band::write	(	int	x,
		int	y,
		void *	buffer
	)

pure virtual

It writes a data block from the specified buffer.

Parameters

x	The block-id in x (or x-offset).
y	The block-id in y (or y-offset).
buffer	The buffer to be used to write to the band.

Note: The upper-left corner is (0, 0).

Warning: The method will copy the same amount of bytes used by the internal band block representation.

Implemented in te::gdal::Band, te::idl::IdlBand, te::mem::ExpansibleBand, te::mem::CachedBand, te::rst::SynchronizedBand, te::mem::Band, te::grib::Band, te::mem::TiledBand, and terralib4::Band.

Referenced by te::mem::ExpansibleRaster::clone(), te::rst::Copy(), te::mem::CachedBandBlocksManager::free(), te::mem::CachedBandBlocksManager::getBlockPointer(), te::rst::RasterSynchronizer::releaseBlock(), te::rp::Contrast::remapBandLevels(), te::rp::RemapValuesThread(), and te::mem::CachedBandBlocksManager::threadEntry().

Member Data Documentation

std::size_t te::rst::Band::m_idx

protected

The band index.

Definition at line 500 of file src/terralib/raster/Band.h.

Referenced by te::rst::SynchronizedBand::getIValue(), te::mem::CachedBand::getIValue(), te::mem::ExpansibleBand::getIValue(), te::idl::IdlBand::getIValue(), terralib4::Band::getValue(), te::rst::SynchronizedBand::getValue(), te::mem::CachedBand::getValue(), te::mem::ExpansibleBand::getValue(), te::idl::IdlBand::getValue(), operator=(), terralib4::Band::read(), te::rst::SynchronizedBand::read(), te::mem::CachedBand::read(), te::mem::ExpansibleBand::read(), te::rst::SynchronizedBand::setIValue(), te::mem::CachedBand::setIValue(), te::mem::ExpansibleBand::setIValue(), te::idl::IdlBand::setIValue(), te::rst::SynchronizedBand::setValue(), te::mem::CachedBand::setValue(), te::mem::ExpansibleBand::setValue(), te::idl::IdlBand::setValue(), te::rst::SynchronizedBand::write(), te::mem::CachedBand::write(), and te::mem::ExpansibleBand::write().

BandProperty* te::rst::Band::m_property

protected

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation