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

#include <qgshuesaturationfilter.h>

Inheritance diagram for QgsHueSaturationFilter:

Public Types
enum	GrayscaleMode { GrayscaleOff, GrayscaleLightness, GrayscaleLuminosity, GrayscaleAverage }
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...

Public Member Functions
	QgsHueSaturationFilter (QgsRasterInterface *input=0)
	~QgsHueSaturationFilter ()
int	bandCount () const override
	Get number of bands.
QgsRasterBlock *	block (int bandNo, const QgsRectangle &extent, int width, int height) override
	Read block of data using given extent and size.
QgsRasterInterface *	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
void	readXML (const QDomElement &filterElem) override
	Sets base class members from xml.
int	saturation () const
void	setColorizeColor (QColor colorizeColor)
void	setColorizeOn (bool colorizeOn)
void	setColorizeStrength (int colorizeStrength)
void	setGrayscaleMode (QgsHueSaturationFilter::GrayscaleMode grayscaleMode)
bool	setInput (QgsRasterInterface *input) override
	Set input.
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=0)
virtual	~QgsRasterInterface ()
virtual QgsRasterBandStats	bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
	Get band statistics.
virtual int	capabilities () const
	Returns a bitmask containing the supported capabilities.
QString	capabilitiesString () const
	Returns the above in friendly format.
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.
int	dataTypeSize (int bandNo)
virtual QgsRectangle	extent ()
	Get the extent of the interface.
virtual QString	generateBandName (int theBandNumber) const
	helper function to create zero padded band names
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()
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).
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.
virtual QgsRasterInterface *	input () const
	Current input.
virtual bool	on () const
	Is on/off.
virtual void	setOn (bool on)
	Set on/off.
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.
virtual const QgsRasterInterface *	srcInput () const
	Get source / raw input, the first in pipe, usually provider.
virtual QgsRasterInterface *	srcInput ()
virtual int	xBlockSize () const
	Get block size.
virtual int	xSize () const
	Get raster size.
virtual int	yBlockSize () const
virtual int	ySize () const

Additional Inherited Members
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.
void	initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0)
	Fill in statistics defaults if not specified.
Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogram >	mHistograms
	List of cached histograms, all bands mixed.
QgsRasterInterface *	mInput
bool	mOn
QList< QgsRasterBandStats >	mStatistics
	List of cached statistics, all bands mixed.

Detailed Description

Color and saturation filter pipe for rasters.

Definition at line 29 of file qgshuesaturationfilter.h.

Member Enumeration Documentation

enum QgsHueSaturationFilter::GrayscaleMode

Enumerator:

GrayscaleOff
GrayscaleLightness
GrayscaleLuminosity
GrayscaleAverage

Definition at line 34 of file qgshuesaturationfilter.h.

Constructor & Destructor Documentation

QgsHueSaturationFilter::QgsHueSaturationFilter ( QgsRasterInterface * input = 0 )

Definition at line 25 of file qgshuesaturationfilter.cpp.

QgsHueSaturationFilter::~QgsHueSaturationFilter ( )

Definition at line 38 of file qgshuesaturationfilter.cpp.

Member Function Documentation

int QgsHueSaturationFilter::bandCount ( ) const

overridevirtual

Get number of bands.

Implements QgsRasterInterface.

Definition at line 54 of file qgshuesaturationfilter.cpp.

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

QgsRasterInterface * QgsHueSaturationFilter::clone ( ) const

overridevirtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 42 of file qgshuesaturationfilter.cpp.

QColor QgsHueSaturationFilter::colorizeColor ( ) const

inline

Definition at line 64 of file qgshuesaturationfilter.h.

bool QgsHueSaturationFilter::colorizeOn ( ) const

inline

Definition at line 62 of file qgshuesaturationfilter.h.

int QgsHueSaturationFilter::colorizeStrength ( ) const

inline

Definition at line 66 of file qgshuesaturationfilter.h.

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

overridevirtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 69 of file qgshuesaturationfilter.cpp.

QgsHueSaturationFilter::GrayscaleMode QgsHueSaturationFilter::grayscaleMode ( ) const

inline

Definition at line 59 of file qgshuesaturationfilter.h.

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 366 of file qgshuesaturationfilter.cpp.

int QgsHueSaturationFilter::saturation ( ) const

inline

Definition at line 56 of file qgshuesaturationfilter.h.

void QgsHueSaturationFilter::setColorizeColor ( QColor colorizeColor )

Definition at line 337 of file qgshuesaturationfilter.cpp.

void QgsHueSaturationFilter::setColorizeOn ( bool colorizeOn )

inline

Definition at line 61 of file qgshuesaturationfilter.h.

void QgsHueSaturationFilter::setColorizeStrength ( int colorizeStrength )

inline

Definition at line 65 of file qgshuesaturationfilter.h.

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

inline

Definition at line 58 of file qgshuesaturationfilter.h.

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 84 of file qgshuesaturationfilter.cpp.

void QgsHueSaturationFilter::setSaturation ( int saturation )

Definition at line 329 of file qgshuesaturationfilter.cpp.

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

overridevirtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 346 of file qgshuesaturationfilter.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/raster/qgshuesaturationfilter.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/raster/qgshuesaturationfilter.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation