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

Raster namespace. More...

#include <qgsraster.h>

Public Types

enum  ColorInterpretation {
  UndefinedColorInterpretation = 0, GrayIndex = 1, PaletteIndex = 2, RedBand = 3,
  GreenBand = 4, BlueBand = 5, AlphaBand = 6, HueBand = 7,
  SaturationBand = 8, LightnessBand = 9, CyanBand = 10, MagentaBand = 11,
  YellowBand = 12, BlackBand = 13, YCbCr_YBand = 14, YCbCr_CbBand = 15,
  YCbCr_CrBand = 16, ContinuousPalette = 17
}
enum  IdentifyFormat {
  IdentifyFormatUndefined = 0, IdentifyFormatValue = 1, IdentifyFormatText = 1 << 1, IdentifyFormatHtml = 1 << 2,
  IdentifyFormatFeature = 1 << 3
}
enum  RasterProgressType { ProgressHistogram = 0, ProgressPyramids = 1, ProgressStatistics = 2 }
enum  RasterBuildPyramids { PyramidsFlagNo = 0, PyramidsFlagYes = 1, PyramidsCopyExisting = 2 }
enum  RasterPyramidsFormat { PyramidsGTiff = 0, PyramidsInternal = 1, PyramidsErdas = 2 }
enum  ContrastEnhancementLimits { ContrastEnhancementNone, ContrastEnhancementMinMax, ContrastEnhancementStdDev, ContrastEnhancementCumulativeCut }
 Contrast enhancement limits. More...
enum  DrawingStyle {
  UndefinedDrawingStyle, SingleBandGray, SingleBandPseudoColor, PalettedColor,
  PalettedSingleBandGray, PalettedSingleBandPseudoColor, PalettedMultiBandColor, MultiBandSingleBandGray,
  MultiBandSingleBandPseudoColor, MultiBandColor, SingleBandColorDataStyle
}
 This enumerator describes the different kinds of drawing we can do. More...

Static Public Member Functions

static QString contrastEnhancementLimitsAsString (QgsRaster::ContrastEnhancementLimits theLimits)
static ContrastEnhancementLimits contrastEnhancementLimitsFromString (QString theLimits)
static double representableValue (double value, QGis::DataType dataType)
 Get value representable by given data type.

Detailed Description

Raster namespace.

Definition at line 28 of file qgsraster.h.

Member Enumeration Documentation

Enumerator:
UndefinedColorInterpretation 
GrayIndex 

Greyscale

PaletteIndex 

Paletted (see associated color table)

RedBand 

Red band of RGBA image

GreenBand 

Green band of RGBA image

BlueBand 

Blue band of RGBA image

AlphaBand 

Alpha (0=transparent, 255=opaque)

HueBand 

Hue band of HLS image

SaturationBand 

Saturation band of HLS image

LightnessBand 

Lightness band of HLS image

CyanBand 

Cyan band of CMYK image

MagentaBand 

Magenta band of CMYK image

YellowBand 

Yellow band of CMYK image

BlackBand 

Black band of CMLY image

YCbCr_YBand 

Y Luminance

YCbCr_CbBand 

Cb Chroma

YCbCr_CrBand 

Cr Chroma

ContinuousPalette 

Continuous palette, QGIS addition, GRASS

Definition at line 32 of file qgsraster.h.

Contrast enhancement limits.

Enumerator:
ContrastEnhancementNone 
ContrastEnhancementMinMax 
ContrastEnhancementStdDev 
ContrastEnhancementCumulativeCut 

Definition at line 86 of file qgsraster.h.

This enumerator describes the different kinds of drawing we can do.

Enumerator:
UndefinedDrawingStyle 
SingleBandGray 
SingleBandPseudoColor 
PalettedColor 
PalettedSingleBandGray 
PalettedSingleBandPseudoColor 
PalettedMultiBandColor 
MultiBandSingleBandGray 
MultiBandSingleBandPseudoColor 
MultiBandColor 
SingleBandColorDataStyle 

Definition at line 95 of file qgsraster.h.

Enumerator:
IdentifyFormatUndefined 
IdentifyFormatValue 
IdentifyFormatText 
IdentifyFormatHtml 
IdentifyFormatFeature 

Definition at line 54 of file qgsraster.h.

Enumerator:
PyramidsFlagNo 
PyramidsFlagYes 
PyramidsCopyExisting 

Definition at line 71 of file qgsraster.h.

Enumerator:
ProgressHistogram 
ProgressPyramids 
ProgressStatistics 

Definition at line 64 of file qgsraster.h.

Enumerator:
PyramidsGTiff 
PyramidsInternal 
PyramidsErdas 

Definition at line 78 of file qgsraster.h.

Member Function Documentation

QString QgsRaster::contrastEnhancementLimitsAsString ( QgsRaster::ContrastEnhancementLimits  theLimits)
static
QgsRaster::ContrastEnhancementLimits QgsRaster::contrastEnhancementLimitsFromString ( QString  theLimits)
static
double QgsRaster::representableValue ( double  value,
QGis::DataType  dataType 
)
static

Get value representable by given data type.

Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64.

Parameters
value
dataType
Note
added in version 2.1

Definition at line 56 of file qgsraster.cpp.

References QGis::Byte, QGis::Float32, QGis::Int16, QGis::Int32, QGis::UInt16, and QGis::UInt32.


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