Skip to content
  • Raster
  • class Esri::ArcGISRuntime::Raster

    Represents raster data that can be rendered using a RasterLayer. More...

    Public Functions

    Raster(Esri::ArcGISRuntime::RasterFunction *rasterFunction, QObject *parent = nullptr)
    Raster(const QString &path, QObject *parent = nullptr)
    virtual ~Raster() override
    QString path() const
    Esri::ArcGISRuntime::RasterFunction *rasterFunction() const
    (since Esri::ArcGISRuntime 300.0) Esri::ArcGISRuntime::RasterInfo *rasterInfo() const
    Esri::ArcGISRuntime::RasterType rasterType() const

    Reimplemented Public Functions

    virtual void cancelLoad() override
    virtual void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual void retryLoad() override

    Signals

    void doneLoading(const Esri::ArcGISRuntime::Error &loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    A raster consists of a matrix of cells (or pixels) organized into rows and columns (or a grid) where each cell contains a value representing information, such as temperature. Rasters are digital aerial photographs, imagery from satellites, digital pictures, or even scanned maps.

    A Raster can be created from a raster file on the device or from a RasterFunction.

    Supported Raster formats include:

    • ASRP/USRP
    • CRF
    • DTED (levels: 0, 1, 2)
    • GeoTIFF
    • HFA
    • HRE
    • IMG
    • JPEG
    • JPEG 2000
    • MrSID (generations 2, 3, and 4)
    • NITF
    • PNG
    • PDF
    • RPF (CIB)
    • RPF (CADRG)
    • SRTM (versions: 1, 2)
    • Mobile mosaic datasets

    Learn more about rasters from the ArcGIS Pro documentation.

    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.
    • Blend raster layer: Blend a hillshade with a raster by specifying the elevation data. The resulting raster looks similar to the original raster, but with some terrain shading, giving it a textured look.
    • Colormap renderer: Apply a colormap renderer to a raster.
    • Hillshade renderer: Apply a hillshade renderer to a raster.
    • Raster function (file): Apply a raster function to a local raster file and display the output with a raster layer.
    • Raster function (service): Load a raster from a service, then apply a function to it.
    • Raster layer (file): Create and use a raster layer made from a local raster file.
    • RGB renderer: Apply an RGB renderer to a raster layer to enhance feature visibility.
    • Stretch renderer: Use a stretch renderer to enhance the visual contrast of raster data for analysis.

    See also RasterLayer.

    Member Function Documentation

    [explicit] Raster::Raster(Esri::ArcGISRuntime::RasterFunction *rasterFunction, QObject *parent = nullptr)

    Constructor that takes a rasterFunction and an optional parent.

    [explicit] Raster::Raster(const QString &path, QObject *parent = nullptr)

    Constructor that takes a path to a local raster file and an optional parent.

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

    Destructor.

    [override virtual] void Raster::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    See Loadable.

    [signal] void Raster::doneLoading(const Esri::ArcGISRuntime::Error &loadError)

    Signal emitted when this object is done loading.

    • loadError - Details about any error that may have occurred.

    Note: If there is a load error it will also be emitted on the errorOccurred signal.

    See also Loadable and Object.

    [override virtual] void Raster::load()

    Reimplements: Loadable::load().

    See Loadable.

    [override virtual] Esri::ArcGISRuntime::Error Raster::loadError() const

    Reimplements: Loadable::loadError() const.

    See Loadable.

    [override virtual] Esri::ArcGISRuntime::LoadStatus Raster::loadStatus() const

    Reimplements: Loadable::loadStatus() const.

    See Loadable.

    [signal] void Raster::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the loadStatus changes for this object.

    See also Loadable.

    QString Raster::path() const

    Returns the path to the raster file.

    Esri::ArcGISRuntime::RasterFunction *Raster::rasterFunction() const

    Returns the raster function used to create this raster.

    [since Esri::ArcGISRuntime 300.0] Esri::ArcGISRuntime::RasterInfo *Raster::rasterInfo() const

    Returns metadata that describes the raster.

    This property is nullptr by default and is populated when the raster loads.

    Raster info is not available for rasters of type MosaicDatasetRaster, GeoPackageRaster, ImageServiceRaster, or for rasters created from a RasterFunction.

    This function was introduced in Esri::ArcGISRuntime 300.0.

    Esri::ArcGISRuntime::RasterType Raster::rasterType() const

    Returns the raster type.

    [override virtual] void Raster::retryLoad()

    Reimplements: Loadable::retryLoad().

    See Loadable.

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