QGIS API Documentation
3.0.2-Girona (307d082)
|
This class describes the origin of min/max values. More...
#include <qgsrasterminmaxorigin.h>
Public Types | |
enum | Extent { WholeRaster, CurrentCanvas, UpdatedCanvas } |
This enumerator describes the extent used to compute min/max values. More... | |
enum | Limits { None, MinMax, StdDev, CumulativeCut } |
This enumerator describes the limits used to compute min/max values. More... | |
enum | StatAccuracy { Exact, Estimated } |
This enumerator describes the accuracy used to compute statistics. More... | |
Public Member Functions | |
QgsRasterMinMaxOrigin () | |
Default constructor. More... | |
double | cumulativeCutLower () const |
Return lower bound of cumulative cut method (between 0 and 1). More... | |
double | cumulativeCutUpper () const |
Return upper bound of cumulative cut method (between 0 and 1). More... | |
QgsRasterMinMaxOrigin::Extent | extent () const |
Return extent. More... | |
QgsRasterMinMaxOrigin::Limits | limits () const |
Return limits. More... | |
bool | operator== (const QgsRasterMinMaxOrigin &other) const |
Equality operator. More... | |
void | readXml (const QDomElement &elem) |
Deserialize object. More... | |
void | setCumulativeCutLower (double val) |
Set lower bound of cumulative cut method (between 0 and 1). More... | |
void | setCumulativeCutUpper (double val) |
Set upper bound of cumulative cut method (between 0 and 1). More... | |
void | setExtent (QgsRasterMinMaxOrigin::Extent extent) |
Set extent. More... | |
void | setLimits (QgsRasterMinMaxOrigin::Limits limits) |
Set limits. More... | |
void | setStatAccuracy (QgsRasterMinMaxOrigin::StatAccuracy accuracy) |
Set statistics accuracy. More... | |
void | setStdDevFactor (double val) |
Set factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ]. More... | |
QgsRasterMinMaxOrigin::StatAccuracy | statAccuracy () const |
Return statistic accuracy. More... | |
double | stdDevFactor () const |
Return factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ]. More... | |
void | writeXml (QDomDocument &doc, QDomElement &parentElem) const |
Serialize object. More... | |
Static Public Member Functions | |
static QgsRasterMinMaxOrigin::Extent | extentFromString (const QString &extent) |
Deserialize Extent. More... | |
static QString | extentString (QgsRasterMinMaxOrigin::Extent extent) |
Return a string to serialize Extent. More... | |
static Limits | limitsFromString (const QString &limits) |
Deserialize Limits. More... | |
static QString | limitsString (Limits limits) |
Return a string to serialize Limits. More... | |
static QgsRasterMinMaxOrigin::StatAccuracy | statAccuracyFromString (const QString &accuracy) |
Deserialize StatAccuracy. More... | |
static QString | statAccuracyString (QgsRasterMinMaxOrigin::StatAccuracy accuracy) |
Return a string to serialize StatAccuracy. More... | |
Static Public Attributes | |
static constexpr double | CUMULATIVE_CUT_LOWER = 0.02 |
Default cumulative cut lower limit. More... | |
static constexpr double | CUMULATIVE_CUT_UPPER = 0.98 |
Default cumulative cut upper limit. More... | |
static constexpr double | DEFAULT_STDDEV_FACTOR = 2.0 |
Default standard deviation factor. More... | |
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.
This enumerator describes the extent used to compute min/max values.
Definition at line 57 of file qgsrasterminmaxorigin.h.
This enumerator describes the limits used to compute min/max values.
Enumerator | |
---|---|
None | User defined. |
MinMax | Real min-max values. |
StdDev | Range is [ mean - stdDevFactor() * stddev, mean + stdDevFactor() * stddev ]. |
CumulativeCut | Range is [ min + cumulativeCutLower() * (max - min), min + cumulativeCutUpper() * (max - min) ]. |
Definition at line 48 of file qgsrasterminmaxorigin.h.
This enumerator describes the accuracy used to compute statistics.
Enumerator | |
---|---|
Exact | Exact statistics. |
Estimated | Approximated statistics. |
Definition at line 68 of file qgsrasterminmaxorigin.h.
QgsRasterMinMaxOrigin::QgsRasterMinMaxOrigin | ( | ) |
Default constructor.
Definition at line 24 of file qgsrasterminmaxorigin.cpp.
|
inline |
Return lower bound of cumulative cut method (between 0 and 1).
Definition at line 94 of file qgsrasterminmaxorigin.h.
|
inline |
Return upper bound of cumulative cut method (between 0 and 1).
Definition at line 97 of file qgsrasterminmaxorigin.h.
|
inline |
Return extent.
Definition at line 88 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize Extent.
Definition at line 92 of file qgsrasterminmaxorigin.cpp.
|
static |
Return a string to serialize Extent.
Definition at line 78 of file qgsrasterminmaxorigin.cpp.
|
inline |
Return limits.
Definition at line 85 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize Limits.
Definition at line 61 of file qgsrasterminmaxorigin.cpp.
|
static |
Return a string to serialize Limits.
Definition at line 45 of file qgsrasterminmaxorigin.cpp.
bool QgsRasterMinMaxOrigin::operator== | ( | const QgsRasterMinMaxOrigin & | other | ) | const |
Equality operator.
Definition at line 35 of file qgsrasterminmaxorigin.cpp.
void QgsRasterMinMaxOrigin::readXml | ( | const QDomElement & | elem | ) |
Deserialize object.
Definition at line 165 of file qgsrasterminmaxorigin.cpp.
|
inline |
Set lower bound of cumulative cut method (between 0 and 1).
Definition at line 114 of file qgsrasterminmaxorigin.h.
|
inline |
Set upper bound of cumulative cut method (between 0 and 1).
Definition at line 117 of file qgsrasterminmaxorigin.h.
|
inline |
Set extent.
Definition at line 108 of file qgsrasterminmaxorigin.h.
|
inline |
Set limits.
Definition at line 105 of file qgsrasterminmaxorigin.h.
|
inline |
Set statistics accuracy.
Definition at line 111 of file qgsrasterminmaxorigin.h.
|
inline |
Set factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
Definition at line 120 of file qgsrasterminmaxorigin.h.
|
inline |
Return statistic accuracy.
Definition at line 91 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize StatAccuracy.
Definition at line 119 of file qgsrasterminmaxorigin.cpp.
|
static |
Return a string to serialize StatAccuracy.
Definition at line 112 of file qgsrasterminmaxorigin.cpp.
|
inline |
Return factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
Definition at line 100 of file qgsrasterminmaxorigin.h.
void QgsRasterMinMaxOrigin::writeXml | ( | QDomDocument & | doc, |
QDomElement & | parentElem | ||
) | const |
Serialize object.
Definition at line 126 of file qgsrasterminmaxorigin.cpp.
|
static |
Default cumulative cut lower limit.
Definition at line 39 of file qgsrasterminmaxorigin.h.
|
static |
Default cumulative cut upper limit.
Definition at line 42 of file qgsrasterminmaxorigin.h.
|
static |
Default standard deviation factor.
Definition at line 45 of file qgsrasterminmaxorigin.h.