• StretchRenderer
  • class Esri::ArcGISRuntime::StretchRenderer

    A stretch renderer enhances the visual contrast of raster data in a RasterLayer. More...

    Header: #include <StretchRenderer.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::BaseStretchRenderer

    Public Functions

    StretchRenderer(const Esri::ArcGISRuntime::StretchParameters &stretchParameters, const QList<double> &gammas, bool estimateStats, Esri::ArcGISRuntime::ColorRamp *colorRamp, QObject *parent = nullptr)
    StretchRenderer(const Esri::ArcGISRuntime::StretchParameters &stretchParameters, const QList<double> &gammas, bool estimateStats, Esri::ArcGISRuntime::PresetColorRampType presetColorRampType, QObject *parent = nullptr)
    virtual ~StretchRenderer() override
    Esri::ArcGISRuntime::ColorRamp *colorRamp() const

    Detailed Description

    A stretch renderer displays continuous raster cell values across a gradual ramp of colors. Use it to draw a single band of continuous data. The stretch renderer works well when you have a large range of values to display, such as in imagery, aerial photographs, or elevation models.

    Stretching improves the appearance of the raster data by spreading its pixel values along a histogram whose minimum and maximum values are defined by the raster's bit depth. For example, an 8-bit raster dataset will be stretched along a histogram from 0 to 255.

    Relevant samples:

    • Apply map algebra: Apply map algebra to an elevation raster to floor, mask, and categorize the elevation values into discrete integer-based categories.
    • Stretch renderer: Use a stretch renderer to enhance the visual contrast of raster data for analysis.

    See also RasterRenderer.

    Member Function Documentation

    StretchRenderer::StretchRenderer(const Esri::ArcGISRuntime::StretchParameters &stretchParameters, const QList<double> &gammas, bool estimateStats, Esri::ArcGISRuntime::ColorRamp *colorRamp, QObject *parent = nullptr)

    Creates a stretch renderer.

    • stretchParameters - The stretch parameters handle.
    • gammas - Gamma adjustment. A QList of double. Can be empty.
    • estimateStats - Whether to estimate statistics if it does not exist.
    • colorRamp - The color ramp object, can be nullptr.
    • parent - The optional parent QObject.

    StretchRenderer::StretchRenderer(const Esri::ArcGISRuntime::StretchParameters &stretchParameters, const QList<double> &gammas, bool estimateStats, Esri::ArcGISRuntime::PresetColorRampType presetColorRampType, QObject *parent = nullptr)

    Creates a stretch renderer.

    • stretchParameters - The stretch parameters handle.
    • gammas - Gamma adjustment. A QList of double. Can be empty.
    • estimateStats - Whether to estimate statistics if it does not exist.
    • presetColorRampType - The type of color ramp.
    • parent - The optional parent QObject.

    [override virtual noexcept] StretchRenderer::~StretchRenderer()

    Destructor.

    Esri::ArcGISRuntime::ColorRamp *StretchRenderer::colorRamp() const

    The ColorRamp object used to create this StretchRenderer.