QgsRasterMinMaxOrigin Class Reference

This class describes the origin of min/max values. More...

#include <qgsrasterminmaxorigin.h>

Public Member Functions
	QgsRasterMinMaxOrigin ()
double	cumulativeCutLower () const
	Returns the lower bound of cumulative cut method (between 0 and 1).
double	cumulativeCutUpper () const
	Returns the upper bound of cumulative cut method (between 0 and 1).
Qgis::RasterRangeExtent	extent () const
	Returns the raster extent.
Qgis::RasterRangeLimit	limits () const
	Returns the raster limits.
bool	operator== (const QgsRasterMinMaxOrigin &other) const
void	readXml (const QDomElement &elem)
	Deserialize object.
void	setCumulativeCutLower (double val)
	Sets the lower bound of cumulative cut method (between 0 and 1).
void	setCumulativeCutUpper (double val)
	Sets the upper bound of cumulative cut method (between 0 and 1).
void	setExtent (Qgis::RasterRangeExtent extent)
	Sets the extent.
void	setLimits (Qgis::RasterRangeLimit limits)
	Sets the limits.
void	setStatAccuracy (Qgis::RasterRangeAccuracy accuracy)
	Sets the statistics accuracy.
void	setStdDevFactor (double val)
	Sets the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
Qgis::RasterRangeAccuracy	statAccuracy () const
	Returns the raster statistic accuracy.
double	stdDevFactor () const
	Returns the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
void	writeXml (QDomDocument &doc, QDomElement &parentElem) const
	Serialize object.

Static Public Member Functions
static Qgis::RasterRangeExtent	extentFromString (const QString &extent)
	Deserialize Extent.
static QString	extentString (Qgis::RasterRangeExtent extent)
	Returns a string to serialize Extent.
static Qgis::RasterRangeLimit	limitsFromString (const QString &limits)
	Deserialize Limits.
static QString	limitsString (Qgis::RasterRangeLimit limits)
	Returns a string to serialize Limits.
static Qgis::RasterRangeAccuracy	statAccuracyFromString (const QString &accuracy)
	Deserialize StatAccuracy.
static QString	statAccuracyString (Qgis::RasterRangeAccuracy accuracy)
	Returns a string to serialize StatAccuracy.

Static Public Attributes
static constexpr double	CUMULATIVE_CUT_LOWER = 0.02
	Default cumulative cut lower limit.
static constexpr double	CUMULATIVE_CUT_UPPER = 0.98
	Default cumulative cut upper limit.
static constexpr double	DEFAULT_STDDEV_FACTOR = 2.0
	Default standard deviation factor.

Detailed Description

This class describes the origin of min/max values.

It does not store by itself the min/max values.

Definition at line 33 of file qgsrasterminmaxorigin.h.

Constructor & Destructor Documentation

QgsRasterMinMaxOrigin()

QgsRasterMinMaxOrigin::QgsRasterMinMaxOrigin

(

)

Definition at line 25 of file qgsrasterminmaxorigin.cpp.

Member Function Documentation

cumulativeCutLower()

double QgsRasterMinMaxOrigin::cumulativeCutLower ( ) const

inline

Returns the lower bound of cumulative cut method (between 0 and 1).

Definition at line 63 of file qgsrasterminmaxorigin.h.

cumulativeCutUpper()

double QgsRasterMinMaxOrigin::cumulativeCutUpper ( ) const

inline

Returns the upper bound of cumulative cut method (between 0 and 1).

Definition at line 66 of file qgsrasterminmaxorigin.h.

extent()

Qgis::RasterRangeExtent QgsRasterMinMaxOrigin::extent ( ) const

inline

Returns the raster extent.

Definition at line 57 of file qgsrasterminmaxorigin.h.

extentFromString()

Qgis::RasterRangeExtent QgsRasterMinMaxOrigin::extentFromString ( const QString &  extent )

static

Deserialize Extent.

Definition at line 93 of file qgsrasterminmaxorigin.cpp.

extentString()

QString QgsRasterMinMaxOrigin::extentString ( Qgis::RasterRangeExtent  extent )

static

Returns a string to serialize Extent.

Definition at line 79 of file qgsrasterminmaxorigin.cpp.

limits()

Qgis::RasterRangeLimit QgsRasterMinMaxOrigin::limits ( ) const

inline

Returns the raster limits.

Definition at line 54 of file qgsrasterminmaxorigin.h.

limitsFromString()

