Resample filter pipe for rasters. More...

#include <qgsrasterresamplefilter.h>

Inheritance diagram for QgsRasterResampleFilter:

Public Member Functions
	QgsRasterResampleFilter (QgsRasterInterface *input=nullptr)

int	bandCount () const override
	Gets number of bands. More...

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

QgsRasterResampleFilter *	clone () const override
	Clone itself, create deep copy. More...

Qgis::DataType	dataType (int bandNo) const override
	Returns data type for the band specified by number. More...

double	maxOversampling () const

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

bool	setInput (QgsRasterInterface *input) override
	Set input. More...

void	setMaxOversampling (double os)

void	setZoomedInResampler (QgsRasterResampler *r)
	Sets resampler for zoomed in scales. Takes ownership of the object. More...

void	setZoomedOutResampler (QgsRasterResampler *r)
	Sets resampler for zoomed out scales. Takes ownership of the object. More...

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

const QgsRasterResampler *	zoomedInResampler () const

const QgsRasterResampler *	zoomedOutResampler () const

Public Member Functions inherited from QgsRasterInterface
	QgsRasterInterface (QgsRasterInterface *input=nullptr)

virtual	~QgsRasterInterface ()=default

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

virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities. More...

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

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

int	dataTypeSize (int bandNo)

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

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

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

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

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

virtual QgsRasterInterface *	input () const
	Current input. More...

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

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

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

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

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

virtual int	xBlockSize () const
	Gets block size. More...

virtual int	xSize () const
	Gets raster size. More...

virtual int	yBlockSize () const

virtual int	ySize () const

Protected Attributes
double	mMaxOversampling = 2.0
	Maximum boundary for oversampling (to avoid too much data traffic). Default: 2.0. More...

std::unique_ptr< QgsRasterResampler >	mZoomedInResampler
	Resampler used if screen resolution is higher than raster resolution (zoomed in). 0 means no resampling (nearest neighbour) More...

std::unique_ptr< QgsRasterResampler >	mZoomedOutResampler
	Resampler used if raster resolution is higher than raster resolution (zoomed out). 0 mean no resampling (nearest neighbour) More...

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

QgsRasterInterface *	mInput = nullptr

bool	mOn = true

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

Additional Inherited Members
Public Types inherited from QgsRasterInterface
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, Prefetch = 1 << 10 }
	If you add to this, please also add to capabilitiesString() More...

Protected Member Functions inherited from QgsRasterInterface
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. More...

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

Detailed Description

Resample filter pipe for rasters.

Definition at line 32 of file qgsrasterresamplefilter.h.

Constructor & Destructor Documentation

◆ QgsRasterResampleFilter()

QgsRasterResampleFilter::QgsRasterResampleFilter ( QgsRasterInterface * input = nullptr )

Definition at line 35 of file qgsrasterresamplefilter.cpp.

Member Function Documentation

◆ bandCount()

int QgsRasterResampleFilter::bandCount ( ) const

overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 56 of file qgsrasterresamplefilter.cpp.

◆ block()

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

overridevirtual

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.

Implements QgsRasterInterface.

Definition at line 121 of file qgsrasterresamplefilter.cpp.

◆ clone()

QgsRasterResampleFilter * QgsRasterResampleFilter::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 40 of file qgsrasterresamplefilter.cpp.

◆ dataType()

Qgis::DataType QgsRasterResampleFilter::dataType ( int bandNo ) const

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 65 of file qgsrasterresamplefilter.cpp.

◆ maxOversampling()

double QgsRasterResampleFilter::maxOversampling ( ) const

inline

Definition at line 56 of file qgsrasterresamplefilter.h.

◆ readXml()

void QgsRasterResampleFilter::readXml ( const QDomElement & filterElem )

overridevirtual

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

Reimplemented from QgsRasterInterface.

Definition at line 284 of file qgsrasterresamplefilter.cpp.

◆ setInput()

bool QgsRasterResampleFilter::setInput ( QgsRasterInterface * input )

overridevirtual

Set input.

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

Reimplemented from QgsRasterInterface.

Definition at line 74 of file qgsrasterresamplefilter.cpp.

◆ setMaxOversampling()

void QgsRasterResampleFilter::setMaxOversampling ( double os )

inline

Definition at line 55 of file qgsrasterresamplefilter.h.

◆ setZoomedInResampler()

void QgsRasterResampleFilter::setZoomedInResampler ( QgsRasterResampler * r )

Sets resampler for zoomed in scales. Takes ownership of the object.

Definition at line 111 of file qgsrasterresamplefilter.cpp.

◆ setZoomedOutResampler()

void QgsRasterResampleFilter::setZoomedOutResampler ( QgsRasterResampler * r )

Sets resampler for zoomed out scales. Takes ownership of the object.

Definition at line 116 of file qgsrasterresamplefilter.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 263 of file qgsrasterresamplefilter.cpp.

◆ zoomedInResampler()

const QgsRasterResampler* QgsRasterResampleFilter::zoomedInResampler ( ) const

inline

Definition at line 49 of file qgsrasterresamplefilter.h.

◆ zoomedOutResampler()

const QgsRasterResampler* QgsRasterResampleFilter::zoomedOutResampler ( ) const

inline

Definition at line 53 of file qgsrasterresamplefilter.h.

Member Data Documentation

◆ mMaxOversampling

double QgsRasterResampleFilter::mMaxOversampling = 2.0

protected

Maximum boundary for oversampling (to avoid too much data traffic). Default: 2.0.

Definition at line 70 of file qgsrasterresamplefilter.h.

◆ mZoomedInResampler

std::unique_ptr< QgsRasterResampler > QgsRasterResampleFilter::mZoomedInResampler

protected

Resampler used if screen resolution is higher than raster resolution (zoomed in). 0 means no resampling (nearest neighbour)

Definition at line 65 of file qgsrasterresamplefilter.h.

◆ mZoomedOutResampler

std::unique_ptr< QgsRasterResampler > QgsRasterResampleFilter::mZoomedOutResampler

protected

Resampler used if raster resolution is higher than raster resolution (zoomed out). 0 mean no resampling (nearest neighbour)

Definition at line 67 of file qgsrasterresamplefilter.h.

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

/build/qgis-3.16.0+99unstable/src/core/raster/qgsrasterresamplefilter.h
/build/qgis-3.16.0+99unstable/src/core/raster/qgsrasterresamplefilter.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterResampleFilter()

Member Function Documentation

◆ bandCount()

◆ block()

◆ clone()

◆ dataType()

◆ maxOversampling()

◆ readXml()

◆ setInput()

◆ setMaxOversampling()

◆ setZoomedInResampler()

◆ setZoomedOutResampler()

◆ writeXml()

◆ zoomedInResampler()

◆ zoomedOutResampler()

Member Data Documentation

◆ mMaxOversampling

◆ mZoomedInResampler

◆ mZoomedOutResampler