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

#include <qgsbrightnesscontrastfilter.h>

Inheritance diagram for QgsBrightnessContrastFilter:

Public Member Functions
	QgsBrightnessContrastFilter (QgsRasterInterface *input=nullptr)

	~QgsBrightnessContrastFilter ()

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

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

QgsRasterBlock *	block2 (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. 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 ()

virtual QgsRasterBandStats	bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Get 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 theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Find values for cumulative pixel count cut. More...

int	dataTypeSize (int bandNo)

virtual QgsRectangle	extent ()
	Get the extent of the interface. More...

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

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

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

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

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

virtual bool	on () const
	Is on/off. More...

virtual void	setOn (bool on)
	Set on/off. More...

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

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

virtual QgsRasterInterface *	srcInput ()

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

virtual int	xSize () const
	Get 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 &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. More...

void	initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=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

bool	mOn

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

Detailed Description

Brightness/contrast filter pipe for rasters.

Definition at line 29 of file qgsbrightnesscontrastfilter.h.

Constructor & Destructor Documentation

◆ QgsBrightnessContrastFilter()

QgsBrightnessContrastFilter::QgsBrightnessContrastFilter ( QgsRasterInterface * input = nullptr )

Definition at line 25 of file qgsbrightnesscontrastfilter.cpp.

◆ ~QgsBrightnessContrastFilter()

QgsBrightnessContrastFilter::~QgsBrightnessContrastFilter ( )

Definition at line 32 of file qgsbrightnesscontrastfilter.cpp.

Member Function Documentation

◆ bandCount()

int QgsBrightnessContrastFilter::bandCount ( ) const

overridevirtual

Get number of bands.

Implements QgsRasterInterface.

Definition at line 45 of file qgsbrightnesscontrastfilter.cpp.

◆ block()

QgsRasterBlock * QgsBrightnessContrastFilter::block	(	int	bandNo,
		const QgsRectangle &	extent,
		int	width,
		int	height
	)

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

Implements QgsRasterInterface.

Definition at line 112 of file qgsbrightnesscontrastfilter.cpp.

◆ block2()

QgsRasterBlock * QgsBrightnessContrastFilter::block2	(	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

Note: This is extended version of block() method. Default implementation falls back to calling block().; Added in QGIS 2.18

Reimplemented from QgsRasterInterface.

Definition at line 117 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 36 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 60 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 218 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 75 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 204 of file qgsbrightnesscontrastfilter.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsBrightnessContrastFilter()

◆ ~QgsBrightnessContrastFilter()

Member Function Documentation

◆ bandCount()

◆ block()

◆ block2()

◆ brightness()

◆ clone()

◆ contrast()

◆ dataType()

◆ readXML()

◆ setBrightness()

◆ setContrast()

◆ setInput()

◆ writeXML()