public class

ImageServiceParameters

extends Object
implements Serializable
java.lang.Object
   ↳ com.esri.core.map.ImageServiceParameters

Class Overview

Represents the image service parameter options used in an ArcGISImageServiceLayer.

Summary

Nested Classes
enum ImageServiceParameters.IMAGE_FORMAT The format of the exported image. 
enum ImageServiceParameters.NoDataInterpretation Interpretation of the noData setting (see getNoData()). 
enum ImageServiceParameters.PIXEL_TYPE The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. 
enum ImageServiceParameters.RSP The resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space. 
Public Constructors
ImageServiceParameters()
Instantiates an ImageServiceParameters object.
ImageServiceParameters(ImageServiceParameters params)
Copies the properties from the given ImageServiceParameter to the current instance.
Public Methods
boolean equals(Object obj)
int[] getBandIds()
Gets the band IDs of the ImageServiceParameters.
int getCompressionQuality()
Gets the compressionQuality of the ImageServiceParameters.
ImageServiceParameters.IMAGE_FORMAT getFormat()
Gets the format of the exported image.
ImageServiceParameters.RSP getInterpolation()
Gets the interpolation of the ImageServiceParameters.
MosaicRule getMosaicRule()
Gets the mosaicRule of the ImageServiceParameters.
String getNoData()
Gets the pixel value representing no information.
ImageServiceParameters.NoDataInterpretation getNoDataInterpretation()
Gets the interpretation of the noData setting (see getNoData()).
ImageServiceParameters.PIXEL_TYPE getPixelType()
Gets the pixelType of the ImageServiceParameters.
RasterFunction getRenderingRule()
Gets the renderingRule of the ImageServiceParameters.
int hashCode()
void setBandIds(int[] bandIds)
Sets the band IDs of the ImageServiceParameters.
void setCompressionQuality(int compressionQuality)
Sets the compressionQuality of the ImageServiceParameters.
void setFormat(ImageServiceParameters.IMAGE_FORMAT format)
Sets the format of the exported image.
void setInterpolation(ImageServiceParameters.RSP interpolation)
Sets the interpolation of the ImageServiceParameters.
void setMosaicRule(MosaicRule mosaicRule)
Sets the mosaicRule of the ImageServiceParameters.
void setNoData(String noData)
Sets the pixel value representing no information.
void setNoDataInterpretation(ImageServiceParameters.NoDataInterpretation noDataInterpretation)
Sets the interpretation of the noData setting (see getNoData()).
void setPixelType(ImageServiceParameters.PIXEL_TYPE pixelType)
Sets the pixelType of the ImageServiceParameters.
void setRenderingRule(RasterFunction renderingRule)
Sets the renderingRule of the ImageServiceParameters.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ImageServiceParameters ()

Instantiates an ImageServiceParameters object.

public ImageServiceParameters (ImageServiceParameters params)

Copies the properties from the given ImageServiceParameter to the current instance.

Parameters
params ImageServiceParameters: the ImageServiceParameter to copy from.

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public int[] getBandIds ()

Gets the band IDs of the ImageServiceParameters. If there are multiple bands, you can specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number. Band number is 0 based. Example: setBandIds(new int[]{2,1,0});

Returns
int[] Returns the band IDs.

public int getCompressionQuality ()

Gets the compressionQuality of the ImageServiceParameters. It controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100. Example: setCompressionQuality(75);

Returns
int Returns the compressionQuality.

public ImageServiceParameters.IMAGE_FORMAT getFormat ()

Gets the format of the exported image. The default format is jpgpng.

Returns
ImageServiceParameters.IMAGE_FORMAT Returns the format.

public ImageServiceParameters.RSP getInterpolation ()

Gets the interpolation of the ImageServiceParameters. It is the resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.

Returns
ImageServiceParameters.RSP Returns the interpolation.

public MosaicRule getMosaicRule ()

Gets the mosaicRule of the ImageServiceParameters. It specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. When mosaic rule is not specified, mosaic rule will default to esriMosaicNone.

Returns
MosaicRule Returns the mosaicRule.

public String getNoData ()

Gets the pixel value representing no information. Example: setNoData(0);

Returns
String Returns the noData.

public ImageServiceParameters.NoDataInterpretation getNoDataInterpretation ()

Gets the interpretation of the noData setting (see getNoData()).

Returns
ImageServiceParameters.NoDataInterpretation a NoDataInterpretation value.

public ImageServiceParameters.PIXEL_TYPE getPixelType ()

Gets the pixelType of the ImageServiceParameters. The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals.

Returns
ImageServiceParameters.PIXEL_TYPE Returns the pixelType.

public RasterFunction getRenderingRule ()

Gets the renderingRule of the ImageServiceParameters. It specifies the rendering rule for how the requested image should be rendered.

Returns
RasterFunction Returns the renderingRule.

public int hashCode ()

Returns
int

public void setBandIds (int[] bandIds)

Sets the band IDs of the ImageServiceParameters. If there are multiple bands, you can specify a single band to export, or you can change the band combination (red, green, blue) by specifying the band number. Band number is 0 based. Example: setBandIds(new int[]{2,1,0});

Parameters
bandIds int: The band IDs to set.

public void setCompressionQuality (int compressionQuality)

Sets the compressionQuality of the ImageServiceParameters. It controls how much loss the image will be subjected to by the compression algorithm. Valid value ranges of compression quality are from 0 to 100. Example: setCompressionQuality(75);

Parameters
compressionQuality int: The compressionQuality to set.

public void setFormat (ImageServiceParameters.IMAGE_FORMAT format)

Sets the format of the exported image. The default format is jpgpng.

Parameters
format ImageServiceParameters.IMAGE_FORMAT: The format to set.

public void setInterpolation (ImageServiceParameters.RSP interpolation)

Sets the interpolation of the ImageServiceParameters. It is the resampling process of extrapolating the pixel values while transforming the raster dataset when it undergoes warping or when it changes coordinate space.

Parameters
interpolation ImageServiceParameters.RSP: The interpolation to set.

public void setMosaicRule (MosaicRule mosaicRule)

Sets the mosaicRule of the ImageServiceParameters. It specifies the mosaic rule when defining how individual images should be mosaicked. It specifies selection, mosaic method, sort order, overlapping pixel resolution, etc. When mosaic rule is not specified, mosaic rule will default to esriMosaicNone.

Parameters
mosaicRule MosaicRule: The mosaicRule to set.

public void setNoData (String noData)

Sets the pixel value representing no information. Example: setNoData(0);

Parameters
noData String: The noData to set.

public void setNoDataInterpretation (ImageServiceParameters.NoDataInterpretation noDataInterpretation)

Sets the interpretation of the noData setting (see getNoData()).

Parameters
noDataInterpretation ImageServiceParameters.NoDataInterpretation: the interpretation of the noData setting.

public void setPixelType (ImageServiceParameters.PIXEL_TYPE pixelType)

Sets the pixelType of the ImageServiceParameters. The pixel type, also known as data type, pertains to the type of values stored in the raster, such as signed integer, unsigned integer, or floating point. Integers are whole numbers, whereas floating points have decimals.

Parameters
pixelType ImageServiceParameters.PIXEL_TYPE: The pixelType to set.

public void setRenderingRule (RasterFunction renderingRule)

Sets the renderingRule of the ImageServiceParameters. It specifies the rendering rule for how the requested image should be rendered.

Parameters
renderingRule RasterFunction: The renderingRule to set.

public String toString ()

Returns
String