Class: QgsRasterMinMaxOrigin

class qgis.core.QgsRasterMinMaxOrigin

Bases: sip.wrapper

This class describes the origin of min/max values. It does not store by itself the min/max values.

QgsRasterMinMaxOrigin() Default constructor.

QgsRasterMinMaxOrigin(a0: QgsRasterMinMaxOrigin)

Methods

cumulativeCutLower

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

cumulativeCutUpper

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

extent

Returns the raster extent.

extentFromString

Deserialize Extent

extentString

Returns a string to serialize Extent

limits

Returns the raster limits.

limitsFromString

Deserialize Limits

limitsString

Returns a string to serialize Limits

readXml

Deserialize object.

setCumulativeCutLower

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

setCumulativeCutUpper

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

setExtent

Sets the extent.

setLimits

Sets the limits.

setStatAccuracy

Sets the statistics accuracy.

setStdDevFactor

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

statAccuracy

Returns the raster statistic accuracy.

statAccuracyFromString

Deserialize StatAccuracy

statAccuracyString

Returns a string to serialize StatAccuracy

stdDevFactor

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

writeXml

Serialize object.

Attributes

CUMULATIVE_CUT_LOWER

CUMULATIVE_CUT_UPPER

CumulativeCut

CurrentCanvas

DEFAULT_STDDEV_FACTOR

Estimated

Exact

MinMax

None_

StdDev

UpdatedCanvas

WholeRaster

CUMULATIVE_CUT_LOWER = 0.02
CUMULATIVE_CUT_UPPER = 0.98
CumulativeCut = 3
CurrentCanvas = 1
DEFAULT_STDDEV_FACTOR = 2.0
Estimated = 1
Exact = 0
class Extent

Bases: int

class Limits

Bases: int

MinMax = 1
None_ = 0
class StatAccuracy

Bases: int

StdDev = 2
UpdatedCanvas = 2
WholeRaster = 0
cumulativeCutLower(self) float

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

Return type:

float

cumulativeCutUpper(self) float

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

Return type:

float

extent(self) QgsRasterMinMaxOrigin.Extent

Returns the raster extent.

Return type:

QgsRasterMinMaxOrigin.Extent

extentFromString(extent: str | None) QgsRasterMinMaxOrigin.Extent

Deserialize Extent

Parameters:

extent (Optional[str])

Return type:

QgsRasterMinMaxOrigin.Extent

extentString(extent: QgsRasterMinMaxOrigin.Extent) str

Returns a string to serialize Extent

Parameters:

extent (QgsRasterMinMaxOrigin.Extent)

Return type:

str

limits(self) QgsRasterMinMaxOrigin.Limits

Returns the raster limits.

Return type:

QgsRasterMinMaxOrigin.Limits

limitsFromString(limits: str | None) QgsRasterMinMaxOrigin.Limits

Deserialize Limits

Parameters:

limits (Optional[str])

Return type:

QgsRasterMinMaxOrigin.Limits

limitsString(limits: QgsRasterMinMaxOrigin.Limits) str

Returns a string to serialize Limits

Parameters:

limits (QgsRasterMinMaxOrigin.Limits)

Return type:

str

readXml(self, elem: QDomElement)

Deserialize object.

Parameters:

elem (QDomElement)

setCumulativeCutLower(self, val: float)

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

Parameters:

val (float)

setCumulativeCutUpper(self, val: float)

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

Parameters:

val (float)

setExtent(self, extent: QgsRasterMinMaxOrigin.Extent)

Sets the extent.

Parameters:

extent (QgsRasterMinMaxOrigin.Extent)

setLimits(self, limits: QgsRasterMinMaxOrigin.Limits)

Sets the limits.

Parameters:

limits (QgsRasterMinMaxOrigin.Limits)

setStatAccuracy(self, accuracy: QgsRasterMinMaxOrigin.StatAccuracy)

Sets the statistics accuracy.

Parameters:

accuracy (QgsRasterMinMaxOrigin.StatAccuracy)

setStdDevFactor(self, val: float)

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

Parameters:

val (float)

statAccuracy(self) QgsRasterMinMaxOrigin.StatAccuracy

Returns the raster statistic accuracy.

Return type:

QgsRasterMinMaxOrigin.StatAccuracy

statAccuracyFromString(accuracy: str | None) QgsRasterMinMaxOrigin.StatAccuracy

Deserialize StatAccuracy

Parameters:

accuracy (Optional[str])

Return type:

QgsRasterMinMaxOrigin.StatAccuracy

statAccuracyString(accuracy: QgsRasterMinMaxOrigin.StatAccuracy) str

Returns a string to serialize StatAccuracy

Parameters:

accuracy (QgsRasterMinMaxOrigin.StatAccuracy)

Return type:

str

stdDevFactor(self) float

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

Return type:

float

writeXml(self, doc: QDomDocument, parentElem: QDomElement)

Serialize object.

Parameters:
  • doc (QDomDocument)

  • parentElem (QDomElement)