QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
QgsRasterRenderer Class Referenceabstract

Raster renderer pipe that applies colors to a raster. More...

#include <qgsrasterrenderer.h>

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

Public Types

enum  MinMaxOrigin {
  MinMaxUnknown = 0, MinMaxUser = 1, MinMaxMinMax = 1 << 1, MinMaxCumulativeCut = 1 << 2,
  MinMaxStdDev = 1 << 3, MinMaxFullExtent = 1 << 4, MinMaxSubExtent = 1 << 5, MinMaxEstimated = 1 << 6,
  MinMaxExact = 1 << 7
}
 
- 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

 QgsRasterRenderer (QgsRasterInterface *input=0, const QString &type="")
 
virtual ~QgsRasterRenderer ()
 
QgsRasterInterfaceclone () const =0
 Clone itself, create deep copy. More...
 
virtual int bandCount () const
 Get number of bands. More...
 
virtual QGis::DataType dataType (int bandNo) const
 Returns data type for the band specified by number. More...
 
virtual QString type () const
 
virtual bool setInput (QgsRasterInterface *input)
 Set input. More...
 
virtual QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height)=0
 Read block of data using given extent and size. More...
 
bool usesTransparency () const
 
void setOpacity (double opacity)
 
double opacity () const
 
void setRasterTransparency (QgsRasterTransparency *t)
 
const QgsRasterTransparencyrasterTransparency () const
 
void setAlphaBand (int band)
 
int alphaBand () const
 
virtual void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 Get symbology items if provided by renderer. More...
 
void readXML (const QDomElement &rendererElem)
 Sets base class members from xml. More...
 
virtual QList< int > usesBands () const
 Returns a list of band numbers used by the renderer. 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...
 
virtual void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 

Static Public Member Functions

static QString minMaxOriginName (int theOrigin)
 
static QString minMaxOriginLabel (int theOrigin)
 
static int minMaxOriginFromName (QString theName)
 

Static Public Attributes

static const QRgb NODATA_COLOR = qRgba( 0, 0, 0, 0 )
 

Protected Member Functions

void _writeXML (QDomDocument &doc, QDomElement &rasterRendererElem) const
 Write upper class info into rasterrenderer element (called by writeXML method of subclasses) 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

QString mType
 
double mOpacity
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency
 Raster transparency per color or value. More...
 
int mAlphaBand
 Read alpha value from band. 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

Raster renderer pipe that applies colors to a raster.

Definition at line 34 of file qgsrasterrenderer.h.

Member Enumeration Documentation

Enumerator
MinMaxUnknown 
MinMaxUser 
MinMaxMinMax 
MinMaxCumulativeCut 
MinMaxStdDev 
MinMaxFullExtent 
MinMaxSubExtent 
MinMaxEstimated 
MinMaxExact 

Definition at line 38 of file qgsrasterrenderer.h.

Constructor & Destructor Documentation

QgsRasterRenderer::QgsRasterRenderer ( QgsRasterInterface input = 0,
const QString &  type = "" 
)

Definition at line 32 of file qgsrasterrenderer.cpp.

QgsRasterRenderer::~QgsRasterRenderer ( )
virtual

Definition at line 39 of file qgsrasterrenderer.cpp.

Member Function Documentation

void QgsRasterRenderer::_writeXML ( QDomDocument &  doc,
QDomElement &  rasterRendererElem 
) const
protected
int QgsRasterRenderer::alphaBand ( ) const
inline

Definition at line 80 of file qgsrasterrenderer.h.

int QgsRasterRenderer::bandCount ( ) const
virtual

Get number of bands.

Implements QgsRasterInterface.

Definition at line 43 of file qgsrasterrenderer.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::mInput, and QgsRasterInterface::mOn.

virtual QgsRasterBlock* QgsRasterRenderer::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height 
)
pure 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.

Implemented in QgsSingleBandGrayRenderer, QgsPalettedRasterRenderer, QgsMultiBandColorRenderer, QgsSingleBandColorDataRenderer, and QgsSingleBandPseudoColorRenderer.

QgsRasterInterface* QgsRasterRenderer::clone ( ) const
pure virtual
QGis::DataType QgsRasterRenderer::dataType ( int  bandNo) const
virtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

Definition at line 52 of file qgsrasterrenderer.cpp.

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

virtual void QgsRasterRenderer::legendSymbologyItems ( QList< QPair< QString, QColor > > &  symbolItems) const
inlinevirtual

Get symbology items if provided by renderer.

Reimplemented in QgsPalettedRasterRenderer, QgsSingleBandGrayRenderer, and QgsSingleBandPseudoColorRenderer.

Definition at line 83 of file qgsrasterrenderer.h.

Referenced by QgsRasterLayer::legendSymbologyItems().

int QgsRasterRenderer::minMaxOriginFromName ( QString  theName)
static
QString QgsRasterRenderer::minMaxOriginLabel ( int  theOrigin)
static
QString QgsRasterRenderer::minMaxOriginName ( int  theOrigin)
static
double QgsRasterRenderer::opacity ( ) const
inline

Definition at line 74 of file qgsrasterrenderer.h.

const QgsRasterTransparency* QgsRasterRenderer::rasterTransparency ( ) const
inline
void QgsRasterRenderer::readXML ( const QDomElement &  rendererElem)
virtual
void QgsRasterRenderer::setAlphaBand ( int  band)
inline
bool QgsRasterRenderer::setInput ( QgsRasterInterface input)
virtual

Set input.

Returns true if set correctly, false if cannot use that input

Reimplemented from QgsRasterInterface.

Reimplemented in QgsSingleBandColorDataRenderer.

Definition at line 63 of file qgsrasterrenderer.cpp.

References QgsRasterInterface::bandCount(), QgsRasterInterface::dataType(), QgsRasterInterface::input(), QgsRasterInterface::mInput, QgsRasterInterface::mOn, and QgsRasterBlock::typeIsNumeric().

void QgsRasterRenderer::setOpacity ( double  opacity)
inline
void QgsRasterRenderer::setRasterTransparency ( QgsRasterTransparency t)
virtual QString QgsRasterRenderer::type ( ) const
inlinevirtual

Definition at line 65 of file qgsrasterrenderer.h.

Referenced by QgsRasterLayer::setContrastEnhancement().

virtual QList<int> QgsRasterRenderer::usesBands ( ) const
inlinevirtual
bool QgsRasterRenderer::usesTransparency ( ) const

Member Data Documentation

int QgsRasterRenderer::mAlphaBand
protected
double QgsRasterRenderer::mOpacity
protected
QgsRasterTransparency* QgsRasterRenderer::mRasterTransparency
protected
QString QgsRasterRenderer::mType
protected

Definition at line 100 of file qgsrasterrenderer.h.

Referenced by _writeXML(), and readXML().

const QRgb QgsRasterRenderer::NODATA_COLOR = qRgba( 0, 0, 0, 0 )
static

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