QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
|
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. | |
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). | |
QgsRasterMinMaxOrigin::Extent | extent () const |
Returns the raster extent. | |
QgsRasterMinMaxOrigin::Limits | limits () const |
Returns the raster limits. | |
bool | operator== (const QgsRasterMinMaxOrigin &other) const |
Equality operator. | |
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 (QgsRasterMinMaxOrigin::Extent extent) |
Sets the extent. | |
void | setLimits (QgsRasterMinMaxOrigin::Limits limits) |
Sets the limits. | |
void | setStatAccuracy (QgsRasterMinMaxOrigin::StatAccuracy 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 ]. | |
QgsRasterMinMaxOrigin::StatAccuracy | 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 QgsRasterMinMaxOrigin::Extent | extentFromString (const QString &extent) |
Deserialize Extent. | |
static QString | extentString (QgsRasterMinMaxOrigin::Extent extent) |
Returns a string to serialize Extent. | |
static Limits | limitsFromString (const QString &limits) |
Deserialize Limits. | |
static QString | limitsString (Limits limits) |
Returns a string to serialize Limits. | |
static QgsRasterMinMaxOrigin::StatAccuracy | statAccuracyFromString (const QString &accuracy) |
Deserialize StatAccuracy. | |
static QString | statAccuracyString (QgsRasterMinMaxOrigin::StatAccuracy 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. | |
This class describes the origin of min/max values.
It does not store by itself the min/max values.
Definition at line 32 of file qgsrasterminmaxorigin.h.
This enumerator describes the extent used to compute min/max values.
Definition at line 67 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 57 of file qgsrasterminmaxorigin.h.
This enumerator describes the accuracy used to compute statistics.
Enumerator | |
---|---|
Exact | Exact statistics. |
Estimated | Approximated statistics. |
Definition at line 78 of file qgsrasterminmaxorigin.h.
QgsRasterMinMaxOrigin::QgsRasterMinMaxOrigin | ( | ) |
Default constructor.
Definition at line 25 of file qgsrasterminmaxorigin.cpp.
|
inline |
Returns the lower bound of cumulative cut method (between 0 and 1).
Definition at line 104 of file qgsrasterminmaxorigin.h.
|
inline |
Returns the upper bound of cumulative cut method (between 0 and 1).
Definition at line 107 of file qgsrasterminmaxorigin.h.
|
inline |
Returns the raster extent.
Definition at line 98 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize Extent.
Definition at line 93 of file qgsrasterminmaxorigin.cpp.
|
static |
Returns a string to serialize Extent.
Definition at line 79 of file qgsrasterminmaxorigin.cpp.
|
inline |
Returns the raster limits.
Definition at line 95 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize Limits.
Definition at line 62 of file qgsrasterminmaxorigin.cpp.
|
static |
Returns a string to serialize Limits.
Definition at line 46 of file qgsrasterminmaxorigin.cpp.
bool QgsRasterMinMaxOrigin::operator== | ( | const QgsRasterMinMaxOrigin & | other | ) | const |
Equality operator.
Definition at line 36 of file qgsrasterminmaxorigin.cpp.
void QgsRasterMinMaxOrigin::readXml | ( | const QDomElement & | elem | ) |
Deserialize object.
Definition at line 166 of file qgsrasterminmaxorigin.cpp.
|
inline |
Sets the lower bound of cumulative cut method (between 0 and 1).
Definition at line 124 of file qgsrasterminmaxorigin.h.
|
inline |
Sets the upper bound of cumulative cut method (between 0 and 1).
Definition at line 127 of file qgsrasterminmaxorigin.h.
|
inline |
Sets the extent.
Definition at line 118 of file qgsrasterminmaxorigin.h.
|
inline |
Sets the limits.
Definition at line 115 of file qgsrasterminmaxorigin.h.
|
inline |
Sets the statistics accuracy.
Definition at line 121 of file qgsrasterminmaxorigin.h.
|
inline |
Sets the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
Definition at line 130 of file qgsrasterminmaxorigin.h.
|
inline |
Returns the raster statistic accuracy.
Definition at line 101 of file qgsrasterminmaxorigin.h.
|
static |
Deserialize StatAccuracy.
Definition at line 120 of file qgsrasterminmaxorigin.cpp.
|
static |
Returns a string to serialize StatAccuracy.
Definition at line 113 of file qgsrasterminmaxorigin.cpp.
|
inline |
Returns the factor f so that the min/max range is [ mean - f * stddev , mean + f * stddev ].
Definition at line 110 of file qgsrasterminmaxorigin.h.
void QgsRasterMinMaxOrigin::writeXml | ( | QDomDocument & | doc, |
QDomElement & | parentElem | ||
) | const |
Serialize object.
Definition at line 127 of file qgsrasterminmaxorigin.cpp.
|
staticconstexpr |
Default cumulative cut lower limit.
Definition at line 38 of file qgsrasterminmaxorigin.h.
|
staticconstexpr |
Default cumulative cut upper limit.
Definition at line 41 of file qgsrasterminmaxorigin.h.
|
staticconstexpr |
Default standard deviation factor.
Definition at line 44 of file qgsrasterminmaxorigin.h.