AGSMosaicRule Class Reference
Description
Specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. Mosaic rules are for mosaicking rasters in the mosaic dataset. A mosaic rule is used to define:
- The selection of rasters that will participate in the mosaic (using the where clause).
- The mosaic method, e.g. how the selected rasters are ordered.
- The mosaic operation, e.g. how overlapping pixels at the same location are resolved.
- Defined in:
- AGSMosaicRule.h ( ArcGIS library)
- Since:
- 1.8
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
Properties | |
| BOOL | ascending |
| NSArray * | lockRasterIds |
| AGSMosaicMethod | method |
| NSArray * | objectIds |
| AGSMosaicOperationType | operation |
| NSString * | sortField |
| NSString * | sortValue |
| AGSPoint * | viewpoint |
| NSString * | where |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
Property Documentation
- (BOOL) ascending [read, write, assign] |
Indicates whether the sort should be ascending or not.
- Since:
- 1.8
- (NSArray*) lockRasterIds [read, write, retain] |
An array of raster Ids. All the rasters with the given list of raster Ids are selected to participate in the mosaic. The rasters will be visible at all pixel sizes regardless of the minimum and maximum pixel size range of the locked rasters.
- Since:
- 1.8
- (AGSMosaicMethod) method [read, write, assign] |
The mosaic method determines how the selected rasters are ordered. See AGSMosaicMethod for a list of valid values.
- Since:
- 1.8
- (NSArray*) objectIds [read, write, retain] |
Defines a selection using a set of ObjectIds. This property applies to all mosaic methods.
- Since:
- 1.8
- (AGSMosaicOperationType) operation [read, write, assign] |
Defines the mosaic operation used to resolve overlapping pixels. See AGSMosaicOperationType for a list of valid values.
- Since:
- 1.8
- (NSString*) sortField [read, write, retain] |
The name of the attribute field that is used together with a constant sortValue to define the mosaicking order when the mosaic method is set to AGSMosaicMethodAttribute.
- Since:
- 1.8
- (NSString*) sortValue [read, write, retain] |
A constant value defining a reference or base value for the sort field when the mosaic method is set to AGSMosaicMethodAttribute.
- Since:
- 1.8
- (AGSPoint*) viewpoint [read, write, retain] |
Defines the viewpoint location on which the ordering is defined based on the distance from the viewpoint and the nadir of rasters.
- Since:
- 1.8
- (NSString*) where [read, write, retain] |
The where clause determines which rasters will participate in the mosaic. This property applies to all mosaic methods.
- Since:
- 1.8