Package com.esri.arcgisruntime.raster

Enum MosaicMethod

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<MosaicMethod>
    public enum MosaicMethod
extends java.lang.Enum<MosaicMethod>
    Enumerates mosaic method types. The mosaic method is used to determine how multiple rasters in a MosaicDatasetRaster will be sorted.

    An ImageServiceRaster may not support every mosaic method. Check the service's metadata for "Allowed Mosaic Methods" to see which methods are supported. Mosaic methods that are "view-dependent" order rasters based off where the camera is located, whereas "view-independent" mosaic methods order rasters the same regardless of where the camera is located. For more information, see Mosaic operators.

    Since:
    100.9.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ATTRIBUTE
      Orders rasters based on the absolute distance between their values of an attribute and a base value.
      CENTER
      Orders rasters based on the distance between each raster's center and the view center.
      LOCK_RASTER
      LockRasDisplays only the selected rasters specified in MosaicRule.getLockRasterIds().
      NADIR
      Orders rasters based on the distance between each raster's nadir position and view center.
      NONE
      Orders rasters based on the order (ObjectID) in the mosaic dataset attribute table.
      NORTHWEST
      Orders rasters based on the distance between each raster's center and the northwest point of the service.
      SEAMLINE
      Orders rasters based on the predefined seamline.
      VIEWPOINT
      Orders rasters based on the distance between each raster's center and a user defined view point.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static MosaicMethod valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static MosaicMethod[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NONE

        public static final MosaicMethod NONE
        Orders rasters based on the order (ObjectID) in the mosaic dataset attribute table. Mosaic results are view-independent.
        Since:
        100.9.0

      • CENTER

        public static final MosaicMethod CENTER
        Orders rasters based on the distance between each raster's center and the view center. Mosaic results are view-dependent.
        Since:
        100.9.0

      • NORTHWEST

        public static final MosaicMethod NORTHWEST
        Orders rasters based on the distance between each raster's center and the northwest point of the service. Mosaic results are view-independent.
        Since:
        100.9.0

      • NADIR

        public static final MosaicMethod NADIR
        Orders rasters based on the distance between each raster's nadir position and view center. Mosaic results are view-dependent. Nadir is defined as the point on the ground vertically beneath the perspective center of the camera lens that captured the image.
        Since:
        100.9.0

      • VIEWPOINT

        public static final MosaicMethod VIEWPOINT
        Orders rasters based on the distance between each raster's center and a user defined view point. Mosaic results are view-independent.
        Since:
        100.9.0

      • ATTRIBUTE

        public static final MosaicMethod ATTRIBUTE
        Orders rasters based on the absolute distance between their values of an attribute and a base value. Only numeric or date fields are applicable. The attribute is specified by MosaicRule.setSortField(String) and the value is specified by MosaicRule.setSortValue(String). Mosaic results are view-independent.
        Since:
        100.9.0

      • SEAMLINE

        public static final MosaicMethod SEAMLINE
        Orders rasters based on the predefined seamline. The MosaicRule.isAscending() property is defined by the seamline so is not applicable anymore. Only two mosaic operations are applicable as listed below. Mosaic results are view-independent. See also Mosaic dataset seamlines.
        Since:
        100.9.0

    • Method Detail

      • values

        public static MosaicMethod[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (MosaicMethod c : MosaicMethod.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MosaicMethod valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null