QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | List of all members
QgsBrightnessContrastFilter Class Reference

Brightness/contrast and gamma correction filter pipe for rasters. More...

#include <qgsbrightnesscontrastfilter.h>

Inheritance diagram for QgsBrightnessContrastFilter:
Inheritance graph
[legend]

Public Member Functions

 QgsBrightnessContrastFilter (QgsRasterInterface *input=nullptr)
 
int bandCount () const override
 Gets 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...
 
int brightness () const
 Returns current brightness level. More...
 
QgsBrightnessContrastFilterclone () const override
 Clone itself, create deep copy. More...
 
int contrast () const
 Returns current contrast level. More...
 
Qgis::DataType dataType (int bandNo) const override
 Returns data type for the band specified by number. More...
 
double gamma () const
 Returns current gamma value. More...
 
void readXml (const QDomElement &filterElem) override
 Sets base class members from xml. Usually called from create() methods of subclasses. More...
 
void setBrightness (int brightness)
 Set brightness level. More...
 
void setContrast (int contrast)
 Set contrast level. More...
 
void setGamma (double gamma)
 Set gamma value. More...
 
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 ()=default
 
virtual QgsRasterBandStats bandStatistics (int bandNo, int stats=QgsRasterBandStats::All, const QgsRectangle &extent=QgsRectangle(), int sampleSize=0, QgsRasterBlockFeedback *feedback=nullptr)
 Returns the band statistics. More...
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the raster interface capabilities 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
 Gets 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)
 Returns a band histogram. More...
 
virtual QgsRasterInterfaceinput () const
 Current input. More...
 
virtual bool on () const
 Returns whether the interface is on or off. More...
 
virtual void setOn (bool on)
 Sets whether the interface is on or 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 QgsRasterInterfacesourceInput ()
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual const QgsRasterInterfacesourceInput () const
 Gets source / raw input, the first in pipe, usually provider. More...
 
virtual int xBlockSize () const
 Gets block size. More...
 
virtual int xSize () const
 Gets 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, Prefetch = 1 << 10
}
 If you add to this, please also add to capabilitiesString() More...
 
- 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

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
bandNoband number
extentextent of block
widthpixel width of block
heightpixel height of block
feedbackoptional 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 205 of file qgsbrightnesscontrastfilter.cpp.

◆ setBrightness()

void QgsBrightnessContrastFilter::setBrightness ( int  brightness)
inline

Set brightness level.

Acceptable value range is -255…255

See also
brightness()

Definition at line 67 of file qgsbrightnesscontrastfilter.h.

◆ setContrast()

void QgsBrightnessContrastFilter::setContrast ( int  contrast)
inline

Set contrast level.

Acceptable value range is -100…100

See also
contrast()

Definition at line 79 of file qgsbrightnesscontrastfilter.h.

◆ setGamma()

void QgsBrightnessContrastFilter::setGamma ( double  gamma)
inline

Set gamma value.

Acceptable value range is -0.1…10

See also
gamma()
Since
QGIS 3.16

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


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