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

Base class for processing filters like renderers, reprojector, resampler etc. More...

#include <qgsrasterinterface.h>

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

Public Types

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

 QgsRasterInterface (QgsRasterInterface *input=0)
 
virtual ~QgsRasterInterface ()
 
virtual QgsRasterInterfaceclone () const =0
 Clone itself, create deep copy. More...
 
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 dataType (int bandNo) const =0
 Returns data type for the band specified by number. 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 bandCount () const =0
 Get number of bands. More...
 
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 QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height)=0
 Read block of data using given extent and size. More...
 
virtual bool setInput (QgsRasterInterface *input)
 Set input. 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...
 
virtual void readXML (const QDomElement &filterElem)
 Sets base class members from xml. More...
 

Protected Member Functions

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

QgsRasterInterfacemInput
 
QList< QgsRasterBandStatsmStatistics
 List of cached statistics, all bands mixed. More...
 
QList< QgsRasterHistogrammHistograms
 List of cached histograms, all bands mixed. More...
 
bool mOn
 

Private Member Functions

 Q_DECLARE_TR_FUNCTIONS (QgsRasterInterface)
 

Detailed Description

Base class for processing filters like renderers, reprojector, resampler etc.

Definition at line 35 of file qgsrasterinterface.h.

Member Enumeration Documentation

If you add to this, please also add to capabilitiesString()

Enumerator
NoCapabilities 
Size 
Create 
Remove 
BuildPyramids 
Identify 
IdentifyValue 
IdentifyText 
IdentifyHtml 
IdentifyFeature 

Definition at line 41 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

QgsRasterInterface::QgsRasterInterface ( QgsRasterInterface input = 0)

Definition at line 32 of file qgsrasterinterface.cpp.

QgsRasterInterface::~QgsRasterInterface ( )
virtual

Definition at line 38 of file qgsrasterinterface.cpp.

Member Function Documentation

virtual int QgsRasterInterface::bandCount ( ) const
pure virtual
QgsRasterBandStats QgsRasterInterface::bandStatistics ( int  theBandNo,
int  theStats = QgsRasterBandStats::All,
const QgsRectangle theExtent = QgsRectangle(),
int  theSampleSize = 0 
)
virtual
virtual QgsRasterBlock* QgsRasterInterface::block ( int  bandNo,
const QgsRectangle extent,
int  width,
int  height 
)
pure virtual
virtual int QgsRasterInterface::capabilities ( ) const
inlinevirtual
QString QgsRasterInterface::capabilitiesString ( ) const

Returns the above in friendly format.

Definition at line 569 of file qgsrasterinterface.cpp.

References BuildPyramids, capabilities(), Create, Identify, QgsDebugMsg, Remove, and tr.

virtual QgsRasterInterface* QgsRasterInterface::clone ( ) const
pure virtual
void QgsRasterInterface::cumulativeCut ( int  theBandNo,
double  theLowerCount,
double  theUpperCount,
double &  theLowerValue,
double &  theUpperValue,
const QgsRectangle theExtent = QgsRectangle(),
int  theSampleSize = 0 
)
virtual

Find values for cumulative pixel count cut.

Parameters
theBandNoThe band (number).
theLowerCountThe lower count as fraction of 1, e.g. 0.02 = 2%
theUpperCountThe upper count as fraction of 1, e.g. 0.98 = 98%
theLowerValueLocation into which the lower value will be set.
theUpperValueLocation into which the upper value will be set.
theExtentExtent used to calc histogram, if empty, whole raster extent is used.
theSampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.

Definition at line 510 of file qgsrasterinterface.cpp.

References bandStatistics(), QgsRasterHistogram::binCount, QGis::Byte, histogram(), QgsRasterHistogram::histogramVector, QGis::Int16, QGis::Int32, QgsRasterHistogram::maximum, QgsRasterBandStats::maximumValue, QgsRasterBandStats::Min, QgsRasterHistogram::minimum, QgsRasterBandStats::minimumValue, QgsRasterHistogram::nonNullCount, QgsDebugMsg, srcDataType(), QGis::UInt16, and QGis::UInt32.

