Base class for processing filters like renderers, reprojector, resampler etc. More...

#include <qgsrasterinterface.h>

Inheritance diagram for QgsRasterInterface:

Collaboration diagram for QgsRasterInterface:

Public Types
enum	Capability { NoCapabilities = 0, Size = 1 << 1, Create = 1 << 2, Remove = 1 << 3, BuildPyramids = 1 << 4, Identify = 1 << 5, IdentifyValue = 1 << 6, IdentifyText = 1 << 7, IdentifyHtml = 1 << 8, IdentifyFeature = 1 << 9 }
	If you add to this, please also add to capabilitiesString() More...
Public Member Functions
	QgsRasterInterface (QgsRasterInterface *input=0)
virtual	~QgsRasterInterface ()
virtual int	bandCount () const =0
	Get number of bands.
virtual QgsRasterBandStats	bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Get band statistics.
virtual QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height)=0
	Read block of data using given extent and size.
virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities.
QString	capabilitiesString () const
	Returns the above in friendly format.
virtual QgsRasterInterface *	clone () const =0
	Clone itself, create deep copy.
virtual void	cumulativeCut (int theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Find values for cumulative pixel count cut.
virtual QGis::DataType	dataType (int bandNo) const =0
	Returns data type for the band specified by number.
int	dataTypeSize (int bandNo)
virtual QgsRectangle	extent ()
	Get the extent of the interface.
virtual QString	generateBandName (int theBandNumber) const
	helper function to create zero padded band names
virtual bool	hasHistogram (int theBandNo, int theBinCount, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram()
virtual bool	hasStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Returns true if histogram is available (cached, already calculated).
virtual QgsRasterHistogram	histogram (int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Get histogram.
virtual QgsRasterInterface *	input () const
	Current input.
virtual bool	on () const
	Is on/off.
virtual void	readXML (const QDomElement &filterElem)
	Sets base class members from xml.
virtual bool	setInput (QgsRasterInterface *input)
	Set input.
virtual void	setOn (bool on)
	Set on/off.
virtual QGis::DataType	srcDataType (int bandNo) const
	Returns source data type for the band specified by number, source data type may be shorter than dataType.
virtual const QgsRasterInterface *	srcInput () const
	Get source / raw input, the first in pipe, usually provider.
virtual QgsRasterInterface *	srcInput ()
virtual void	writeXML (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.
virtual int	xBlockSize () const
	Get block size.
virtual int	xSize () const
	Get raster size.
virtual int	yBlockSize () const
virtual int	ySize () const
Protected Member Functions
void	initHistogram (QgsRasterHistogram &theHistogram, int theBandNo, int theBinCount=0, double theMinimum=std::numeric_limits< double >::quiet_NaN(), double theMaximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0, bool theIncludeOutOfRange=false)
	Fill in histogram defaults if not specified.
void	initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0)
	Fill in statistics defaults if not specified.
Protected Attributes
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed.
QgsRasterInterface *	mInput
bool	mOn
QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed.
Private Member Functions
	Q_DECLARE_TR_FUNCTIONS (QgsRasterInterface)

Detailed Description

Base class for processing filters like renderers, reprojector, resampler etc.

Definition at line 35 of file qgsrasterinterface.h.

Member Enumeration Documentation

enum QgsRasterInterface::Capability

If you add to this, please also add to capabilitiesString()

Enumerator:

NoCapabilities
Size
Create
Remove
BuildPyramids
Identify
IdentifyValue
IdentifyText
IdentifyHtml
IdentifyFeature

Definition at line 41 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

QgsRasterInterface::QgsRasterInterface ( QgsRasterInterface * input = 0 )

Definition at line 32 of file qgsrasterinterface.cpp.

QgsRasterInterface::~QgsRasterInterface ( ) [virtual]

Definition at line 38 of file qgsrasterinterface.cpp.

Member Function Documentation

virtual int QgsRasterInterface::bandCount ( ) const [pure virtual]

Get number of bands.

Implemented in QgsRasterProjector, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterNuller, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.

Referenced by QgsBrightnessContrastFilter::bandCount(), QgsRasterResampleFilter::bandCount(), QgsRasterNuller::bandCount(), QgsHueSaturationFilter::bandCount(), QgsRasterRenderer::bandCount(), QgsRasterProjector::bandCount(), QgsRasterLayer::bandCount(), QgsRasterFileWriter::createVRT(), QgsRasterRendererRegistry::defaultRendererForDrawingStyle(), QgsRasterDataProvider::identify(), QgsRasterMinMaxWidget::on_mLoadPushButton_clicked(), QgsRasterLayerSaveAsDialog::on_mRawModeRadioButton_toggled(), QgsMultiBandColorRendererWidget::QgsMultiBandColorRendererWidget(), QgsPalettedRendererWidget::QgsPalettedRendererWidget(), QgsSingleBandGrayRendererWidget::QgsSingleBandGrayRendererWidget(), QgsSingleBandPseudoColorRendererWidget::QgsSingleBandPseudoColorRendererWidget(), QgsRasterChecker::runTest(), QgsRasterLayer::setDataProvider(), QgsBrightnessContrastFilter::setInput(), QgsRasterResampleFilter::setInput(), QgsHueSaturationFilter::setInput(), QgsRasterRenderer::setInput(), QgsRasterFileWriter::writeDataRaster(), and QgsRasterLayer::writeXml().

QgsRasterBandStats QgsRasterInterface::bandStatistics	(	int	theBandNo,
		int	theStats = `QgsRasterBandStats::All`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`
	)		`[virtual]`

Get band statistics.

Parameters:

theBandNo	The band (number).
theStats	Requested statistics
theExtent	Extent used to calc statistics, if empty, whole raster extent is used.
theSampleSize	Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.

Returns:: Band statistics.

Definition at line 121 of file qgsrasterinterface.cpp.

Referenced by QgsProjectFileTransform::convertRasterProperties(), initHistogram(), QgsRasterLayer::metadata(), QgsRasterRendererRegistry::minMaxValuesForBand(), QgsRasterMinMaxWidget::on_mLoadPushButton_clicked(), QgsRasterChecker::runTest(), QgsRasterLayer::setContrastEnhancement(), and QgsRasterFileWriter::writeDataRaster().

virtual QgsRasterBlock* QgsRasterInterface::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)		`[pure virtual]`

Read block of data using given extent and size.

Returns pointer to data. Caller is responsible to free the memory returned.

Parameters:

bandNo	band number
extent	extent of block
width	pixel width of block
height	pixel height of block

Implemented in QgsRasterDataProvider, QgsRasterProjector, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterNuller, QgsRasterResampleFilter, QgsSingleBandGrayRenderer, QgsBrightnessContrastFilter, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsSingleBandColorDataRenderer, and QgsSingleBandPseudoColorRenderer.

Referenced by bandStatistics(), QgsPalettedRasterRenderer::block(), QgsSingleBandColorDataRenderer::block(), QgsSingleBandPseudoColorRenderer::block(), QgsMultiBandColorRenderer::block(), QgsBrightnessContrastFilter::block(), QgsSingleBandGrayRenderer::block(), QgsRasterResampleFilter::block(), QgsRasterNuller::block(), QgsHueSaturationFilter::block(), QgsRasterProjector::block(), histogram(), and QgsRasterIterator::readNextRasterPart().

virtual int QgsRasterInterface::capabilities ( ) const [inline, virtual]

Returns a bitmask containing the supported capabilities.

Definition at line 63 of file qgsrasterinterface.h.

References NoCapabilities.

Referenced by QgsRasterResampleFilter::block(), QgsRasterDataProvider::block(), QgsRasterProjector::calc(), capabilitiesString(), QgsRasterDataProvider::identify(), QgsMapToolIdentify::identifyRasterLayer(), initHistogram(), initStatistics(), QgsRasterLayerSaveAsDialog::QgsRasterLayerSaveAsDialog(), QgsRasterLayer::rasterUnitsPerPixelX(), QgsRasterLayer::rasterUnitsPerPixelY(), QgsRasterLayer::setDataProvider(), QgsRasterLayerSaveAsDialog::setOriginalResolution(), and QgsRasterLayerSaveAsDialog::toggleResolutionSize().

QString QgsRasterInterface::capabilitiesString ( ) const

Returns the above in friendly format.

Definition at line 539 of file qgsrasterinterface.cpp.

References BuildPyramids, capabilities(), Create, Identify, QgsDebugMsg, Remove, and tr.

virtual QgsRasterInterface* QgsRasterInterface::clone ( ) const [pure virtual]

Clone itself, create deep copy.

Implemented in QgsRasterProjector, QgsRasterDataProvider, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterNuller, QgsSingleBandGrayRenderer, QgsRasterResampleFilter, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsBrightnessContrastFilter, QgsSingleBandPseudoColorRenderer, and QgsSingleBandColorDataRenderer.

Referenced by QgsRasterPipe::QgsRasterPipe().

void QgsRasterInterface::cumulativeCut	(	int	theBandNo,
		double	theLowerCount,
		double	theUpperCount,
		double &	theLowerValue,
		double &	theUpperValue,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`
	)		`[virtual]`

Find values for cumulative pixel count cut.

Parameters:

theBandNo	The band (number).
theLowerCount	The lower count as fraction of 1, e.g. 0.02 = 2%
theUpperCount	The upper count as fraction of 1, e.g. 0.98 = 98%
theLowerValue	Location into which the lower value will be set.
theUpperValue	Location into which the upper value will be set.
theExtent	Extent used to calc histogram, if empty, whole raster extent is used.
theSampleSize	Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.

Definition at line 500 of file qgsrasterinterface.cpp.

References QgsRasterHistogram::binCount, histogram(), QgsRasterHistogram::histogramVector, QgsRasterHistogram::maximum, QgsRasterHistogram::minimum, QgsRasterHistogram::nonNullCount, and QgsDebugMsg.

Referenced by QgsRasterMinMaxWidget::on_mLoadPushButton_clicked(), and QgsRasterLayer::setContrastEnhancement().

virtual QGis::DataType QgsRasterInterface::dataType ( int bandNo ) const [pure virtual]

int QgsRasterInterface::dataTypeSize ( int bandNo ) [inline]

Definition at line 86 of file qgsrasterinterface.h.

References QgsRasterBlock::typeSize().

Referenced by QgsRasterDataProvider::block().

virtual QgsRectangle QgsRasterInterface::extent ( ) [inline, virtual]

Get the extent of the interface.

Returns:: QgsRectangle containing the extent of the layer

Reimplemented in QgsRasterDataProvider.

Definition at line 84 of file qgsrasterinterface.h.

Referenced by QgsRasterProjector::block(), initHistogram(), and initStatistics().

virtual QString QgsRasterInterface::generateBandName ( int theBandNumber ) const [inline, virtual]

helper function to create zero padded band names

Definition at line 100 of file qgsrasterinterface.h.

References tr.

Referenced by QgsRasterLayer::bandName(), QgsRasterRendererWidget::displayBandName(), and QgsMapToolIdentify::identifyRasterLayer().

bool QgsRasterInterface::hasHistogram	(	int	theBandNo,
		int	theBinCount,
		double	theMinimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	theMaximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`,
		bool	theIncludeOutOfRange = `false`
	)		`[virtual]`

Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram()

Note:: theBinCount, theMinimun and theMaximum not optional in python bindings

Definition at line 359 of file qgsrasterinterface.cpp.

References histogram(), initHistogram(), mHistograms, and QgsDebugMsg.

Referenced by QgsRasterHistogramWidget::computeHistogram().

bool QgsRasterInterface::hasStatistics	(	int	theBandNo,
		int	theStats = `QgsRasterBandStats::All`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`
	)		`[virtual]`

Returns true if histogram is available (cached, already calculated).

* The parameters are the same as in bandStatistics()

Returns:: true if statistics are available (ready to use)

Definition at line 99 of file qgsrasterinterface.cpp.

References QgsRasterBandStats::contains(), initStatistics(), mStatistics, and QgsDebugMsg.

QgsRasterHistogram QgsRasterInterface::histogram	(	int	theBandNo,
		int	theBinCount = `0`,
		double	theMinimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	theMaximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`,
		bool	theIncludeOutOfRange = `false`
	)		`[virtual]`

Get histogram.

Histograms are cached in providers.

Parameters:

theBandNo	The band (number).
theBinCount	Number of bins (intervals,buckets). If 0, the number of bins is decided automaticaly according to data type, raster size etc.
theMinimum	Minimum value, if NaN, raster minimum value will be used.
theMaximum	Maximum value, if NaN, raster minimum value will be used.
theExtent	Extent used to calc histogram, if empty, whole raster extent is used.
theSampleSize	Approximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.
theIncludeOutOfRange	include out of range values

Returns:: Vector of non NULL cell counts for each bin.

Note:: theBinCount, theMinimun and theMaximum not optional in python bindings

Definition at line 385 of file qgsrasterinterface.cpp.

Referenced by QgsRasterHistogramWidget::computeHistogram(), cumulativeCut(), hasHistogram(), and QgsRasterHistogramWidget::refreshHistogram().

void QgsRasterInterface::initHistogram	(	QgsRasterHistogram &	theHistogram,
		int	theBandNo,
		int	theBinCount = `0`,
		double	theMinimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	theMaximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theSampleSize = `0`,
		bool	theIncludeOutOfRange = `false`
	)		`[protected]`

Fill in histogram defaults if not specified.

Note:: theBinCount, theMinimun and theMaximum not optional in python bindings

Definition at line 248 of file qgsrasterinterface.cpp.

Referenced by hasHistogram(), and histogram().

void QgsRasterInterface::initStatistics	(	QgsRasterBandStats &	theStatistics,
		int	theBandNo,
		int	theStats = `QgsRasterBandStats::All`,
		const QgsRectangle &	theExtent = `QgsRectangle()`,
		int	theBinCount = `0`
	)		`[protected]`