public class

RasterFunction

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

Class Overview

Specifies the processing to be done to the image service. There are different kinds of Raster Functions. Here is an example of how to construct the Shaded Relief rendering rule.

Java usage:


 	String argument = " {\"Azimuth\" : 215.0,\"Altitude\" : 60.0,\"ZFactor\" : 5,\"Colormap\" : [[0, 1, 2, 3],  [2, 45, 52, 13]]}";					
	RasterFunction renderingRule = new RasterFunction();				
	renderingRule.setFunctionName("ShadedRelief");
	renderingRule.setArguments(argument);
	renderingRule.setVariableName("Raster");
	imageServiceLayer.setRenderingRule(renderingRule);
	imageServiceLayer.refresh();

Summary

Public Constructors
RasterFunction()
Instantiates an object of RasterFunction.
RasterFunction(RasterFunction params)
Copies the properties from the given RasterFunction to the current instance.
Public Methods
boolean equals(Object obj)
static RasterFunction fromJson(JsonParser parser)
Creates a RasterFunction object from json.
String getArguments()
Gets the input arguments to the raster function.
Map<String, Object> getArgumentsAsMap()
Gets the input arguments to the raster function.
String getFunctionName()
Gets the functionName of the RasterFunction.
String getVariableName()
Gets the variableName of the RasterFunction.
int hashCode()
void setArguments(String arguments)
Sets the input arguments to the raster function.
void setArgumentsAsMap(Map<String, Object> mapArguments)
Sets the input arguments to the raster function.
void setFunctionName(String functionName)
Sets the functionName of the RasterFunction.
void setVariableName(String variableName)
Sets the variableName of the RasterFunction.
String toJson()
Converts the instance to a Json string.
String toString()
Returns a string containing function name, arguments and variable name.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RasterFunction ()

Instantiates an object of RasterFunction.

public RasterFunction (RasterFunction params)

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

Parameters
params RasterFunction: the RasterFunction to copy from.

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public static RasterFunction fromJson (JsonParser parser)

Creates a RasterFunction object from json.

Parameters
parser JsonParser: contains the JSON to parse
Returns
RasterFunction a RasterFunction object
Throws
IOException
JsonParseException
JsonParseException
IOException

public String getArguments ()

Gets the input arguments to the raster function. For example, clipping geometry for the ClipFunction. The arguments is a Json string representing the argument object.

Returns
String Returns the arguments as a Json string representing the argument object.

public Map<String, Object> getArgumentsAsMap ()

Gets the input arguments to the raster function. For example, clipping geometry for the ClipFunction. T

Returns
Map<String, Object> Returns the arguments as a Json string representing the argument object.

public String getFunctionName ()

Gets the functionName of the RasterFunction.

Returns
String Returns the functionName.

public String getVariableName ()

Gets the variableName of the RasterFunction.

Returns
String Returns the variableName.

public int hashCode ()

Returns
int

public void setArguments (String arguments)

Sets the input arguments to the raster function. For example, clipping geometry for the ClipFunction.

Parameters
arguments String: The arguments to set, which is a Json string representing the argument object.

public void setArgumentsAsMap (Map<String, Object> mapArguments)

Sets the input arguments to the raster function. For example, clipping geometry for the ClipFunction.

Parameters
mapArguments Map: The arguments to set, which is a Json string representing the argument object.

public void setFunctionName (String functionName)

Sets the functionName of the RasterFunction.

Parameters
functionName String: The functionName to set.

public void setVariableName (String variableName)

Sets the variableName of the RasterFunction.

Parameters
variableName String: The variableName to set.

public String toJson ()

Converts the instance to a Json string.

Returns
String the Json string.
Throws
JsonGenerationException
IOException

public String toString ()

Returns a string containing function name, arguments and variable name.

Returns
String