Referenced by QgsRasterMinMaxWidget::on_mLoadPushButton_clicked(), and QgsRasterLayer::setContrastEnhancement().

virtual QGis::DataType QgsRasterInterface::dataType ( int  bandNo) const
pure virtual
int QgsRasterInterface::dataTypeSize ( int  bandNo)
inline

Definition at line 86 of file qgsrasterinterface.h.

References QgsRasterBlock::typeSize().

Referenced by QgsRasterDataProvider::block().

virtual QgsRectangle QgsRasterInterface::extent ( )
inlinevirtual

Get the extent of the interface.

Returns
QgsRectangle containing the extent of the layer

Reimplemented in QgsRasterDataProvider.

Definition at line 84 of file qgsrasterinterface.h.

Referenced by QgsRasterProjector::block(), initHistogram(), initStatistics(), and QgsRasterRenderer::minMaxOriginLabel().

virtual QString QgsRasterInterface::generateBandName ( int  theBandNumber) const
inlinevirtual

helper function to create zero padded band names

Definition at line 100 of file qgsrasterinterface.h.

References tr.

Referenced by QgsRasterLayer::bandName(), QgsRasterRendererWidget::displayBandName(), and QgsMapToolIdentify::identifyRasterLayer().

bool QgsRasterInterface::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 
)
virtual

Returns true if histogram is available (cached, already calculated), the parameters are the same as in histogram()

Note
theBinCount, theMinimun and theMaximum not optional in python bindings

Definition at line 369 of file qgsrasterinterface.cpp.

References histogram(), initHistogram(), mHistograms, and QgsDebugMsg.

Referenced by QgsRasterHistogramWidget::computeHistogram().

bool QgsRasterInterface::hasStatistics ( int  theBandNo,
int  theStats = QgsRasterBandStats::All,
const QgsRectangle theExtent = QgsRectangle(),
int  theSampleSize = 0 
)
virtual

Returns true if histogram is available (cached, already calculated).

  • The parameters are the same as in bandStatistics()
    Returns
    true if statistics are available (ready to use)

Definition at line 99 of file qgsrasterinterface.cpp.

References QgsRasterBandStats::contains(), initStatistics(), mStatistics, and QgsDebugMsg.

QgsRasterHistogram QgsRasterInterface::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 
)
virtual

Get histogram.

Histograms are cached in providers.

Parameters
theBandNoThe band (number).
theBinCountNumber of bins (intervals,buckets). If 0, the number of bins is decided automaticaly according to data type, raster size etc.
theMinimumMinimum value, if NaN, raster minimum value will be used.
theMaximumMaximum value, if NaN, raster minimum value will be used.
theExtentExtent used to calc histogram, if empty, whole raster extent is used.
theSampleSizeApproximate number of cells in sample. If 0, all cells (whole raster will be used). If raster does not have exact size (WCS without exact size for example), provider decides size of sample.
theIncludeOutOfRangeinclude out of range values
Returns
Vector of non NULL cell counts for each bin.
Note
theBinCount, theMinimun and theMaximum not optional in python bindings

Definition at line 395 of file qgsrasterinterface.cpp.

References QgsRasterHistogram::binCount, block(), QgsRasterHistogram::extent, QgsRectangle::height(), QgsRasterHistogram::height, QgsRasterHistogram::histogramVector, initHistogram(), QgsRasterBlock::isNoData(), QgsRasterHistogram::maximum, mHistograms, QgsRasterHistogram::minimum, QgsRasterHistogram::nonNullCount, QgsDebugMsg, QgsRasterHistogram::valid, QgsRasterBlock::value(), QgsRectangle::width(), QgsRasterHistogram::width, xBlockSize(), QgsRectangle::xMinimum(), yBlockSize(), and QgsRectangle::yMaximum().

Referenced by QgsRasterHistogramWidget::computeHistogram(), cumulativeCut(), hasHistogram(), and QgsRasterHistogramWidget::refreshHistogram().

