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

#include <qgsrasterinterface.h>

Inheritance diagram for QgsRasterInterface:

[legend]

Public Member Functions
	QgsRasterInterface (QgsRasterInterface *input=nullptr)

virtual	~QgsRasterInterface ()=default

virtual int	bandCount () const =0
	Gets number of bands.

Q_DECL_DEPRECATED QgsRasterBandStats	bandStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

virtual QgsRasterBandStats	bandStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
	Returns the band statistics.

virtual QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
	Read block of data using given extent and size.

virtual Qgis::RasterInterfaceCapabilities	capabilities () const
	Returns the capabilities supported by the interface.

Q_DECL_DEPRECATED QString	capabilitiesString () const
	Returns the raster interface capabilities in friendly format.

virtual QgsRasterInterface *	clone () const =0
	Clone itself, create deep copy.

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber.

virtual void	cumulativeCut (int bandNo, double lowerCount, double upperCount, double &lowerValue, double &upperValue, const QgsRectangle &extent=QgsRectangle(), int sampleSize=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) const
	Returns the size (in bytes) for the data type for the specified band.

QString	displayBandName (int bandNumber) const
	Generates a friendly, descriptive name for the specified bandNumber.

virtual QgsRectangle	extent () const
	Gets the extent of the interface.

virtual QString	generateBandName (int bandNumber) const
	helper function to create zero padded band names

