QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
QgsBrightnessContrastFilter Class Reference

Brightness/contrast filter pipe for rasters. More...

#include <qgsbrightnesscontrastfilter.h>

Inheritance diagram for QgsBrightnessContrastFilter:
Inheritance graph
[legend]
Collaboration diagram for QgsBrightnessContrastFilter:
Collaboration graph
[legend]

Public Member Functions

 QgsBrightnessContrastFilter (QgsRasterInterface *input=0)
 
 ~QgsBrightnessContrastFilter ()
 
QgsRasterInterfaceclone () const
 Clone itself, create deep copy. More...
 
int bandCount () const
 Get number of bands. More...
 
QGis::DataType dataType (int bandNo) const
 Returns data type for the band specified by number. More...
 
bool setInput (QgsRasterInterface *input)
 Set input. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height)
 Read block of data using given extent and size. More...
 
void setBrightness (int brightness)
 
int brightness () const
 
void setContrast (int contrast)
 
int contrast () const
 
void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
void readXML (const QDomElement &filterElem)
 Sets base class members from xml. More...
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=0)
 
virtual ~QgsRasterInterface ()
 
virtual int capabilities () const
 Returns a bitmask containing the supported capabilities. More...
 
QString capabilitiesString () const
 Returns the above in friendly format. More...
 
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. More...
 
virtual QgsRectangle extent ()
 Get the extent of the interface. More...
 
int dataTypeSize (int bandNo)
 
virtual int xBlockSize () const
 Get block size. More...
 
virtual int yBlockSize () const
 
virtual int xSize () const
 Get raster size. More...
 
virtual int ySize () const
 
virtual QString generateBandName (int theBandNumber) const
 helper function to create zero padded band names 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 const QgsRasterInterfacesrcInput () const
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesrcInput ()
 
virtual QgsRasterBandStats bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Get band statistics. More...
 
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). More...
 
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. More...
 
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() More...
 
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. More...
 

Private Member Functions

int adjustColorComponent (int colorComponent, int alpha, int brightness, double contrastFactor) const
 Adjusts a color component by the specified brightness and contrast factor. More...
 

Private Attributes

int mBrightness
 Current brightness coefficient value. More...
 
double mContrast
 Current contrast coefficient value. More...
 

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
}
 If you add to this, please also add to capabilitiesString() More...
 
- 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. More...
 
void initStatistics (QgsRasterBandStats &theStatistics, int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theBinCount=0)
 Fill in statistics defaults if not specified. More...
 
- Protected Attributes inherited from QgsRasterInterface
QgsRasterInterfacemInput
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
bool mOn
 

Detailed Description

Brightness/contrast filter pipe for rasters.

Definition at line 29 of file qgsbrightnesscontrastfilter.h.

Constructor & Destructor Documentation

QgsBrightnessContrastFilter::QgsBrightnessContrastFilter ( QgsRasterInterface input = 0)

Definition at line 25 of file qgsbrightnesscontrastfilter.cpp.

Referenced by clone().

QgsBrightnessContrastFilter::~QgsBrightnessContrastFilter ( )

Definition at line 32 of file qgsbrightnesscontrastfilter.cpp.

Member Function Documentation

int QgsBrightnessContrastFilter::adjustColorComponent ( int  colorComponent,
int  alpha,
int  brightness,
double  contrastFactor 
) const
private

Adjusts a color component by the specified brightness and contrast factor.

Definition at line 175 of file qgsbrightnesscontrastfilter.cpp.

Referenced by block().

int QgsBrightnessContrastFilter::bandCount ( ) const
virtual
QgsRasterBlock * QgsBrightnessContrastFilter::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height 
)
virtual

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

Implements QgsRasterInterface.

Definition at line 112 of file qgsbrightnesscontrastfilter.cpp.

References adjustColorComponent(), QGis::ARGB32_Premultiplied, QgsRasterInterface::block(), QgsRasterBlock::color(), QgsRasterBlock::isEmpty(), mBrightness, mContrast, QgsRasterInterface::mInput, QgsDebugMsg, QgsRasterBlock::reset(), QgsRasterBlock::setColor(), and QgsRectangle::toString().

int QgsBrightnessContrastFilter::brightness ( ) const
inline

Definition at line 46 of file qgsbrightnesscontrastfilter.h.

QgsRasterInterface * QgsBrightnessContrastFilter::clone ( ) const
virtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

Definition at line 36 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, mContrast, QgsBrightnessContrastFilter(), QgsDebugMsg, setBrightness(), and setContrast().

int QgsBrightnessContrastFilter::contrast ( ) const
inline

Definition at line 49 of file qgsbrightnesscontrastfilter.h.

QGis::DataType QgsBrightnessContrastFilter::dataType ( int  bandNo) const
virtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 60 of file qgsbrightnesscontrastfilter.cpp.

References QGis::ARGB32_Premultiplied, QgsRasterInterface::dataType(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, and QGis::UnknownDataType.

void QgsBrightnessContrastFilter::readXML ( const QDomElement &  filterElem)
virtual

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented from QgsRasterInterface.

Definition at line 213 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, and mContrast.

Referenced by QgsRasterLayer::readSymbology().

void QgsBrightnessContrastFilter::setBrightness ( int  brightness)
inline

Definition at line 45 of file qgsbrightnesscontrastfilter.h.

Referenced by clone().

void QgsBrightnessContrastFilter::setContrast ( int  contrast)
inline

Definition at line 48 of file qgsbrightnesscontrastfilter.h.

Referenced by clone().

bool QgsBrightnessContrastFilter::setInput ( QgsRasterInterface input)
virtual
void QgsBrightnessContrastFilter::writeXML ( QDomDocument &  doc,
QDomElement &  parentElem 
) const
virtual

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 199 of file qgsbrightnesscontrastfilter.cpp.

References mBrightness, and mContrast.

Member Data Documentation

int QgsBrightnessContrastFilter::mBrightness
private

Current brightness coefficient value.

Default: 0. Range: -255...255

Definition at line 61 of file qgsbrightnesscontrastfilter.h.

Referenced by block(), clone(), readXML(), and writeXML().

double QgsBrightnessContrastFilter::mContrast
private

Current contrast coefficient value.

Default: 0. Range: -100...100

Definition at line 64 of file qgsbrightnesscontrastfilter.h.

Referenced by block(), clone(), readXML(), and writeXML().


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