Brightness/contrast and gamma correction 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.

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

int	brightness () const
	Returns current brightness level.

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

int	contrast () const
	Returns current contrast level.

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

double	gamma () const
	Returns current gamma value.

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

void	setBrightness (int brightness)
	Set brightness level.

void	setContrast (int contrast)
	Set contrast level.

void	setGamma (double gamma)
	Set gamma value.

bool	setInput (QgsRasterInterface *input) override
	Set input.

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

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

virtual	~QgsRasterInterface ()=default

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

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	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 int	xBlockSize () const
	Gets block size.

virtual int	xSize () const
	Gets raster size.

virtual int	yBlockSize () const

virtual int	ySize () const

Additional Inherited Members
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.

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 inherited from QgsRasterInterface
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

Brightness/contrast and gamma correction 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 39 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 cancellation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Definition at line 106 of file qgsbrightnesscontrastfilter.cpp.

◆ brightness()

int QgsBrightnessContrastFilter::brightness ( ) const

inline

Returns current brightness level.

See also: setBrightness()

Definition at line 73 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

Returns current contrast level.

See also: setContrast()

Definition at line 85 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 54 of file qgsbrightnesscontrastfilter.cpp.

◆ gamma()

double QgsBrightnessContrastFilter::gamma ( ) const

inline

Returns current gamma value.

See also: setGamma()

Since: QGIS 3.16

Definition at line 101 of file qgsbrightnesscontrastfilter.h.

◆ 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 220 of file qgsbrightnesscontrastfilter.cpp.

◆ setBrightness()

void QgsBrightnessContrastFilter::setBrightness ( int brightness )

Set brightness level.

Acceptable value range is -255…255

See also: brightness()

Definition at line 166 of file qgsbrightnesscontrastfilter.cpp.

◆ setContrast()

void QgsBrightnessContrastFilter::setContrast ( int contrast )

Set contrast level.

Acceptable value range is -100…100

See also: contrast()

Definition at line 171 of file qgsbrightnesscontrastfilter.cpp.

◆ setGamma()

void QgsBrightnessContrastFilter::setGamma ( double gamma )

Set gamma value.

Acceptable value range is -0.1…10

See also: gamma()

Since: QGIS 3.16

Definition at line 176 of file qgsbrightnesscontrastfilter.cpp.

◆ 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 69 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 205 of file qgsbrightnesscontrastfilter.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/raster/qgsbrightnesscontrastfilter.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/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()

◆ gamma()

◆ readXml()

◆ setBrightness()

◆ setContrast()

◆ setGamma()

◆ setInput()

◆ writeXml()