Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.raster

Class ImageServiceRaster

java.lang.Object
com.esri.arcgisruntime.raster.Raster
com.esri.arcgisruntime.raster.ImageServiceRaster
All Implemented Interfaces:
RemoteResource, Loadable
public final class ImageServiceRaster extends Raster implements RemoteResource
Raster data that is retrieved from an ArcGIS image service.

An ArcGIS image service provides access to raster data through a web service. A single raster dataset or a mosaic dataset which contains a collection of raster datasets can be served as one image service. The mosaic dataset can dynamically process and mosaic the images on the fly. An image service supports accessing both the mosaicked image and its catalog, as well as individual rasters in the catalog. An ImageServiceRaster can be used to display raster data from image services using a RasterLayer. Service-defined or client-defined rendering rules can be applied to it through setRenderingRule(RenderingRule). An ImageServiceRaster can be passed as a raster input to a RasterFunction to work with local raster functions.

ImageServiceRaster provides access to information such as spatial reference, full extent, pixel size, pixel type, etc., on its raster data and the basic information associated with the service itself.

Since:
100.1.0

  • Constructor Details

    • ImageServiceRaster

      public ImageServiceRaster(String url)
      Creates an ImageServiceRaster from a URL.
      Parameters:
      url - URL of the image service raster
      Throws:
      IllegalArgumentException - if url is null or empty
      ArcGISRuntimeException - if the url format is not valid
      Since:
      100.1.0

  • Method Details

    • getMosaicRule

      public MosaicRule getMosaicRule()
      Gets the mosaic rule used for combining a number of input rasters that are often overlapping.
      Returns:
      the mosaic rule used for combining a number of input rasters that are often overlapping, or null if none
      Since:
      100.9.0

    • setMosaicRule

      public void setMosaicRule(MosaicRule mosaicRule)
      Sets the mosaic rule used for combining a number of input rasters that are often overlapping.
      Parameters:
      mosaicRule - the mosaic rule used for combining a number of input rasters that are often overlapping. Can be null.
      Since:
      100.9.0

    • getRenderingRule

      public RenderingRule getRenderingRule()
      Gets the current rendering rule.
      Returns:
      the current rendering rule
      Since:
      100.1.0

    • setRenderingRule

      public void setRenderingRule(RenderingRule renderingRule)
      Sets the rendering rule.

      The image service raster must be in the LoadStatus.NOT_LOADED or LoadStatus.FAILED_TO_LOAD state when calling this method.

      Parameters:
      renderingRule - the rendering rule to set
      Throws:
      IllegalArgumentException - if renderingRule is null
      ArcGISRuntimeException - if the raster is either loaded or loading
      Since:
      100.1.0

    • getServiceInfo

      public ArcGISImageServiceInfo getServiceInfo()
      Gets the metadata for the raster's ArcGIS image service.
      Returns:
      the service info
      Since:
      100.1.0

    • setCredential

      public void setCredential(Credential credential)
      Description copied from interface: RemoteResource
      Sets a Credential to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.

      Only applicable if the resource is secured.

      Specified by:
      setCredential in interface RemoteResource
      Parameters:
      credential - the Credential to be used for authentication

    • getCredential

      public Credential getCredential()
      Description copied from interface: RemoteResource
      Gets the Credential that is set on the network-enabled resource.

      Only applicable if the resource is secured.

      Specified by:
      getCredential in interface RemoteResource
      Returns:
      the Credential, or null if there is none

    • setRequestConfiguration

      public void setRequestConfiguration(RequestConfiguration requestConfiguration)
      Description copied from interface: RemoteResource
      Sets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource. If not set, the global RequestConfiguration will be used (see RequestConfiguration.getGlobalRequestConfiguration()).
      Specified by:
      setRequestConfiguration in interface RemoteResource
      Parameters:
      requestConfiguration - the RequestConfiguration used to modify network requests

    • getRequestConfiguration

      public RequestConfiguration getRequestConfiguration()
      Description copied from interface: RemoteResource
      Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
      Specified by:
      getRequestConfiguration in interface RemoteResource
      Returns:
      the RequestConfiguration used to modify network requests

    • getUri

      public String getUri()
      Gets the raster's URL on an image service raster object.
      Specified by:
      getUri in interface RemoteResource
      Returns:
      the URL used to create this raster
      Since:
      100.1.0