Skip To Content ArcGIS for Developers Sign In Dashboard

MinMaxStretchParameters Class

(Esri::ArcGISRuntime::MinMaxStretchParameters)

A minimum/maximum stretch parameters object. More...

Header: #include <MinMaxStretchParameters>
Since: Esri::ArcGISRuntime 100.0
Inherits: StretchParameters

Public Functions

MinMaxStretchParameters()
MinMaxStretchParameters(const QList<double> &minValues, const QList<double> &maxValues)
MinMaxStretchParameters(const MinMaxStretchParameters &other)
MinMaxStretchParameters(MinMaxStretchParameters &&other)
MinMaxStretchParameters(const StretchParameters &other)
~MinMaxStretchParameters()
bool isValid() const
QList<double> maxValues() const
QList<double> minValues() const
void setMaxValues(const QList<double> &maxValues)
void setMinValues(const QList<double> &minValues)
MinMaxStretchParameters &operator=(const MinMaxStretchParameters &other)
MinMaxStretchParameters &operator=(MinMaxStretchParameters &&other)

Detailed Description

A minimum/maximum stretch parameters object.

Member Function Documentation

MinMaxStretchParameters::MinMaxStretchParameters()

Default constructor.

MinMaxStretchParameters::MinMaxStretchParameters(const QList<double> &minValues, const QList<double> &maxValues)

Constructor that takes a list of minValues and maxValues

MinMaxStretchParameters::MinMaxStretchParameters(const MinMaxStretchParameters &other)

Copy constructor from other MinMaxStretchParameters.

MinMaxStretchParameters::MinMaxStretchParameters(MinMaxStretchParameters &&other)

Move constructor from other MinMaxStretchParameters.

MinMaxStretchParameters::MinMaxStretchParameters(const StretchParameters &other)

Converting constructor from other StretchParameters.

See also Downcast helper functions.

MinMaxStretchParameters::~MinMaxStretchParameters()

Destructor

bool MinMaxStretchParameters::isValid() const

Gets whether this MinMaxStretchParameters is valid.

A MinMaxStretchParameters is valid if it is not empty and unitType is UnitType::MinMaxStretchParameters.

Returns true if valid.

This function was introduced in Esri::ArcGISRuntime 100.2.

QList<double> MinMaxStretchParameters::maxValues() const

Returns the maximum pixel value which serves as an endpoint for the histogram used for the stretch.

The 0th element is for the 0th band, and so on.

All pixel values in the dataset greater than this value will be pushed to the maximum end of the histogram. For example: Consider an 8-bit raster containing pixel values in the range from 33 to 206, and you've defined a max of 50 and min of 180. The histogram will be redistributed to spread the values from 0 to 255, all values 33 to 50 becoming 0 and 180 to 206 becoming 255, with all other values spread in between. The array must contain a maximum value for each band in the raster.

See also setMaxValues().

QList<double> MinMaxStretchParameters::minValues() const

Returns the minimum pixel value for each band in the raster, which serves as an endpoint for the histogram used for the stretch.

The 0th element is for the 0th band, and so on.

All pixel values in the dataset greater than this value will be pushed to the maximum end of the histogram. For example: Consider an 8-bit raster containing pixel values in the range from 33 to 206, and you've defined a max of 50 and min of 180. The histogram will be redistributed to spread the values from 0 to 255, all values 33 to 50 becoming 0 and 180 to 206 becoming 255, with all other values spread in between. The array must contain a minimum value for each band in the raster.

See also setMinValues().

void MinMaxStretchParameters::setMaxValues(const QList<double> &maxValues)

Sets maxValues in this MinMaxStretchParameters object, one for each raster band.

See also maxValues().

void MinMaxStretchParameters::setMinValues(const QList<double> &minValues)

Sets minValues in this MinMaxStretchParameters object, one for each raster band.

See also minValues().

MinMaxStretchParameters &MinMaxStretchParameters::operator=(const MinMaxStretchParameters &other)

Assignment operator from other MinMaxStretchParameters.

MinMaxStretchParameters &MinMaxStretchParameters::operator=(MinMaxStretchParameters &&other)

Move operator from other MinMaxStretchParameters.


Feedback on this topic?