QGIS API Documentation  2.99.0-Master (9fdd060)
Public Types | Public Member Functions | List of all members
QgsHueSaturationFilter Class Reference

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

#include <qgshuesaturationfilter.h>

Inheritance diagram for QgsHueSaturationFilter:
Inheritance graph
[legend]

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=nullptr)
 
int bandCount () const override
 Get number of bands. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback=nullptr) override
 Read block of data using given extent and size. More...
 
QgsHueSaturationFilterclone () const override
 Clone itself, create deep copy. More...
 
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. More...
 
QgsHueSaturationFilter::GrayscaleMode grayscaleMode () const
 
void readXml (const QDomElement &filterElem) override
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
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. More...
 
void setSaturation (int saturation)
 
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)
 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 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
 Get 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)
 Get histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Is on/off. More...
 
virtual void setOn (bool on)
 Set on/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 QgsRasterInterfacesourceInput () const
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesourceInput ()
 Get source / raw input, the first in pipe, usually provider. More...
 
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

- 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< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
QgsRasterInterfacemInput = nullptr
 
bool mOn = true
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Detailed Description

Color and saturation filter pipe for rasters.

Definition at line 31 of file qgshuesaturationfilter.h.

Member Enumeration Documentation

◆ 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

Get number of bands.

Implements QgsRasterInterface.

Definition at line 43 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
bandNoband number
extentextent of block
widthpixel width of block
heightpixel height of block
feedbackoptional raster feedback object for cancelation/preview. Added in QGIS 3.0.

Implements QgsRasterInterface.

Definition at line 110 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 65 of file qgshuesaturationfilter.h.

◆ colorizeOn()

bool QgsHueSaturationFilter::colorizeOn ( ) const
inline

Definition at line 63 of file qgshuesaturationfilter.h.

◆ colorizeStrength()

int QgsHueSaturationFilter::colorizeStrength ( ) const
inline

Definition at line 67 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 58 of file qgshuesaturationfilter.cpp.

◆ grayscaleMode()

QgsHueSaturationFilter::GrayscaleMode QgsHueSaturationFilter::grayscaleMode ( ) const
inline

Definition at line 60 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 351 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 322 of file qgshuesaturationfilter.cpp.

◆ setColorizeOn()

void QgsHueSaturationFilter::setColorizeOn ( bool  colorizeOn)
inline

Definition at line 62 of file qgshuesaturationfilter.h.

◆ setColorizeStrength()

void QgsHueSaturationFilter::setColorizeStrength ( int  colorizeStrength)
inline

Definition at line 66 of file qgshuesaturationfilter.h.

◆ setGrayscaleMode()

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

Definition at line 59 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 73 of file qgshuesaturationfilter.cpp.

◆ setSaturation()

void QgsHueSaturationFilter::setSaturation ( int  saturation)

Definition at line 314 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 331 of file qgshuesaturationfilter.cpp.


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