virtual bool	hasHistogram (int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Returns `true` if histogram is available (cached, already calculated)

Q_DECL_DEPRECATED bool	hasStatistics (int bandNo, int stats, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual bool	hasStatistics (int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0)
	Returns `true` if histogram is available (cached, already calculated).

virtual QgsRasterHistogram	histogram (int bandNo, int binCount=0, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false, QgsRasterBlockFeedback *feedback=nullptr)
	Returns a band histogram.

virtual QgsRasterInterface *	input () const
	Current input.

virtual bool	on () const
	Returns whether the interface is on or off.

virtual void	readXml (const QDomElement &filterElem)
	Sets base class members from xml. Usually called from create() methods of subclasses.

virtual bool	setInput (QgsRasterInterface *input)
	Set input.

virtual void	setOn (bool on)
	Sets whether the interface is on or off.

virtual Qgis::DataType	sourceDataType (int bandNo) const
	Returns source data type for the band specified by number, source data type may be shorter than dataType.

virtual QgsRasterInterface *	sourceInput ()
	Gets source / raw input, the first in pipe, usually provider.

virtual const QgsRasterInterface *	sourceInput () const
	Gets source / raw input, the first in pipe, usually provider.

virtual void	writeXml (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml.

virtual int	xBlockSize () const
	Gets block size.

virtual int	xSize () const
	Gets raster size.

virtual int	yBlockSize () const

virtual int	ySize () const

Protected Member Functions
void	initHistogram (QgsRasterHistogram &histogram, int bandNo, int binCount, double minimum=std::numeric_limits< double >::quiet_NaN(), double maximum=std::numeric_limits< double >::quiet_NaN(), const QgsRectangle &boundingBox=QgsRectangle(), int sampleSize=0, bool includeOutOfRange=false)
	Fill in histogram defaults if not specified.

Q_DECL_DEPRECATED void	initStatistics (QgsRasterBandStats &statistics, int bandNo, int stats, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

void	initStatistics (QgsRasterBandStats &statistics, int bandNo, Qgis::RasterBandStatistics stats=Qgis::RasterBandStatistic::All, const QgsRectangle &boundingBox=QgsRectangle(), int binCount=0) const
	Fill in statistics defaults if not specified.

Protected Attributes
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed.

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed.

Detailed Description

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

Definition at line 135 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

◆ QgsRasterInterface()

QgsRasterInterface::QgsRasterInterface ( QgsRasterInterface * input = nullptr )

Definition at line 31 of file qgsrasterinterface.cpp.

◆ ~QgsRasterInterface()

virtual QgsRasterInterface::~QgsRasterInterface ( )

virtualdefault

Member Function Documentation

◆ bandCount()

virtual int QgsRasterInterface::bandCount ( ) const

pure virtual

Gets number of bands.

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

◆ bandStatistics() [1/2]

QgsRasterBandStats QgsRasterInterface::bandStatistics	(	int	bandNo,
		int	stats,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

Returns the band statistics.

Parameters

bandNo	The band (number).
stats	Requested statistics
extent	Extent used to calc statistics, if empty, whole raster extent is used.
sampleSize	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.
feedback	optional feedback object

Deprecated:: QGIS 3.40. Use Qgis::RasterBandStatistic instead of int for stats argument.

Definition at line 652 of file qgsrasterinterface.cpp.

◆ bandStatistics() [2/2]

QgsRasterBandStats QgsRasterInterface::bandStatistics	(	int	bandNo,
		Qgis::RasterBandStatistics	stats = `Qgis::RasterBandStatistic::All`,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

virtual

Returns the band statistics.

Parameters

bandNo	The band (number).
stats	Requested statistics
extent	Extent used to calc statistics, if empty, whole raster extent is used.
sampleSize	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.
feedback	optional feedback object

Definition at line 121 of file qgsrasterinterface.cpp.

◆ block()

virtual QgsRasterBlock * QgsRasterInterface::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

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
feedback	optional raster feedback object for cancellation/preview. Added in QGIS 3.0.

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

◆ capabilities()

Qgis::RasterInterfaceCapabilities QgsRasterInterface::capabilities ( ) const

virtual

Returns the capabilities supported by the interface.

Definition at line 36 of file qgsrasterinterface.cpp.

◆ capabilitiesString()

QString QgsRasterInterface::capabilitiesString ( ) const

Returns the raster interface capabilities in friendly format.

Deprecated:: QGIS 3.40. Will be removed in QGIS 4.0.

Definition at line 599 of file qgsrasterinterface.cpp.

◆ clone()

virtual QgsRasterInterface * QgsRasterInterface::clone ( ) const

pure virtual

Clone itself, create deep copy.

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

◆ colorInterpretationName()

QString QgsRasterInterface::colorInterpretationName ( int bandNumber ) const

virtual

Returns the name of the color interpretation for the specified bandNumber.

It is translated since QGIS 3.40

Since: QGIS 3.18

Reimplemented in QgsRasterDataProvider.

Definition at line 633 of file qgsrasterinterface.cpp.

◆ cumulativeCut()

void QgsRasterInterface::cumulativeCut	(	int	bandNo,
		double	lowerCount,
		double	upperCount,
		double &	lowerValue,
		double &	upperValue,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`
	)

virtual

Find values for cumulative pixel count cut.

Parameters

bandNo	The band (number).
lowerCount	The lower count as fraction of 1, e.g. 0.02 = 2%
upperCount	The upper count as fraction of 1, e.g. 0.98 = 98%
lowerValue	Location into which the lower value will be set.
upperValue	Location into which the upper value will be set.
extent	Extent used to calc histogram, if empty, whole raster extent is used.
sampleSize	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 537 of file qgsrasterinterface.cpp.

◆ dataType()

virtual Qgis::DataType QgsRasterInterface::dataType ( int bandNo ) const

pure virtual

Returns data type for the band specified by number.

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

◆ dataTypeSize()

int QgsRasterInterface::dataTypeSize ( int bandNo ) const

inline

Returns the size (in bytes) for the data type for the specified band.

Definition at line 248 of file qgsrasterinterface.h.

◆ displayBandName()

QString QgsRasterInterface::displayBandName ( int bandNumber ) const

Generates a friendly, descriptive name for the specified bandNumber.

Since: QGIS 3.18

Definition at line 641 of file qgsrasterinterface.cpp.

◆ extent()

virtual QgsRectangle QgsRasterInterface::extent ( ) const

inlinevirtual

Gets the extent of the interface.

Returns: QgsRectangle containing the extent of the layer

Reimplemented in QgsRasterDataProvider.

Definition at line 243 of file qgsrasterinterface.h.

◆ generateBandName()

QString QgsRasterInterface::generateBandName ( int bandNumber ) const

virtual

helper function to create zero padded band names

Definition at line 624 of file qgsrasterinterface.cpp.

◆ hasHistogram()

bool QgsRasterInterface::hasHistogram	(	int	bandNo,
		int	binCount,
		double	minimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	maximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`,
		bool	includeOutOfRange = `false`
	)

virtual

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

Note: the parameters are the same as in

See also: histogram()

Definition at line 391 of file qgsrasterinterface.cpp.

◆ hasStatistics() [1/2]

bool QgsRasterInterface::hasStatistics	(	int	bandNo,
		int	stats,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`
	)

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)

Deprecated:: QGIS 3.40. Use Qgis::RasterBandStatistic instead of int for stats argument.

Definition at line 254 of file qgsrasterinterface.cpp.

◆ hasStatistics() [2/2]

bool QgsRasterInterface::hasStatistics	(	int	bandNo,
		Qgis::RasterBandStatistics	stats = `Qgis::RasterBandStatistic::All`,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `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 98 of file qgsrasterinterface.cpp.

◆ histogram()

QgsRasterHistogram QgsRasterInterface::histogram	(	int	bandNo,
		int	binCount = `0`,
		double	minimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	maximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	extent = `QgsRectangle()`,
		int	sampleSize = `0`,
		bool	includeOutOfRange = `false`,
		QgsRasterBlockFeedback *	feedback = `nullptr`
	)

virtual

Returns a band histogram.

Histograms are cached in providers.

Parameters

bandNo	The band (number).
binCount	Number of bins (intervals,buckets). If 0, the number of bins is decided automatically according to data type, raster size etc.
minimum	Minimum value, if NaN (None for Python), raster minimum value will be used.
maximum	Maximum value, if NaN (None for Python), raster maximum value will be used.
extent	Extent used to calc histogram, if empty, whole raster extent is used.
sampleSize	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.
includeOutOfRange	include out of range values
feedback	optional feedback object

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

Note: binCount, minimum and maximum not optional in Python bindings

Definition at line 418 of file qgsrasterinterface.cpp.

◆ initHistogram()

void QgsRasterInterface::initHistogram	(	QgsRasterHistogram &	histogram,
		int	bandNo,
		int	binCount,
		double	minimum = `std::numeric_limits<double>::quiet_NaN()`,
		double	maximum = `std::numeric_limits<double>::quiet_NaN()`,
		const QgsRectangle &	boundingBox = `QgsRectangle()`,
		int	sampleSize = `0`,
		bool	includeOutOfRange = `false`
	)

protected

Fill in histogram defaults if not specified.

Note: the parameters are the same as in

See also: histogram()

Definition at line 259 of file qgsrasterinterface.cpp.

◆ initStatistics() [1/2]

void QgsRasterInterface::initStatistics	(	QgsRasterBandStats &	statistics,
		int	bandNo,
		int	stats,
		const QgsRectangle &	boundingBox = `QgsRectangle()`,
		int	binCount = `0`
	)		const

protected

Fill in statistics defaults if not specified.

Deprecated:: QGIS 3.40. Use Qgis::RasterBandStatistic instead of int for stats argument.

Definition at line 386 of file qgsrasterinterface.cpp.

◆ initStatistics() [2/2]

void QgsRasterInterface::initStatistics	(	QgsRasterBandStats &	statistics,
		int	bandNo,
		Qgis::RasterBandStatistics	stats = `Qgis::RasterBandStatistic::All`,
		const QgsRectangle &	boundingBox = `QgsRectangle()`,
		int	binCount = `0`
	)		const

protected

Fill in statistics defaults if not specified.

Definition at line 41 of file qgsrasterinterface.cpp.

◆ input()

virtual QgsRasterInterface * QgsRasterInterface::input ( ) const

inlinevirtual

Current input.

Definition at line 298 of file qgsrasterinterface.h.

◆ on()

virtual bool QgsRasterInterface::on ( ) const

inlinevirtual

Returns whether the interface is on or off.

Definition at line 301 of file qgsrasterinterface.h.

◆ readXml()

virtual void QgsRasterInterface::readXml ( const QDomElement & filterElem )

inlinevirtual

Sets base class members from xml. Usually called from create() methods of subclasses.

Reimplemented in QgsBrightnessContrastFilter, QgsHueSaturationFilter, QgsRasterDataProvider, QgsRasterResampleFilter, and QgsRasterRenderer.

Definition at line 512 of file qgsrasterinterface.h.

◆ setInput()

virtual bool QgsRasterInterface::setInput ( QgsRasterInterface * input )

inlinevirtual

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented in QgsBrightnessContrastFilter, QgsHueSaturationFilter, QgsRasterDataProvider, QgsRasterRenderer, QgsRasterResampleFilter, and QgsSingleBandColorDataRenderer.

Definition at line 295 of file qgsrasterinterface.h.

◆ setOn()

virtual void QgsRasterInterface::setOn ( bool on )

inlinevirtual

Sets whether the interface is on or off.

Definition at line 304 of file qgsrasterinterface.h.

◆ sourceDataType()

virtual Qgis::DataType QgsRasterInterface::sourceDataType ( int bandNo ) const

inlinevirtual

Returns source data type for the band specified by number, source data type may be shorter than dataType.

Reimplemented in QgsRasterDataProvider.

Definition at line 237 of file qgsrasterinterface.h.

◆ sourceInput() [1/2]

virtual QgsRasterInterface * QgsRasterInterface::sourceInput ( )

inlinevirtual

Gets source / raw input, the first in pipe, usually provider.

It may be used to get info about original data, e.g. resolution to decide resampling etc.

Definition at line 323 of file qgsrasterinterface.h.

◆ sourceInput() [2/2]

virtual const QgsRasterInterface * QgsRasterInterface::sourceInput ( ) const

inlinevirtual

Gets source / raw input, the first in pipe, usually provider.

It may be used to get info about original data, e.g. resolution to decide resampling etc.

Note: not available in Python bindings.

Definition at line 312 of file qgsrasterinterface.h.

◆ writeXml()

virtual void QgsRasterInterface::writeXml	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const

inlinevirtual

Write base class members to xml.

Reimplemented in QgsBrightnessContrastFilter, QgsHillshadeRenderer, QgsHueSaturationFilter, QgsMultiBandColorRenderer, QgsPalettedRasterRenderer, QgsRasterContourRenderer, QgsRasterDataProvider, QgsRasterResampleFilter, QgsRasterSingleColorRenderer, QgsSingleBandColorDataRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.

Definition at line 510 of file qgsrasterinterface.h.

◆ xBlockSize()

virtual int QgsRasterInterface::xBlockSize ( ) const

inlinevirtual

Gets block size.

Definition at line 254 of file qgsrasterinterface.h.

◆ xSize()

virtual int QgsRasterInterface::xSize ( ) const

inlinevirtual

Gets raster size.

Definition at line 258 of file qgsrasterinterface.h.

◆ yBlockSize()

virtual int QgsRasterInterface::yBlockSize ( ) const

inlinevirtual

Definition at line 255 of file qgsrasterinterface.h.

◆ ySize()

virtual int QgsRasterInterface::ySize ( ) const

inlinevirtual

Definition at line 259 of file qgsrasterinterface.h.

Member Data Documentation

◆ mHistograms

QList<QgsRasterHistogram> QgsRasterInterface::mHistograms

protected

List of cached histograms, all bands mixed.

Definition at line 522 of file qgsrasterinterface.h.

◆ mInput

QgsRasterInterface* QgsRasterInterface::mInput = nullptr

protected

Definition at line 516 of file qgsrasterinterface.h.

◆ mOn

bool QgsRasterInterface::mOn = true

protected

Definition at line 525 of file qgsrasterinterface.h.

◆ mStatistics

QList<QgsRasterBandStats> QgsRasterInterface::mStatistics

protected

List of cached statistics, all bands mixed.

Definition at line 519 of file qgsrasterinterface.h.

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

/build/qgis-3.40.0+99sid/src/core/raster/qgsrasterinterface.h
/build/qgis-3.40.0+99sid/src/core/raster/qgsrasterinterface.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterInterface()

◆ ~QgsRasterInterface()

Member Function Documentation

◆ bandCount()

◆ bandStatistics() [1/2]

◆ bandStatistics() [2/2]

◆ block()

◆ capabilities()

◆ capabilitiesString()

◆ clone()

◆ colorInterpretationName()

◆ cumulativeCut()

◆ dataType()

◆ dataTypeSize()

◆ displayBandName()

◆ extent()

◆ generateBandName()

◆ hasHistogram()

◆ hasStatistics() [1/2]

◆ hasStatistics() [2/2]

◆ histogram()

◆ initHistogram()

◆ initStatistics() [1/2]

◆ initStatistics() [2/2]

◆ input()

◆ on()

◆ readXml()

◆ setInput()

◆ setOn()

◆ sourceDataType()

◆ sourceInput() [1/2]

◆ sourceInput() [2/2]

◆ writeXml()

◆ xBlockSize()

◆ xSize()

◆ yBlockSize()

◆ ySize()

Member Data Documentation

◆ mHistograms

◆ mInput

◆ mOn

◆ mStatistics