Raster pipe that deals with null values. More...

#include <qgsrasternuller.h>

Inheritance diagram for QgsRasterNuller:

Classes
struct	NoData

Public Member Functions
	QgsRasterNuller (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...

QgsRasterNuller *	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...

QgsRasterRangeList	noData (int bandNo) const

void	setNoData (int bandNo, const QgsRasterRangeList &noData)

void	setOutputNoDataValue (int bandNo, double noData)
	Sets the output no data value. More...

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

virtual	~QgsRasterInterface ()=default

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

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 QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr)=0
	Read block of data using given extent and size. 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 QgsRasterInterface *	clone () const =0
	Clone itself, create deep copy. More...

virtual QString	colorInterpretationName (int bandNumber) const
	Returns the name of the color interpretation for the specified bandNumber. 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...

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

int	dataTypeSize (int bandNo) const
	Returns the size (in bytes) for the data type for the specified band. More...

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

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	readXml (const QDomElement &filterElem)
	Sets base class members from xml. Usually called from create() methods of subclasses. More...

virtual bool	setInput (QgsRasterInterface *input)
	Set input. 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 void	writeXml (QDomDocument &doc, QDomElement &parentElem) const
	Write base class members to xml. 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

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) const
	Fill in statistics defaults if not specified. 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...

Detailed Description

Raster pipe that deals with null values.

Definition at line 32 of file qgsrasternuller.h.

Constructor & Destructor Documentation

◆ QgsRasterNuller()

QgsRasterNuller::QgsRasterNuller ( QgsRasterInterface * input = nullptr )

Definition at line 21 of file qgsrasternuller.cpp.

Member Function Documentation

◆ bandCount()

int QgsRasterNuller::bandCount ( ) const

overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 56 of file qgsrasternuller.cpp.

◆ block()

QgsRasterBlock * QgsRasterNuller::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 68 of file qgsrasternuller.cpp.

◆ clone()

QgsRasterNuller * QgsRasterNuller::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 26 of file qgsrasternuller.cpp.

◆ dataType()

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

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 62 of file qgsrasternuller.cpp.

◆ noData()

QgsRasterRangeList QgsRasterNuller::noData ( int bandNo ) const

inline

Definition at line 53 of file qgsrasternuller.h.

◆ setNoData()

void QgsRasterNuller::setNoData	(	int	bandNo,
		const QgsRasterRangeList &	noData
	)

Definition at line 47 of file qgsrasternuller.cpp.

◆ setOutputNoDataValue()

void QgsRasterNuller::setOutputNoDataValue	(	int	bandNo,
		double	noData
	)

Sets the output no data value.

Definition at line 36 of file qgsrasternuller.cpp.

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

/build/qgis-3.28.0+99sid/src/core/raster/qgsrasternuller.h
/build/qgis-3.28.0+99sid/src/core/raster/qgsrasternuller.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterNuller()

Member Function Documentation

◆ bandCount()

◆ block()

◆ clone()

◆ dataType()

◆ noData()

◆ setNoData()

◆ setOutputNoDataValue()