Skip To Content ArcGIS for Developers Sign In Dashboard

StandardDeviationStretchParameters Class

(Esri::ArcGISRuntime::StandardDeviationStretchParameters)

A standard deviation stretch parameters object. More...

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

Public Functions

StandardDeviationStretchParameters()
StandardDeviationStretchParameters(double factor)
StandardDeviationStretchParameters(const StandardDeviationStretchParameters &other)
StandardDeviationStretchParameters(StandardDeviationStretchParameters &&other)
StandardDeviationStretchParameters(const StretchParameters &other)
~StandardDeviationStretchParameters()
double factor() const
bool isValid() const
void setFactor(double factor)
StandardDeviationStretchParameters &operator=(const StandardDeviationStretchParameters &other)
StandardDeviationStretchParameters &operator=(StandardDeviationStretchParameters &&other)

Detailed Description

A standard deviation stretch parameters object.

Member Function Documentation

StandardDeviationStretchParameters::StandardDeviationStretchParameters()

Default constructor.

StandardDeviationStretchParameters::StandardDeviationStretchParameters(double factor)

Constructor that takes a standard deviation factor.

StandardDeviationStretchParameters::StandardDeviationStretchParameters(const StandardDeviationStretchParameters &other)

Copy constructor from other StandardDeviationStretchParameters.

StandardDeviationStretchParameters::StandardDeviationStretchParameters(StandardDeviationStretchParameters &&other)

Move constructor from other StandardDeviationStretchParameters.

StandardDeviationStretchParameters::StandardDeviationStretchParameters(const StretchParameters &other)

Converting constructor from other StretchParameters.

See also Downcast helper functions.

StandardDeviationStretchParameters::~StandardDeviationStretchParameters()

Destructor

double StandardDeviationStretchParameters::factor() const

Returns the number of standard deviations defining the range of pixel values for the stretch histogram.

See also setFactor().

bool StandardDeviationStretchParameters::isValid() const

Gets whether this StandardDeviationStretchParameters is valid.

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

Returns true if valid.

This function was introduced in Esri::ArcGISRuntime 100.2.

void StandardDeviationStretchParameters::setFactor(double factor)

Returns the number of standard deviations defining the range of pixel values for the stretch histogram.

  • factor - The number of standard deviations.

For example: Consider an 8-bit raster containing pixel values in the range from 33 to 206, and you've specified factor to be 2. The values below the 2nd standard deviation become 0, values above become 255, and the remaining values are stretched in between 0 to 255.

Valid values are 0 - 100.

See also factor().

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

Assignment operator from other StandardDeviationStretchParameters.

StandardDeviationStretchParameters &StandardDeviationStretchParameters::operator=(StandardDeviationStretchParameters &&other)

Move operator from other StandardDeviationStretchParameters.


Feedback on this topic?