void QgsRasterInterface::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 
)
protected
void QgsRasterInterface::initStatistics ( QgsRasterBandStats theStatistics,
int  theBandNo,
int  theStats = QgsRasterBandStats::All,
const QgsRectangle theExtent = QgsRectangle(),
int  theBinCount = 0 
)
protected
virtual QgsRasterInterface* QgsRasterInterface::input ( ) const
inlinevirtual
virtual bool QgsRasterInterface::on ( ) const
inlinevirtual

Is on/off.

Definition at line 123 of file qgsrasterinterface.h.

QgsRasterInterface::Q_DECLARE_TR_FUNCTIONS ( QgsRasterInterface  )
private
virtual void QgsRasterInterface::readXML ( const QDomElement &  filterElem)
inlinevirtual

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented in QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterResampleFilter, and QgsBrightnessContrastFilter.

Definition at line 213 of file qgsrasterinterface.h.

virtual bool QgsRasterInterface::setInput ( QgsRasterInterface input)
inlinevirtual

Set input.

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

Reimplemented in QgsRasterDataProvider, QgsRasterRenderer, QgsHueSaturationFilter, QgsRasterResampleFilter, QgsBrightnessContrastFilter, and QgsSingleBandColorDataRenderer.

Definition at line 117 of file qgsrasterinterface.h.

virtual void QgsRasterInterface::setOn ( bool  on)
inlinevirtual

Set on/off.

Definition at line 126 of file qgsrasterinterface.h.

virtual QGis::DataType QgsRasterInterface::srcDataType ( int  bandNo) const
inlinevirtual

Returns source data type for the band specified by number, source data type may be shorter than dataType.

Reimplemented in QgsRasterDataProvider.

Definition at line 78 of file qgsrasterinterface.h.

References QGis::UnknownDataType.

Referenced by cumulativeCut(), and initHistogram().

virtual const QgsRasterInterface* QgsRasterInterface::srcInput ( ) const
inlinevirtual

Get source / raw input, the first in pipe, usually provider.

It may be used to get info about original data, e.g. resolution to decide resampling etc.

Definition at line 132 of file qgsrasterinterface.h.

References QgsDebugMsg.

Referenced by QgsRasterResampleFilter::block(), QgsRasterProjector::calc(), QgsRasterFileWriter::writeDataRaster(), and QgsRasterFileWriter::writeRaster().

virtual QgsRasterInterface* QgsRasterInterface::srcInput ( )
inlinevirtual

Definition at line 137 of file qgsrasterinterface.h.

References QgsDebugMsg.

virtual void QgsRasterInterface::writeXML ( QDomDocument &  doc,
QDomElement &  parentElem 
) const
inlinevirtual
virtual int QgsRasterInterface::xBlockSize ( ) const
inlinevirtual

Get block size.

Definition at line 92 of file qgsrasterinterface.h.

Referenced by bandStatistics(), and histogram().

virtual int QgsRasterInterface::xSize ( ) const
inlinevirtual
virtual int QgsRasterInterface::yBlockSize ( ) const
inlinevirtual

Definition at line 93 of file qgsrasterinterface.h.

Referenced by bandStatistics(), and histogram().

virtual int QgsRasterInterface::ySize ( ) const
inlinevirtual

Member Data Documentation

QList<QgsRasterHistogram> QgsRasterInterface::mHistograms
protected

List of cached histograms, all bands mixed.

Definition at line 223 of file qgsrasterinterface.h.

Referenced by hasHistogram(), histogram(), and QgsRasterDataProvider::setUserNoDataValue().

QgsRasterInterface* QgsRasterInterface::mInput
protected
bool QgsRasterInterface::mOn
protected
QList<QgsRasterBandStats> QgsRasterInterface::mStatistics
protected

List of cached statistics, all bands mixed.

Definition at line 220 of file qgsrasterinterface.h.

Referenced by bandStatistics(), hasStatistics(), and QgsRasterDataProvider::setUserNoDataValue().


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