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	DrawingStyle { UndefinedDrawingStyle, SingleBandGray, SingleBandPseudoColor, PalettedColor, PalettedSingleBandGray, PalettedSingleBandPseudoColor, PalettedMultiBandColor, MultiBandSingleBandGray, MultiBandSingleBandPseudoColor, MultiBandColor, SingleBandColorDataStyle }
	This enumerator describes the different kinds of drawing we can do. More...

enum	IdentifyFormat { IdentifyFormatUndefined = 0, IdentifyFormatValue = 1, IdentifyFormatText = 1 << 1, IdentifyFormatHtml = 1 << 2, IdentifyFormatFeature = 1 << 3 }

enum	RasterBuildPyramids { PyramidsFlagNo = 0, PyramidsFlagYes = 1, PyramidsCopyExisting = 2 }

enum	RasterProgressType { ProgressHistogram = 0, ProgressPyramids = 1, ProgressStatistics = 2 }

enum	RasterPyramidsFormat { PyramidsGTiff = 0, PyramidsInternal = 1, PyramidsErdas = 2 }

Static Public Member Functions
static bool	isRepresentableValue (double value, Qgis::DataType dataType)
	Check if the specified value is representable in the given data type. More...

static double	representableValue (double value, Qgis::DataType dataType)
	Gets value representable by given data type. More...

Detailed Description

Raster namespace.

Definition at line 31 of file qgsraster.h.

Member Enumeration Documentation

◆ ColorInterpretation

enum QgsRaster::ColorInterpretation

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 35 of file qgsraster.h.

◆ DrawingStyle

enum QgsRaster::DrawingStyle

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 89 of file qgsraster.h.

◆ IdentifyFormat

enum QgsRaster::IdentifyFormat

Enumerator
IdentifyFormatUndefined
IdentifyFormatValue
IdentifyFormatText
IdentifyFormatHtml
IdentifyFormatFeature

Definition at line 57 of file qgsraster.h.

◆ RasterBuildPyramids

enum QgsRaster::RasterBuildPyramids

Enumerator
PyramidsFlagNo
PyramidsFlagYes
PyramidsCopyExisting

Definition at line 74 of file qgsraster.h.

◆ RasterProgressType

enum QgsRaster::RasterProgressType

Enumerator
ProgressHistogram
ProgressPyramids
ProgressStatistics

Definition at line 67 of file qgsraster.h.

◆ RasterPyramidsFormat

enum QgsRaster::RasterPyramidsFormat

Enumerator
PyramidsGTiff
PyramidsInternal
PyramidsErdas

Definition at line 81 of file qgsraster.h.

Member Function Documentation

◆ isRepresentableValue()

bool QgsRaster::isRepresentableValue	(	double	value,
		Qgis::DataType	dataType
	)

static

Check if the specified value is representable in the given data type.

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

Parameters

value
dataType

Note: not available in Python bindings

Since: QGIS 2.16

Definition at line 22 of file qgsraster.cpp.

◆ representableValue()

double QgsRaster::representableValue	(	double	value,
		Qgis::DataType	dataType
	)

static

Gets value representable by given data type.

Supported are numerical types Byte, UInt16, Int16, UInt32, Int32, Float32, Float64. This is done through C casting, so you have to be sure that the provided value is representable in the output data type. This can be checked with isRepresentableValue().