Qgis::RasterRangeLimit QgsRasterMinMaxOrigin::limitsFromString ( const QString &  limits )

static

Deserialize Limits.

Definition at line 62 of file qgsrasterminmaxorigin.cpp.

limitsString()

QString QgsRasterMinMaxOrigin::limitsString ( Qgis::RasterRangeLimit  limits )

static

Returns a string to serialize Limits.

Definition at line 46 of file qgsrasterminmaxorigin.cpp.

operator==()

bool QgsRasterMinMaxOrigin::operator==

(

const QgsRasterMinMaxOrigin &

other

)

const

Definition at line 36 of file qgsrasterminmaxorigin.cpp.

readXml()

void QgsRasterMinMaxOrigin::readXml

(

const QDomElement &

elem

)

Deserialize object.

Definition at line 171 of file qgsrasterminmaxorigin.cpp.

setCumulativeCutLower()

void QgsRasterMinMaxOrigin::setCumulativeCutLower ( double  val )

inline

Sets the lower bound of cumulative cut method (between 0 and 1).

Definition at line 83 of file qgsrasterminmaxorigin.h.

setCumulativeCutUpper()

void QgsRasterMinMaxOrigin::setCumulativeCutUpper ( double  val )

inline

Sets the upper bound of cumulative cut method (between 0 and 1).

Definition at line 86 of file qgsrasterminmaxorigin.h.

setExtent()

void QgsRasterMinMaxOrigin::setExtent ( Qgis::RasterRangeExtent  extent )

inline

Sets the extent.

Definition at line 77 of file qgsrasterminmaxorigin.h.

setLimits()

void QgsRasterMinMaxOrigin::setLimits ( Qgis::RasterRangeLimit  limits )

inline

Sets the limits.

Definition at line 74 of file qgsrasterminmaxorigin.h.

setStatAccuracy()

void QgsRasterMinMaxOrigin::setStatAccuracy ( Qgis::RasterRangeAccuracy  accuracy )

inline

Sets the statistics accuracy.

Definition at line 80 of file qgsrasterminmaxorigin.h.

setStdDevFactor()

void QgsRasterMinMaxOrigin::setStdDevFactor ( double  val )

inline

Sets the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].

Definition at line 89 of file qgsrasterminmaxorigin.h.

statAccuracy()

Qgis::RasterRangeAccuracy QgsRasterMinMaxOrigin::statAccuracy ( ) const

inline

Returns the raster statistic accuracy.

Definition at line 60 of file qgsrasterminmaxorigin.h.

statAccuracyFromString()

Qgis::RasterRangeAccuracy QgsRasterMinMaxOrigin::statAccuracyFromString ( const QString &  accuracy )

static

Deserialize StatAccuracy.

Definition at line 125 of file qgsrasterminmaxorigin.cpp.

statAccuracyString()

QString QgsRasterMinMaxOrigin::statAccuracyString ( Qgis::RasterRangeAccuracy  accuracy )

static

Returns a string to serialize StatAccuracy.

Definition at line 113 of file qgsrasterminmaxorigin.cpp.

stdDevFactor()

double QgsRasterMinMaxOrigin::stdDevFactor ( ) const

inline

Returns the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].

Definition at line 69 of file qgsrasterminmaxorigin.h.

writeXml()

void QgsRasterMinMaxOrigin::writeXml	(	QDomDocument &	doc,
		QDomElement &	parentElem
	)		const

Serialize object.

Definition at line 132 of file qgsrasterminmaxorigin.cpp.

Member Data Documentation

CUMULATIVE_CUT_LOWER

constexpr double QgsRasterMinMaxOrigin::CUMULATIVE_CUT_LOWER = 0.02

staticconstexpr

Default cumulative cut lower limit.

Definition at line 39 of file qgsrasterminmaxorigin.h.

CUMULATIVE_CUT_UPPER

constexpr double QgsRasterMinMaxOrigin::CUMULATIVE_CUT_UPPER = 0.98

staticconstexpr

Default cumulative cut upper limit.

Definition at line 42 of file qgsrasterminmaxorigin.h.

DEFAULT_STDDEV_FACTOR

constexpr double QgsRasterMinMaxOrigin::DEFAULT_STDDEV_FACTOR = 2.0

staticconstexpr

Default standard deviation factor.

Definition at line 45 of file qgsrasterminmaxorigin.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgsrasterminmaxorigin.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgsrasterminmaxorigin.cpp