QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | List of all members
QgsPalettedRasterRenderer Class Reference

Renderer for paletted raster images. More...

#include <qgspalettedrasterrenderer.h>

Inheritance diagram for QgsPalettedRasterRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, QColor *colorArray, int nColors, const QVector< QString > labels=QVector< QString >())
 Renderer owns color array. More...
 
 QgsPalettedRasterRenderer (QgsRasterInterface *input, int bandNumber, QRgb *colorArray, int nColors, const QVector< QString > labels=QVector< QString >())
 
 ~QgsPalettedRasterRenderer ()
 
QgsRasterInterfaceclone () const
 Clone itself, create deep copy. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height)
 Read block of data using given extent and size. More...
 
int nColors () const
 Returns number of colors. More...
 
QColor * colors () const
 Returns copy of color array (caller takes ownership) More...
 
QRgb * rgbArray () const
 Returns copy of rgb array (caller takes ownership) More...
 
QString label (int idx) const
 Return optional category label. More...
 
void setLabel (int idx, QString label)
 Set category label. More...
 
void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 Get symbology items if provided by renderer. More...
 
QList< int > usesBands () const
 Returns a list of band numbers used by the renderer. More...
 
- Public Member Functions inherited from QgsRasterRenderer
 QgsRasterRenderer (QgsRasterInterface *input=0, const QString &type="")
 
virtual ~QgsRasterRenderer ()
 
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...
 
bool usesTransparency () const
 
void setOpacity (double opacity)
 
double opacity () const
 
void setRasterTransparency (QgsRasterTransparency *t)
 
const QgsRasterTransparencyrasterTransparency () const
 
void setAlphaBand (int band)
 
int alphaBand () const
 
void readXML (const QDomElement &rendererElem)
 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...
 

Static Public Member Functions

static QgsRasterRenderercreate (const QDomElement &elem, QgsRasterInterface *input)
 
- Static Public Member Functions inherited from QgsRasterRenderer
static QString minMaxOriginName (int theOrigin)
 
static QString minMaxOriginLabel (int theOrigin)
 
static int minMaxOriginFromName (QString theName)
 

Additional Inherited Members

- Public Types inherited from QgsRasterRenderer
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...
 
- Static Public Attributes inherited from QgsRasterRenderer
static const QRgb NODATA_COLOR = qRgba( 0, 0, 0, 0 )
 
- Protected Member Functions inherited from QgsRasterRenderer
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 inherited from QgsRasterRenderer
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

Renderer for paletted raster images.

Constructor & Destructor Documentation

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer ( QgsRasterInterface input,
int  bandNumber,
QColor *  colorArray,
int  nColors,
const QVector< QString >  labels = QVector<QString>() 
)

Renderer owns color array.

QgsPalettedRasterRenderer::QgsPalettedRasterRenderer ( QgsRasterInterface input,
int  bandNumber,
QRgb *  colorArray,
int  nColors,
const QVector< QString >  labels = QVector<QString>() 
)
QgsPalettedRasterRenderer::~QgsPalettedRasterRenderer ( )

Member Function Documentation

QgsRasterBlock * QgsPalettedRasterRenderer::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 QgsRasterRenderer.

QgsRasterInterface * QgsPalettedRasterRenderer::clone ( ) const
virtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

QColor * QgsPalettedRasterRenderer::colors ( ) const

Returns copy of color array (caller takes ownership)

QgsRasterRenderer * QgsPalettedRasterRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static
QString QgsPalettedRasterRenderer::label ( int  idx) const
inline

Return optional category label.

Note
added in 2.1
void QgsPalettedRasterRenderer::legendSymbologyItems ( QList< QPair< QString, QColor > > &  symbolItems) const
virtual

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

int QgsPalettedRasterRenderer::nColors ( ) const
inline

Returns number of colors.

QRgb * QgsPalettedRasterRenderer::rgbArray ( ) const

Returns copy of rgb array (caller takes ownership)

Note
not available in python bindings
void QgsPalettedRasterRenderer::setLabel ( int  idx,
QString  label 
)

Set category label.

Note
added in 2.1
QList< int > QgsPalettedRasterRenderer::usesBands ( ) const
virtual

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.


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