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

Raster renderer pipe for single band gray. More...

#include <qgssinglebandgrayrenderer.h>

Inheritance diagram for QgsSingleBandGrayRenderer:
Inheritance graph
[legend]

Public Types

enum  Gradient { BlackToWhite, WhiteToBlack }
 
- 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...
 

Public Member Functions

 QgsSingleBandGrayRenderer (QgsRasterInterface *input, int grayBand)
 
 ~QgsSingleBandGrayRenderer ()
 
QgsRasterBlockblock (int bandNo, QgsRectangle const &extent, int width, int height)
 Read block of data using given extent and size. More...
 
QgsRasterInterfaceclone () const
 Clone itself, create deep copy. More...
 
const QgsContrastEnhancementcontrastEnhancement () const
 
Gradient gradient () const
 
int grayBand () const
 
void legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const
 Get symbology items if provided by renderer. More...
 
void setContrastEnhancement (QgsContrastEnhancement *ce)
 Takes ownership. More...
 
void setGradient (Gradient theGradient)
 
void setGrayBand (int band)
 
QList< int > usesBands () const
 Returns a list of band numbers used by the renderer. More...
 
void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
- Public Member Functions inherited from QgsRasterRenderer
 QgsRasterRenderer (QgsRasterInterface *input=0, const QString &type="")
 
virtual ~QgsRasterRenderer ()
 
int alphaBand () const
 
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...
 
double opacity () const
 
const QgsRasterTransparencyrasterTransparency () const
 
void readXML (const QDomElement &rendererElem)
 Sets base class members from xml. More...
 
void setAlphaBand (int band)
 
virtual bool setInput (QgsRasterInterface *input)
 Set input. More...
 
void setOpacity (double opacity)
 
void setRasterTransparency (QgsRasterTransparency *t)
 
virtual QString type () const
 
bool usesTransparency () const
 
- Public Member Functions inherited from QgsRasterInterface
 QgsRasterInterface (QgsRasterInterface *input=0)
 
virtual ~QgsRasterInterface ()
 
virtual QgsRasterBandStats bandStatistics (int theBandNo, int theStats=QgsRasterBandStats::All, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 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 theBandNo, double theLowerCount, double theUpperCount, double &theLowerValue, double &theUpperValue, const QgsRectangle &theExtent=QgsRectangle(), int theSampleSize=0)
 Find values for cumulative pixel count cut. More...
 
int dataTypeSize (int bandNo)
 
virtual QgsRectangle extent ()
 Get the extent of the interface. More...
 
virtual QString generateBandName (int theBandNumber) const
 helper function to create zero padded band names 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 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 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 srcDataType (int bandNo) const
 Returns source data type for the band specified by number, source data type may be shorter than dataType. More...
 
virtual const QgsRasterInterfacesrcInput () const
 Get source / raw input, the first in pipe, usually provider. More...
 
virtual QgsRasterInterfacesrcInput ()
 
virtual int xBlockSize () const
 Get block size. More...
 
virtual int xSize () const
 Get raster size. More...
 
virtual int yBlockSize () const
 
virtual int ySize () const
 

Static Public Member Functions

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

Additional Inherited Members

- 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
int mAlphaBand
 Read alpha value from band. More...
 
double mOpacity
 Global alpha value (0-1) More...
 
QgsRasterTransparencymRasterTransparency
 Raster transparency per color or value. More...
 
QString mType
 
- Protected Attributes inherited from QgsRasterInterface
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
QgsRasterInterfacemInput
 
bool mOn
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 

Detailed Description

Raster renderer pipe for single band gray.

Definition at line 29 of file qgssinglebandgrayrenderer.h.

Constructor & Destructor Documentation

QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer ( QgsRasterInterface input,
int  grayBand 
)

Definition at line 25 of file qgssinglebandgrayrenderer.cpp.

QgsSingleBandGrayRenderer::~QgsSingleBandGrayRenderer ( )

Definition at line 30 of file qgssinglebandgrayrenderer.cpp.

Member Function Documentation

QgsRasterBlock * QgsSingleBandGrayRenderer::block ( int  bandNo,
QgsRectangle const &  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.

Definition at line 82 of file qgssinglebandgrayrenderer.cpp.

QgsRasterInterface * QgsSingleBandGrayRenderer::clone ( ) const
virtual

Clone itself, create deep copy.

Implements QgsRasterRenderer.

Definition at line 35 of file qgssinglebandgrayrenderer.cpp.

const QgsContrastEnhancement* QgsSingleBandGrayRenderer::contrastEnhancement ( ) const
inline

Definition at line 48 of file qgssinglebandgrayrenderer.h.

QgsRasterRenderer * QgsSingleBandGrayRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static

Definition at line 49 of file qgssinglebandgrayrenderer.cpp.

Gradient QgsSingleBandGrayRenderer::gradient ( ) const
inline

Definition at line 53 of file qgssinglebandgrayrenderer.h.

int QgsSingleBandGrayRenderer::grayBand ( ) const
inline

Definition at line 46 of file qgssinglebandgrayrenderer.h.

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

Get symbology items if provided by renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 212 of file qgssinglebandgrayrenderer.cpp.

void QgsSingleBandGrayRenderer::setContrastEnhancement ( QgsContrastEnhancement ce)

Takes ownership.

Definition at line 76 of file qgssinglebandgrayrenderer.cpp.

void QgsSingleBandGrayRenderer::setGradient ( Gradient  theGradient)
inline

Definition at line 52 of file qgssinglebandgrayrenderer.h.

void QgsSingleBandGrayRenderer::setGrayBand ( int  band)
inline

Definition at line 47 of file qgssinglebandgrayrenderer.h.

QList< int > QgsSingleBandGrayRenderer::usesBands ( ) const
virtual

Returns a list of band numbers used by the renderer.

Reimplemented from QgsRasterRenderer.

Definition at line 221 of file qgssinglebandgrayrenderer.cpp.

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

Definition at line 180 of file qgssinglebandgrayrenderer.cpp.


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