A standard deviation stretch parameters object. More...
| Header: | #include <StandardDeviationStretchParameters.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::StretchParameters |
Public Functions
| StandardDeviationStretchParameters() | |
| StandardDeviationStretchParameters(double factor) | |
| StandardDeviationStretchParameters(const Esri::ArcGISRuntime::StandardDeviationStretchParameters &other) | |
| StandardDeviationStretchParameters(Esri::ArcGISRuntime::StandardDeviationStretchParameters &&other) | |
| StandardDeviationStretchParameters(const Esri::ArcGISRuntime::StretchParameters &other) | |
| virtual | ~StandardDeviationStretchParameters() override |
| double | factor() const |
| bool | isValid() const |
| void | setFactor(double factor) |
| Esri::ArcGISRuntime::StandardDeviationStretchParameters & | operator=(const Esri::ArcGISRuntime::StandardDeviationStretchParameters &other) |
| Esri::ArcGISRuntime::StandardDeviationStretchParameters & | operator=(Esri::ArcGISRuntime::StandardDeviationStretchParameters &&other) |
Detailed Description
Relevant samples:
- Stretch renderer: Use a stretch renderer to enhance the visual contrast of raster data for analysis.
Member Function Documentation
StandardDeviationStretchParameters::StandardDeviationStretchParameters ()
Default constructor.
[explicit] StandardDeviationStretchParameters::StandardDeviationStretchParameters (double factor)
Constructor that takes a standard deviation factor.
StandardDeviationStretchParameters::StandardDeviationStretchParameters (const Esri::ArcGISRuntime::StandardDeviationStretchParameters &other)
Copy constructor from other StandardDeviationStretchParameters.
StandardDeviationStretchParameters::StandardDeviationStretchParameters (Esri::ArcGISRuntime::StandardDeviationStretchParameters &&other)
Move constructor from other StandardDeviationStretchParameters.
[explicit] StandardDeviationStretchParameters::StandardDeviationStretchParameters (const Esri::ArcGISRuntime::StretchParameters &other)
Converting constructor from other StretchParameters.
See also Downcast helper functions.
[override virtual] 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().
[since Esri::ArcGISRuntime 100.2] 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().
Esri::ArcGISRuntime::StandardDeviationStretchParameters &StandardDeviationStretchParameters::operator=(const Esri::ArcGISRuntime::StandardDeviationStretchParameters &other)
Assignment operator from other StandardDeviationStretchParameters.
Esri::ArcGISRuntime::StandardDeviationStretchParameters &StandardDeviationStretchParameters::operator=(Esri::ArcGISRuntime::StandardDeviationStretchParameters &&other)
Move operator from other StandardDeviationStretchParameters.