Class: QgsRasterRange¶
- class qgis.core.QgsRasterRange¶
Bases:
sip.wrapper
Raster values range container. Represents range of values between min and max including min and max value.
QgsRasterRange() 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
)Methods
Returns a text representation of the range.
Returns the bounds type for the range, which specifies whether or not the min and max values themselves are included in the range.
Returns
True
if this range contains the specifiedvalue
.Returns the maximum value for the range.
Returns the minimum value for the range.
Returns
True
if this range overlaps another range.Sets the bounds
type
for the range, which specifies whether or not the min and max values themselves are included in the range.Sets the maximum value for the range.
Sets the minimum value for the range.
Attributes
- 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.
- Return type:
str
- 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.
- Return type:
- contains(self, value: float) bool ¶
Returns
True
if this range contains the specifiedvalue
.New in version 3.2.
contains(value: float, rangeList: Iterable[QgsRasterRange]) -> bool Tests if a
value
is within the list of ranges- Parameters:
value (float) – value
rangeList – list of ranges
- Return type:
bool
- 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.
- Parameters:
other (QgsRasterRange) –
- Return type:
bool
- 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.
- Parameters:
type (QgsRasterRange.BoundsType) –
- setMax(self, max: float) float ¶
Sets the maximum value for the range.
See also
- Parameters:
max (float) –
- Return type:
float