ArcGIS Runtime SDK for iOS: AGSRaster Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSRaster Class Reference

Description

A raster dataset.

An instance of this class represents a raster dataset. Raster data can be displayed on screen in a 2D map or a 3D scene using an AGSRasterLayer.

In its simplest form, 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.

Learn more about rasters

The following raster data formats are supported -

  • ASRP/USRP (Arc Standard Raster Product/ UTM Standard Raster Product)
  • CIB (Controlled Image Base)
  • CADRG/ECRG (Compressed ARC Digitized Raster Graphics/Enhanced Compressed ARC Digitized Raster Graphics)
  • DTED (Digital Terrain Elevation Data)
  • GeoPackage Raster
  • GeoTIFF/TIFF
  • HFA (Erdas Imagine)
  • HRE (High Resolution Elevation)
  • IMG (Erdas Imagine)
  • JPEG
  • JPEG2000
  • Mosaic Dataset in SQLite
  • NITF (National Imagery Transmission Format)
  • PNG
  • RPF (Raster Product Format)
  • SRTM (HGT) (Shuttle Radar Topography Mission)
  • CRF (Cloud Raster Format)
  • MrSID (Multiresolution seamless image database) - support added at version 100.4

Learn more about raster data formats

See also
AGSRasterLayer to display rasters in a map or a scene
License Restrictions:
This feature requires a Standard license for production deployment. No license required in Developer mode for testing.
Since
100
Inheritance diagram for AGSRaster:
AGSLoadableBase AGSObject <AGSLoadable> AGSGeoPackageRaster AGSImageServiceRaster AGSMosaicDatasetRaster

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(instancetype) - initWithFileURL:
 
(instancetype) - initWithName:extension:
 
(instancetype) - initWithRasterFunction:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + rasterWithFileURL:
 
(instancetype) + rasterWithName:extension:
 
(instancetype) + rasterWithRasterFunction:
 

Properties

NSURL * fileURL
 
AGSRasterFunctionfunction
 
NSError * loadError
 
AGSLoadStatus loadStatus
 

Method Documentation

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

Property Documentation

◆ fileURL

- (NSURL*) fileURL
readnonatomicstrong

File URL to the local raster dataset on disk

Since
100

◆ function

- (AGSRasterFunction*) function
readnonatomicstrong

A function to transform the raster

Since
100

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100