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 | Private Attributes | 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]
Collaboration diagram for QgsSingleBandGrayRenderer:
Collaboration 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 ()
 
QgsRasterInterfaceclone () const
 Clone itself, create deep copy. More...
 
QgsRasterBlockblock (int bandNo, QgsRectangle const &extent, int width, int height)
 Read block of data using given extent and size. More...
 
int grayBand () const
 
void setGrayBand (int band)
 
const QgsContrastEnhancementcontrastEnhancement () const
 
void setContrastEnhancement (QgsContrastEnhancement *ce)
 Takes ownership. More...
 
void setGradient (Gradient theGradient)
 
Gradient gradient () const
 
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)
 

Private Attributes

int mGrayBand
 
Gradient mGradient
 
QgsContrastEnhancementmContrastEnhancement
 

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
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 for single band gray.

Definition at line 29 of file qgssinglebandgrayrenderer.h.

Member Enumeration Documentation

Enumerator
BlackToWhite 
WhiteToBlack 

Definition at line 32 of file qgssinglebandgrayrenderer.h.

Constructor & Destructor Documentation

QgsSingleBandGrayRenderer::QgsSingleBandGrayRenderer ( QgsRasterInterface input,
int  grayBand 
)

Definition at line 25 of file qgssinglebandgrayrenderer.cpp.

Referenced by clone(), and create().

QgsSingleBandGrayRenderer::~QgsSingleBandGrayRenderer ( )

Definition at line 30 of file qgssinglebandgrayrenderer.cpp.

References mContrastEnhancement.

Member Function Documentation

QgsRasterBlock * QgsSingleBandGrayRenderer::block ( int  bandNo,
QgsRectangle const &  extent,
int  width,
int  height 
)
virtual
QgsRasterInterface * QgsSingleBandGrayRenderer::clone ( ) const
virtual
const QgsContrastEnhancement* QgsSingleBandGrayRenderer::contrastEnhancement ( ) const
inline
QgsRasterRenderer * QgsSingleBandGrayRenderer::create ( const QDomElement &  elem,
QgsRasterInterface input 
)
static
Gradient QgsSingleBandGrayRenderer::gradient ( ) const
inline
int QgsSingleBandGrayRenderer::grayBand ( ) const
inline
void QgsSingleBandGrayRenderer::legendSymbologyItems ( QList< QPair< QString, QColor > > &  symbolItems) const
virtual
void QgsSingleBandGrayRenderer::setContrastEnhancement ( QgsContrastEnhancement ce)
void QgsSingleBandGrayRenderer::setGradient ( Gradient  theGradient)
inline
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.

References mGrayBand.

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

Member Data Documentation

QgsContrastEnhancement* QgsSingleBandGrayRenderer::mContrastEnhancement
private
Gradient QgsSingleBandGrayRenderer::mGradient
private

Definition at line 63 of file qgssinglebandgrayrenderer.h.

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

int QgsSingleBandGrayRenderer::mGrayBand
private

Definition at line 62 of file qgssinglebandgrayrenderer.h.

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


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