Brightness/contrast filter pipe for rasters. More...

#include <qgsbrightnesscontrastfilter.h>

Inheritance diagram for QgsBrightnessContrastFilter:

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

int	brightness () const

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

int	contrast () const

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

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

void	setBrightness (int brightness)

void	setContrast (int contrast)

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

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

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 above 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 const QgsRasterInterface *	sourceInput () const
	Gets source / raw input, the first in pipe, usually provider. More...

virtual QgsRasterInterface *	sourceInput ()
	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

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

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

Brightness/contrast filter pipe for rasters.

Definition at line 31 of file qgsbrightnesscontrastfilter.h.

Constructor & Destructor Documentation

◆ QgsBrightnessContrastFilter()

QgsBrightnessContrastFilter::QgsBrightnessContrastFilter ( QgsRasterInterface * input = nullptr )

Definition at line 24 of file qgsbrightnesscontrastfilter.cpp.

Member Function Documentation

◆ bandCount()

int QgsBrightnessContrastFilter::bandCount ( ) const

overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 38 of file qgsbrightnesscontrastfilter.cpp.

◆ block()

QgsRasterBlock * QgsBrightnessContrastFilter::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 cancelation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Definition at line 105 of file qgsbrightnesscontrastfilter.cpp.

◆ brightness()

int QgsBrightnessContrastFilter::brightness ( ) const

inline

Definition at line 47 of file qgsbrightnesscontrastfilter.h.

◆ clone()

QgsBrightnessContrastFilter * QgsBrightnessContrastFilter::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 29 of file qgsbrightnesscontrastfilter.cpp.

◆ contrast()

int QgsBrightnessContrastFilter::contrast ( ) const

inline

Definition at line 50 of file qgsbrightnesscontrastfilter.h.

◆ dataType()

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

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 53 of file qgsbrightnesscontrastfilter.cpp.

◆ readXml()

void QgsBrightnessContrastFilter::readXml ( const QDomElement & filterElem )

overridevirtual

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

Reimplemented from QgsRasterInterface.

Definition at line 202 of file qgsbrightnesscontrastfilter.cpp.

◆ setBrightness()

void QgsBrightnessContrastFilter::setBrightness ( int brightness )

inline

Definition at line 46 of file qgsbrightnesscontrastfilter.h.

◆ setContrast()

void QgsBrightnessContrastFilter::setContrast ( int contrast )

inline

Definition at line 49 of file qgsbrightnesscontrastfilter.h.

◆ setInput()

bool QgsBrightnessContrastFilter::setInput ( QgsRasterInterface * input )

overridevirtual

Set input.

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

Reimplemented from QgsRasterInterface.

Definition at line 68 of file qgsbrightnesscontrastfilter.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 188 of file qgsbrightnesscontrastfilter.cpp.

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

/tmp/buildd/qgis-3.6.0+99unstable/src/core/raster/qgsbrightnesscontrastfilter.h
/tmp/buildd/qgis-3.6.0+99unstable/src/core/raster/qgsbrightnesscontrastfilter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsBrightnessContrastFilter()

Member Function Documentation

◆ bandCount()

◆ block()

◆ brightness()

◆ clone()

◆ contrast()

◆ dataType()

◆ readXml()

◆ setBrightness()

◆ setContrast()

◆ setInput()

◆ writeXml()