Subgroup: Raster
Class: QgsRasterRange¶
-
class
qgis.core.
QgsRasterRange
¶ Bases:
sip.wrapper
Default constructor, both min and max value for the range will be set to NaN.
QgsRasterRange(min: float, max: float, bounds: QgsRasterRange.BoundsType = QgsRasterRange.IncludeMinAndMax) Constructor for a range with the given
min
andmax
values.The
bounds
argument dictates how the min and max value themselves will be handled by the range.QgsRasterRange(QgsRasterRange)
Raster values range container. Represents range of values between min and max including min and max value.
Methods
asText
Returns a text representation of the range. bounds
Returns the bounds type for the range, which specifies whether or not the min and max values themselves are included in the range. contains
Returns true if this range contains the specified value
.max
Returns the maximum value for the range. min
Returns the minimum value for the range. overlaps
Returns true if this range overlaps another range. setBounds
Sets the bounds type
for the range, which specifies whether or not the min and max values themselves are included in the range.setMax
Sets the maximum value for the range. setMin
Sets the minimum value for the range. Signals
Attributes
Exclusive
IncludeMax
IncludeMin
IncludeMinAndMax
-
class
BoundsType
¶ Bases:
int
-
Exclusive
= 3¶
-
IncludeMax
= 1¶
-
IncludeMin
= 2¶
-
IncludeMinAndMax
= 0¶
-
asText
(self) → str¶ Returns a text representation of the range.
New in version 3.2.
-
bounds
(self) → QgsRasterRange.BoundsType¶ Returns the bounds type for the range, which specifies whether or not the min and max values themselves are included in the range.
See also
New in version 3.2.
-
contains
(self, value: float) → bool¶ Returns true if this range contains the specified
value
.New in version 3.2.
contains(value: float, rangeList: object) -> bool Tests if a
value
is within the list of rangesParameters: - value – value
- rangeList – list of ranges
Returns: true if value is in at least one of ranges
-
overlaps
(self, other: QgsRasterRange) → bool¶ Returns true if this range overlaps another range.
New in version 3.2.
-
setBounds
(self, type: QgsRasterRange.BoundsType)¶ Sets the bounds
type
for the range, which specifies whether or not the min and max values themselves are included in the range.See also
New in version 3.2.
-
class