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

Resample filter pipe for rasters. More...

#include <qgsrasterresamplefilter.h>

Inheritance diagram for QgsRasterResampleFilter:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterResampleFilter (QgsRasterInterface *input=0)
 
 ~QgsRasterResampleFilter ()
 
QgsRasterInterfaceclone () const
 Clone itself, create deep copy. More...
 
int bandCount () const
 Get number of bands. More...
 
QGis::DataType dataType (int bandNo) const
 Returns data type for the band specified by number. More...
 
bool setInput (QgsRasterInterface *input)
 Set input. More...
 
QgsRasterBlockblock (int bandNo, const QgsRectangle &extent, int width, int height)
 Read block of data using given extent and size. More...
 
void setZoomedInResampler (QgsRasterResampler *r)
 Set resampler for zoomed in scales. More...
 
const QgsRasterResamplerzoomedInResampler () const
 
void setZoomedOutResampler (QgsRasterResampler *r)
 Set resampler for zoomed out scales. More...
 
const QgsRasterResamplerzoomedOutResampler () const
 
void setMaxOversampling (double os)
 
double maxOversampling () const
 
void writeXML (QDomDocument &doc, QDomElement &parentElem) const
 Write base class members to xml. More...
 
void readXML (const QDomElement &filterElem)
 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...
 

Protected Attributes

QgsRasterResamplermZoomedInResampler
 Resampler used if screen resolution is higher than raster resolution (zoomed in). More...
 
QgsRasterResamplermZoomedOutResampler
 Resampler used if raster resolution is higher than raster resolution (zoomed out). More...
 
double mMaxOversampling
 Maximum boundary for oversampling (to avoid too much data traffic). 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
 

Additional Inherited Members

- 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...
 
- 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...
 

Detailed Description

Resample filter pipe for rasters.

Constructor & Destructor Documentation

QgsRasterResampleFilter::QgsRasterResampleFilter ( QgsRasterInterface input = 0)
QgsRasterResampleFilter::~QgsRasterResampleFilter ( )

Member Function Documentation

int QgsRasterResampleFilter::bandCount ( ) const
virtual

Get number of bands.

Implements QgsRasterInterface.

QgsRasterBlock * QgsRasterResampleFilter::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 QgsRasterInterface.

QgsRasterInterface * QgsRasterResampleFilter::clone ( ) const
virtual

Clone itself, create deep copy.

Implements QgsRasterInterface.

QGis::DataType QgsRasterResampleFilter::dataType ( int  bandNo) const
virtual

Returns data type for the band specified by number.

Implements QgsRasterInterface.

double QgsRasterResampleFilter::maxOversampling ( ) const
inline
void QgsRasterResampleFilter::readXML ( const QDomElement &  filterElem)
virtual

Sets base class members from xml.

Usually called from create() methods of subclasses

Reimplemented from QgsRasterInterface.

bool QgsRasterResampleFilter::setInput ( QgsRasterInterface input)
virtual

Set input.

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

Reimplemented from QgsRasterInterface.

void QgsRasterResampleFilter::setMaxOversampling ( double  os)
inline
void QgsRasterResampleFilter::setZoomedInResampler ( QgsRasterResampler r)

Set resampler for zoomed in scales.

Takes ownership of the object

void QgsRasterResampleFilter::setZoomedOutResampler ( QgsRasterResampler r)

Set resampler for zoomed out scales.

Takes ownership of the object

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

Write base class members to xml.

Reimplemented from QgsRasterInterface.

const QgsRasterResampler* QgsRasterResampleFilter::zoomedInResampler ( ) const
inline
const QgsRasterResampler* QgsRasterResampleFilter::zoomedOutResampler ( ) const
inline

Member Data Documentation

double QgsRasterResampleFilter::mMaxOversampling
protected

Maximum boundary for oversampling (to avoid too much data traffic).

Default: 2.0

QgsRasterResampler* QgsRasterResampleFilter::mZoomedInResampler
protected

Resampler used if screen resolution is higher than raster resolution (zoomed in).

0 means no resampling (nearest neighbour)

QgsRasterResampler* QgsRasterResampleFilter::mZoomedOutResampler
protected

Resampler used if raster resolution is higher than raster resolution (zoomed out).

0 mean no resampling (nearest neighbour)


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