Color and saturation filter pipe for rasters. More...

#include <qgshuesaturationfilter.h>

Inheritance diagram for QgsHueSaturationFilter:

Public Types
enum	GrayscaleMode { GrayscaleOff , GrayscaleLightness , GrayscaleLuminosity , GrayscaleAverage }

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

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

QColor	colorizeColor () const

bool	colorizeOn () const

int	colorizeStrength () const

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

QgsHueSaturationFilter::GrayscaleMode	grayscaleMode () const

bool	invertColors () const
	Returns `true` if the filter inverts colors.

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

int	saturation () const

void	setColorizeColor (const QColor &colorizeColor)

void	setColorizeOn (bool colorizeOn)

void	setColorizeStrength (int colorizeStrength)

void	setGrayscaleMode (QgsHueSaturationFilter::GrayscaleMode grayscaleMode)

bool	setInput (QgsRasterInterface *input) override
	Set input.

void	setInvertColors (bool invertColors)
	Sets whether the filter will invert colors.

void	setSaturation (int saturation)

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

Color and saturation filter pipe for rasters.

Definition at line 31 of file qgshuesaturationfilter.h.

Member Enumeration Documentation

◆ GrayscaleMode

enum QgsHueSaturationFilter::GrayscaleMode

Enumerator
GrayscaleOff
GrayscaleLightness
GrayscaleLuminosity
GrayscaleAverage

Definition at line 36 of file qgshuesaturationfilter.h.

Constructor & Destructor Documentation

◆ QgsHueSaturationFilter()

QgsHueSaturationFilter::QgsHueSaturationFilter ( QgsRasterInterface * input = nullptr )

Definition at line 25 of file qgshuesaturationfilter.cpp.

Member Function Documentation

◆ bandCount()

int QgsHueSaturationFilter::bandCount ( ) const

overridevirtual

Gets number of bands.

Implements QgsRasterInterface.

Definition at line 44 of file qgshuesaturationfilter.cpp.

◆ block()

QgsRasterBlock * QgsHueSaturationFilter::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 111 of file qgshuesaturationfilter.cpp.

◆ clone()

QgsHueSaturationFilter * QgsHueSaturationFilter::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 31 of file qgshuesaturationfilter.cpp.

◆ colorizeColor()

QColor QgsHueSaturationFilter::colorizeColor ( ) const

inline

Definition at line 78 of file qgshuesaturationfilter.h.

◆ colorizeOn()

bool QgsHueSaturationFilter::colorizeOn ( ) const

inline

Definition at line 76 of file qgshuesaturationfilter.h.

◆ colorizeStrength()

int QgsHueSaturationFilter::colorizeStrength ( ) const

inline

Definition at line 80 of file qgshuesaturationfilter.h.

◆ dataType()

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

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 59 of file qgshuesaturationfilter.cpp.

◆ grayscaleMode()

QgsHueSaturationFilter::GrayscaleMode QgsHueSaturationFilter::grayscaleMode ( ) const

inline

Definition at line 73 of file qgshuesaturationfilter.h.

◆ invertColors()

bool QgsHueSaturationFilter::invertColors ( ) const

inline

Returns true if the filter inverts colors.

Since: QGIS 3.22

Definition at line 70 of file qgshuesaturationfilter.h.

◆ readXml()

void QgsHueSaturationFilter::readXml ( const QDomElement & filterElem )

overridevirtual

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

Reimplemented from QgsRasterInterface.

Definition at line 363 of file qgshuesaturationfilter.cpp.

◆ saturation()

int QgsHueSaturationFilter::saturation ( ) const

inline

Definition at line 57 of file qgshuesaturationfilter.h.

◆ setColorizeColor()

void QgsHueSaturationFilter::setColorizeColor ( const QColor & colorizeColor )

Definition at line 333 of file qgshuesaturationfilter.cpp.

◆ setColorizeOn()

void QgsHueSaturationFilter::setColorizeOn ( bool colorizeOn )

inline

Definition at line 75 of file qgshuesaturationfilter.h.

◆ setColorizeStrength()

void QgsHueSaturationFilter::setColorizeStrength ( int colorizeStrength )

inline

Definition at line 79 of file qgshuesaturationfilter.h.

◆ setGrayscaleMode()

void QgsHueSaturationFilter::setGrayscaleMode ( QgsHueSaturationFilter::GrayscaleMode grayscaleMode )

inline

Definition at line 72 of file qgshuesaturationfilter.h.

◆ setInput()

bool QgsHueSaturationFilter::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 qgshuesaturationfilter.cpp.

◆ setInvertColors()

void QgsHueSaturationFilter::setInvertColors ( bool invertColors )

inline

Sets whether the filter will invert colors.

Parameters

invertColors Set to true to invert colors.

Since: QGIS 3.22

Definition at line 64 of file qgshuesaturationfilter.h.

◆ setSaturation()

void QgsHueSaturationFilter::setSaturation ( int saturation )

Definition at line 325 of file qgshuesaturationfilter.cpp.

◆ writeXml()

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 342 of file qgshuesaturationfilter.cpp.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/raster/qgshuesaturationfilter.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/raster/qgshuesaturationfilter.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GrayscaleMode

Constructor & Destructor Documentation

◆ QgsHueSaturationFilter()

Member Function Documentation

◆ bandCount()

◆ block()

◆ clone()

◆ colorizeColor()

◆ colorizeOn()

◆ colorizeStrength()

◆ dataType()

◆ grayscaleMode()

◆ invertColors()

◆ readXml()

◆ saturation()

◆ setColorizeColor()

◆ setColorizeOn()

◆ setColorizeStrength()

◆ setGrayscaleMode()

◆ setInput()

◆ setInvertColors()

◆ setSaturation()

◆ writeXml()