PercentClipStretchParameters Class

  • PercentClipStretchParameters
  • class Esri::ArcGISRuntime::PercentClipStretchParameters

    A percent clip stretch parameters object. More...

    Header: #include <PercentClipStretchParameters.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::StretchParameters

    Public Functions

    PercentClipStretchParameters()
    PercentClipStretchParameters(double min, double max)
    PercentClipStretchParameters(const Esri::ArcGISRuntime::PercentClipStretchParameters &other)
    PercentClipStretchParameters(Esri::ArcGISRuntime::PercentClipStretchParameters &&other)
    PercentClipStretchParameters(const Esri::ArcGISRuntime::StretchParameters &other)
    virtual ~PercentClipStretchParameters() override
    bool isValid() const
    double max() const
    double min() const
    void setMax(double max)
    void setMin(double min)
    Esri::ArcGISRuntime::PercentClipStretchParameters &operator=(const Esri::ArcGISRuntime::PercentClipStretchParameters &other)
    Esri::ArcGISRuntime::PercentClipStretchParameters &operator=(Esri::ArcGISRuntime::PercentClipStretchParameters &&other)

    Detailed Description

    Member Function Documentation

    PercentClipStretchParameters::PercentClipStretchParameters()

    Default constructor.

    PercentClipStretchParameters::PercentClipStretchParameters(double min, double max)

    Constructor that takes a min and max pixel value.

    PercentClipStretchParameters::PercentClipStretchParameters(const Esri::ArcGISRuntime::PercentClipStretchParameters &other)

    Copy constructor from other PercentClipStretchParameters.

    PercentClipStretchParameters::PercentClipStretchParameters(Esri::ArcGISRuntime::PercentClipStretchParameters &&other)

    Move constructor from other PercentClipStretchParameters.

    [explicit] PercentClipStretchParameters::PercentClipStretchParameters(const Esri::ArcGISRuntime::StretchParameters &other)

    Converting constructor from other StretchParameters.

    See also Downcast helper functions.

    [override virtual] PercentClipStretchParameters::~PercentClipStretchParameters()

    Destructor

    [since Esri::ArcGISRuntime 100.2] bool PercentClipStretchParameters::isValid() const

    Gets whether this PercentClipStretchParameters is valid.

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

    Returns true if valid.

    This function was introduced in Esri::ArcGISRuntime 100.2.

    double PercentClipStretchParameters::max() const

    The percentile cutoff above which pixel values in the raster dataset are to be clipped.

    For example: Consider an 8-bit raster containing pixel values in the range from 33 to 206, and you've defined a percent clip minimum and maximum of 2. If 2 percent at the low end is values 33 to 45 and 2 percent at the high end is 198 to 206, the histogram will be redistributed to spread the values from 0 to 255, all values 33 to 45 becoming 0 and 198 to 206 becoming 255, with all other values spread in between.

    Valid values are 0 - 100.

    See also setMax().

    double PercentClipStretchParameters::min() const

    Returns the percentile cutoff below which pixel values in the raster dataset are to be clipped.

    For example: Consider an 8-bit raster containing pixel values in the range from 33 to 206, and you've defined a percent clip minimum and maximum of 2. If 2 percent at the low end is values 33 to 45 and 2 percent at the high end is 198 to 206, the histogram will be redistributed to spread the values from 0 to 255, all values 33 to 45 becoming 0 and 198 to 206 becoming 255, with all other values spread in between.

    Valid values are 0 - 100.

    See also setMin().

    void PercentClipStretchParameters::setMax(double max)

    Sets the max percentile cutoff above which pixel values in the raster dataset are to be clipped.

    See also max().

    void PercentClipStretchParameters::setMin(double min)

    Sets the min percentile cutoff below which pixel values in the raster dataset are to be clipped.

    See also min().

    Esri::ArcGISRuntime::PercentClipStretchParameters &PercentClipStretchParameters::operator=(const Esri::ArcGISRuntime::PercentClipStretchParameters &other)

    Assignment operator from other PercentClipStretchParameters.

    Esri::ArcGISRuntime::PercentClipStretchParameters &PercentClipStretchParameters::operator=(Esri::ArcGISRuntime::PercentClipStretchParameters &&other)

    Move operator from other PercentClipStretchParameters.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.